Skip to content
This repository was archived by the owner on Nov 29, 2023. It is now read-only.

Commit 838b12b

Browse files
committed
api-reference_tags_v2 - second fix from PR's comment.
1 parent d931cdd commit 838b12b

File tree

1 file changed

+17
-17
lines changed

1 file changed

+17
-17
lines changed

site/specs-temp/numbers.json

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1701,7 +1701,7 @@
17011701
"/accounts/{accountId}/bulkPortins": {
17021702
"get": {
17031703
"tags": [
1704-
"Bulk Port-in"
1704+
"Bulk Port-In"
17051705
],
17061706
"description": "Retrieves bulk port-in orders for the specified accountId.\nA maximum of 1,000 orders can be retrieved per request. If no date range or specific query parameter is provided, the order results will be limited to the last two years. Please visit <a href='/docs/numbers/guides/bulkportins'>Guides and Tutorials</a>",
17071707
"operationId": "ListBulkPortins",
@@ -1822,7 +1822,7 @@
18221822
},
18231823
"post": {
18241824
"tags": [
1825-
"Bulk port-in"
1825+
"Bulk Port-In"
18261826
],
18271827
"description": "<p>Creates a bulk port-in order to be used as a template for a collection of child port-in orders. The template values will be cascaded to child port-ins that result from decomposing a collection of Telephone Numbers that span carriers, RespOrgs, or have attributes that drive the decomposition into a number of individual port-in orders.<p></p> Upon a successfully-submitted payload, the order will have a status of \"DRAFT\", denoting that further modification to the template is expected. For example, the next step is to use the /tnList endpoint to add a collection of telephone numbers to the bulk port-in order. The only valid value for the ProcessingStatus element in a POST is 'DRAFT', which is the default value.</p><p>Please visit <a href='/docs/numbers/guides/bulkportins'>Guides and Tutorials</a></p>",
18281828
"operationId": "CreateBulkOrder",
@@ -1883,7 +1883,7 @@
18831883
"/accounts/{accountId}/bulkPortins/{orderid}": {
18841884
"get": {
18851885
"tags": [
1886-
"Bulk port-in"
1886+
"Bulk Port-In"
18871887
],
18881888
"description": "Retrieves information associated with the bulk port-in order specified by the orderId URI parameter. Please visit <a href='/docs/numbers/guides/bulkportins'>Guides and Tutorials</a>",
18891889
"operationId": "RetrieveBulkOrder",
@@ -1926,7 +1926,7 @@
19261926
},
19271927
"put": {
19281928
"tags": [
1929-
"Bulk port-in"
1929+
"Bulk Port-In"
19301930
],
19311931
"description": "The PUT operation is available only for bulk port-in orders that are not yet associated with subtending orders. Since this only occurs for bulk port-in orders that are in one of the draft states, there are few restrictions on what may be included. As with the POST, any data associated with the bulk port-in will cascade to subtending orders when they are created. (Subtending orders are created after telephone numbers are added to the bulk port-in using the /tnList endpoint.) The PUT completely replaces the existing Bulk Portin order with the payload of the PUT. Please visit <a href='/docs/numbers/guides/bulkportins'>Guides and Tutorials</a>.<br/><br/>The following element may appear only in PUT or PATCH operations on a bulk port-in order. <ul><li><b>RetryValidation</b> - When toll free numbers are included in a port-in order, Bandwidth accesses a vendor to determine if the numbers are portable, and if so, from which RespOrg. In the event that we do not receive a response from our vendor after a number of retries, we give up and place the order in the INVALID_DRAFT_TNS state. This scenario can occur if our toll free porting vendor is performing maintenance, for example. Including RetryValidation with a value of true will cause the order to return to VALIDATE_DRAFT_TNS and we will repeat our attempts to retrieve the portability data from the vendor. This element is included in the synchronous response to the PUT or PATCH, when included in the request, but is not included in subsequent GET requests for the order.</li></ul>",
19321932
"operationId": "PutBulkOrder",
@@ -1994,7 +1994,7 @@
19941994
},
19951995
"delete": {
19961996
"tags": [
1997-
"Bulk port-in"
1997+
"Bulk Port-In"
19981998
],
19991999
"description": "Delete a bulk port-in order with child port-ins. Deleting a bulk port-in is allowed for 'DRAFT' state only. Deleting a bulk port-in will delete all DRAFT child port-ins associated with the bulk port-in. When the bulk port-in is deleted, any child port-in orders that are not in a draft status are dissociated from the bulk port-in, but not deleted. Please visit <a href='/docs/numbers/guides/bulkportins'>Guides and Tutorials</a>",
20002000
"operationId": "DeleteBulkOrder",
@@ -2037,7 +2037,7 @@
20372037
},
20382038
"patch": {
20392039
"tags": [
2040-
"Bulk port-in"
2040+
"Bulk Port-In"
20412041
],
20422042
"description": "<p>It is possible to change (\"SUPP\" in LNP terms) an existing Bulk Port-in order. This is done via a PUT or PATCH on the existing order-id. Since the Bulk Port-in\n order acts as a template for port-in orders in DRAFT status, any record can be changed at any time. The PATCH replaces elements of the referenced Bulk Portin order, but it replaces only the records included in the request payload. Other elements will remain untouched.</p><p>Changing the fields in a Bulk Port-in order causes the system to reapply all changed values to the child port-ins contained in the list of subtending port-in orders. Note that if the port-in orders contained within the Bulk Port are in DRAFT state, any field can be modified. If any child port-in order in the Bulk Port-in is in any other state, normal SUPP rules apply, and the list of appropriate fields is smaller.</p><p>Changing the ProcessingStatus to 'IN_PROGRESS' causes all child port-ins to begin processing. This is only valid if child port-ins exist for the bulk port-in.</p> <p>Please visit <a href='/docs/numbers/guides/bulkportins'>Guides and Tutorials</a></p>",
20432043
"operationId": "PatchBulkOrder",
@@ -2112,7 +2112,7 @@
21122112
"/accounts/{accountId}/bulkPortins/{orderid}/portinList": {
21132113
"get": {
21142114
"tags": [
2115-
"Bulk port-in"
2115+
"Bulk Port-In"
21162116
],
21172117
"description": "Retrieves a list of Port-in Orders that are all associated with the identified Bulk Port-in. This response is not paginated due to its inherently limited size. Please visit <a href='/docs/numbers/guides/bulkportins'>Guides and Tutorials</a>",
21182118
"operationId": "ListBulkChildOrders",
@@ -2152,7 +2152,7 @@
21522152
},
21532153
"put": {
21542154
"tags": [
2155-
"Bulk port-in"
2155+
"Bulk Port-In"
21562156
],
21572157
"description": "<p>A PUT on a PortinList resource will cause replacement of the list of port-in orders associated with the specified bulk port-in.</p><p>This PUT will completely replace the existing list of port-in orders associated with the bulk port-in. If all port-in orders in the list are not valid, the PUT request will fail, due to the potential for losing the port-in to bulk port-in relationships.</p><p>Only port-in orders in a draft status may be associated with a bulk port-in order. And port-in orders may only be added to a bulk port-in order while that bulk port-in order is still in a draft state.</p><p>Child port-in orders may be dissociated from the bulk port-in at any time. </p> <p>Please visit <a href='/docs/numbers/guides/bulkportins'>Guides and Tutorials</a></p>",
21582158
"operationId": "UpdateBulkChildList",
@@ -2212,7 +2212,7 @@
22122212
"/accounts/{accountId}/bulkPortins/{orderid}/notes": {
22132213
"get": {
22142214
"tags": [
2215-
"Bulk port-in"
2215+
"Bulk Port-In"
22162216
],
22172217
"description": "Retrieve all notes associated with the order. Please visit <a href='/docs/numbers/guides/bulkportins'>Guides and Tutorials</a>",
22182218
"operationId": "ListBulkNotes",
@@ -2255,7 +2255,7 @@
22552255
},
22562256
"post": {
22572257
"tags": [
2258-
"Bulk port-in"
2258+
"Bulk Port-In"
22592259
],
22602260
"description": "Updates the Notes resource by adding a note. Adding a note to a port-in order causes a notification to be sent to Bandwidth Operations, so that they may assist as necessary. A note may be up to 500 characters in length. Please visit <a href='/docs/numbers/guides/bulkportins'>Guides and Tutorials</a>",
22612261
"operationId": "CreateBulkNote",
@@ -2315,7 +2315,7 @@
23152315
"/accounts/{accountId}/bulkPortins/{orderid}/notes/{noteId}": {
23162316
"put": {
23172317
"tags": [
2318-
"Bulk port-in"
2318+
"Bulk Port-In"
23192319
],
23202320
"description": "Update a specified note. Notes may only be updated, not deleted. Please visit <a href='/docs/numbers/guides/bulkportins'>Guides and Tutorials</a>",
23212321
"operationId": "UpdateBulkNote",
@@ -2385,7 +2385,7 @@
23852385
"/accounts/{accountId}/bulkPortins/{orderid}/tnList": {
23862386
"get": {
23872387
"tags": [
2388-
"Bulk port-in"
2388+
"Bulk Port-In"
23892389
],
23902390
"description": "<p>The information returned in the GET /tnList response payload depends on the ProcessingStatus of the bulk port-in order. See the Responses tab for examples of each response payload.</p><table border=\"1\" cellspacing=\"0\" cellpadding=\"0\" width=\"624\">\n <tbody>\n <tr>\n <td valign=\"top\">\n <p>\n <strong>ProcessingStatus</strong>\n </p>\n </td>\n <td valign=\"top\">\n <p>\n <strong>Information Returned</strong>\n </p>\n </td>\n </tr>\n <tr>\n <td valign=\"top\">\n <p>\n DRAFT\n </p>\n </td>\n <td valign=\"top\">\n <p align=\"center\">\n In this state, no tnList has been provided, so the response\n includes empty portable and non-portable telephone number lists.\n </p>\n </td>\n </tr>\n <tr>\n <td valign=\"top\">\n <p>\n VALIDATE_DRAFT_TNS\n </p>\n </td>\n <td valign=\"top\">\n <p align=\"center\">\n In this state, validation of the tnList is still in progress,\n so the response includes all of the tnList telephone numbers\n in a `not validated` list. This is a temporary state until\n the validation completes. Validation takes longer when toll\n free numbers are included in the tnList.\n </p>\n </td>\n </tr>\n <tr>\n <td valign=\"top\">\n <p>\n VALID_DRAFT_TNS\n </p>\n </td>\n <td valign=\"top\">\n <p align=\"center\">\n In this state, all of the telephone numbers in the tnList have\n been determined to be portable. The response payload includes\n a list of the child port-in orders and shows which telephone\n numbers are assigned to each child port-in order.\n </p>\n </td>\n </tr>\n <tr>\n <td valign=\"top\">\n <p>\n INVALID_DRAFT_TNS\n </p>\n </td>\n <td valign=\"top\">\n <p align=\"center\">\n In this state, at least one of the telephone numbers in the tnList\n has been determined to be non-portable. The response payload includes\n a list of portable numbers (if any) and a list of errors showing which\n telephone numbers are non-portable as well as the reasons why they\n cannot be ported. Or, if communication errors prevented us from\n determining telephone number portability, those errors will be included.\n </p>\n </td>\n </tr>\n </tbody>\n </table>\n <p>Please visit <a href='/docs/numbers/guides/bulkportins'>Guides and Tutorials</a></p>",
23912391
"operationId": "ListBulkTns",
@@ -2436,7 +2436,7 @@
24362436
},
24372437
"put": {
24382438
"tags": [
2439-
"Bulk port-in"
2439+
"Bulk Port-In"
24402440
],
24412441
"description": "<p>This operation is used to add telephone numbers to a draft bulk port-in order.\n The telephone numbers may be a mix of toll free and non-toll free. Once the\n telephone numbers are added, they will be checked for portability, and if\n portable, decomposed into individual child port-in orders. Both the bulk\n port-in order and the child port-in orders remain in draft status until you\n explicitly submit them.</p>\n\n<p>After submitting a tnList with the PUT operation, you will need to poll for\n completion of the validation and decomposition using the GET /tnList operation\n or the GET /bulkPortins/orderId operation (both include the order ProcessingStatus).\n The basic ProcessingStatus flow is as follows:</p>\n\n<ul><li>On submission of the tnList, the bulk port-in order transitions from DRAFT\n status to VALIDATE_DRAFT_TNS. The order will remain in this state until validation\n is complete. For a tnList that does not contain any toll free telephone numbers, the\n validation step is very fast. When the tnList does contain toll free telephone\n numbers, the time it takes to validate the toll free numbers is roughly proportional\n to the number of toll free telephone numbers. If you PUT a new tnList while validation\n is in progress for a previous tnList, the validation of the previous tnList will be\n abandoned and replaced by validation of the new tnList.</li>\n <li>If all of the telephone numbers in the tnList are portable, the bulk port-in\n transitions to the VALID_DRAFT_TNS state. At this point, child port-in orders have\n been created in DRAFT status to meet requirements about which telephone numbers can\n be ported together in the same port-in order. The bulk port-in will remain in this\n state until you use the PATCH operation on the bulk port-in order to change the\n ProcessingStatus to IN_PROGRESS. If you PUT an updated tnList, all draft child\n port-in orders are removed, and the validation process begins again with the new\n tnList.</li>\n <li>If at least one of the telephone numbers in the tnList is not portable, the bulk\n port-in transitions to the INVALID_DRAFT_TNS state. When this happens, no child\n port-in orders are created. You can use the GET operation on /tnList to see reasons\n why telephone numbers are non-portable. You’ll need to update the tnList to remove\n non-portable telephone numbers and PUT the tnList again to restart the validation\n step. The goal is to get to the VALID_DRAFT_TNS state, from which you can submit\n the bulk port-in order.</li></ul>\n <p>Please visit <a href='/docs/numbers/guides/bulkportins'>Guides and Tutorials</a></p>",
24422442
"operationId": "UpdateBulkTnList",
@@ -2509,7 +2509,7 @@
25092509
"/accounts/{accountId}/bulkPortins/{orderid}/history": {
25102510
"get": {
25112511
"tags": [
2512-
"Bulk port-in"
2512+
"Bulk Port-In"
25132513
],
25142514
"description": "Retrieves the history of the specified bulk port-in order. Obtaining history for a draft bulk port-in is not supported.</p><p>Please visit <a href='/docs/numbers/guides/bulkportins'>Guides and Tutorials</a></p>",
25152515
"operationId": "GetBulkHistory",
@@ -2570,7 +2570,7 @@
25702570
"/accounts/{accountId}/bulkPortins/{orderid}/loas": {
25712571
"get": {
25722572
"tags": [
2573-
"Bulk port-in"
2573+
"Bulk Port-In"
25742574
],
25752575
"description": "Retrieves the list of the loa (and other) files associated with the order.",
25762576
"operationId": "ListBulkLoas",
@@ -2621,7 +2621,7 @@
26212621
},
26222622
"post": {
26232623
"tags": [
2624-
"Bulk port-in"
2624+
"Bulk Port-In"
26252625
],
26262626
"description": "<p>POSTing to the /loas resource will enable the upload of the file. The key attribute to the POST is ensuring that the headers are correctly set to support the file upload.<br>\nQuery parameter or header documentType can be used to specify type of document on upload. Possible values are: LOA, INVOICE, CSR, OTHER.\n <br>\nHeader settings typical of a valid upload are...<br>\n <br>\n<code>\nHost: dashboard.bandwidth.com <br>\nAuthorization: Basic xxxxxxxxxxxxxxxxxxxx== <br>\nContent-Type: application/pdf <br>\ndocumentType: [LOA | INVOICE | CSR | OTHER] <br>\nAccept: <em>/</em> <br>\nAccept-Encoding: gzip, deflate <br>\nAccept-Language: en-US,en;q=0.8 <br>\nCache-Control: no-cache <br>\n <br>\n----WebKitFormBoundaryE19zNvXGzXaLvS5C <br>\nContent-Disposition: form-data; name=\"george\"; filename=\"Bandwidth Dashboard.pdf\" <br>\nContent-Type: application/pdf <br>\n <br>\n <br>\n----WebKitFormBoundaryE19zNvXGzXaLvS5C <br>\n</code></p>",
26272627
"operationId": "UploadBulkLoa",
@@ -31218,7 +31218,7 @@
3121831218
}
3121931219
},
3122031220
{
31221-
"name": "Bulk port-in",
31221+
"name": "Bulk Port-In",
3122231222
"description": "Manage bulk port-in orders",
3122331223
"externalDocs": {
3122431224
"description": "Bulk port-in guide",

0 commit comments

Comments
 (0)