From 03f98e21af2976ca00fe3a3876d34b23a741e42b Mon Sep 17 00:00:00 2001 From: DX-Bandwidth <42817071+DX-Bandwidth@users.noreply.github.com> Date: Thu, 8 Dec 2022 15:53:49 -0500 Subject: [PATCH] bwdb-14315 (#824) --- site/docs/numbers/errors.mdx | 8 + site/specs/numbers.yml | 1065 +++++++++++++++++++++++----------- 2 files changed, 741 insertions(+), 332 deletions(-) diff --git a/site/docs/numbers/errors.mdx b/site/docs/numbers/errors.mdx index 500303a27..6046d38be 100644 --- a/site/docs/numbers/errors.mdx +++ b/site/docs/numbers/errors.mdx @@ -560,6 +560,14 @@ image: '@site/static/img/bw-icon.svg' | 7524 | Retry Validation can only be performed on orders that are in an invalid telephone numbers state. | | 7525 | Retry Validation can only be performed if the prior attempt to validate telephone numbers resulted in a communication failure with our vendor. | | 7526 | Retry Validation is only valid for orders that have a non-empty list of TNs. | +| 7527 | Target RespOrg IDs must be 5 characters in length. | +| 7528 | Target RespOrg IDs must consist of letters (a-z, A-Z) and digits (0-9). | +| 7529 | The specified Target RespOrg ID is not a Bandwidth RespOrg ID, and your account is not configured for RespOrg Exception. | +| 7530 | The specified Target RespOrg ID is neither a Bandwidth RespOrg ID, nor one of the RespOrg Exception RespOrg IDs configured for your account. | +| 7531 | The specified Target RespOrg ID is not a valid Bandwidth RespOrg ID. | +| 7532 | The TargetRespOrgId is mandatory for toll free port-ins. | +| 7533 | A toll free port-in cannot be submitted without a TargetRespOrgId. | +| 7534 | The TargetRespOrgId cannot be changed for a port-in that has reached the Submitted state. | | 7598 | Invalid Request | | 7599 | Fatal Error in Processing | | 7600 | External telephone number(s) cannot be used: %s | diff --git a/site/specs/numbers.yml b/site/specs/numbers.yml index 6ff323bf9..c91b56b6c 100644 --- a/site/specs/numbers.yml +++ b/site/specs/numbers.yml @@ -824,6 +824,19 @@ components: AssociatedSipPeersResponse: $ref: '#/components/schemas/AssociatedSipPeersResponse' type: object + AutomatedTollFreeLnpOrderRequest: + description: >- + Indicates that the port-in contains toll-free numbers and that Toll-Free + Automation is enabled. The numbers will be automatically validated and + submitted to our toll-free porting vendor, then the port will be + processed manually by Bandwidth’s Local Number Portability team. + properties: + LnpOrder: + allOf: + - $ref: '#/components/schemas/LnpOrderBasic' + - $ref: '#/components/schemas/LnpOrderAutomatedTollFreeFields' + title: Automated Toll-Free + type: object AvailableNpaNxx: properties: City: @@ -4737,14 +4750,6 @@ components: - $ref: '#/components/schemas/LnpOrderBasic' - $ref: '#/components/schemas/LnpOrderAdditionalFields' - properties: - Immediately: - description: >- - Including `Immediately` with a value of `true` will cause an - Internal port-in to complete as soon as possible, without - requiring a scheduled activation - time.

`Immediately` has no meaning for port types - other than Internal. - type: boolean NewBillingTelephoneNumber: description: >- This field is used to specify a new billing telephone number @@ -5126,6 +5131,28 @@ components: type: string Subscriber: $ref: '#/components/schemas/PortinSubscriberSupp' + TnAttributes: + description: Can be SUPPed prior to completion of the port-in request. + items: + $ref: '#/components/schemas/TnAttribute' + type: array + Triggered: + description: May be included in the PUT payload as is, but cannot be changed. + type: boolean + type: object + LnpOrderAutomatedTollFreeFields: + properties: + TargetRespOrgId: + description: >- + This is the RespOrg ID that you want the toll free numbers ported + to. Normally it will specify a Bandwidth RespOrg ID like JYT01, but + it could be something else for RespOrg Exception customers. This + field is mandatory for non-draft toll free port-in orders. + maxLength: 5 + minLength: 5 + type: string + required: + - TargetRespOrgId type: object LnpOrderBasic: properties: @@ -5235,7 +5262,7 @@ components: type: string ProcessingStatus: description: >- - May only be SUPPed for port-in orders in draft state. The only valid + May only be SUPPed for port-in orders in DRAFT state. The only valid value is “SUBMITTED” (not case sensitive). type: string RequestedFocDate: @@ -5246,14 +5273,6 @@ components: SiteId: format: int32 type: integer - TnAttributes: - description: Can be SUPPed prior to completion of the port-in request. - items: - $ref: '#/components/schemas/TnAttribute' - type: array - Triggered: - description: May be included in the PUT payload as is, but cannot be changed. - type: boolean type: object LnpOrderPortoutResponse: properties: @@ -5355,6 +5374,13 @@ components: Description: type: string type: object + TargetRespOrgId: + description: >- + This is the RespOrg ID that you want the toll free numbers + ported to. Normally it will specify a Bandwidth RespOrg ID like + JYT01, but it could be something else for RespOrg Exception + customers. + type: string Triggered: description: >- The Triggered field must be set to true if you want an @@ -5454,6 +5480,96 @@ components: WirelessInfo: $ref: '#/components/schemas/WirelessInfo' type: object + title: LNP Order Response + type: object + LnpOrderResponseAutomatedTollFree: + properties: + LnpOrderResponse: + properties: + Errors: + properties: + Code: + description: Numeric designation of corresponding error. + type: integer + Description: + description: Detailed explanation about error. + type: string + type: object + Internal: + description: >- + This is set to true if the port-in is porting a toll free number + that is already in service on a Bandwidth account. This value is + only applicable to automated toll free port-ins. + type: boolean + ListOfPhoneNumbers: + description: >- + ListOfPhoneNumbers is an array of PhoneNumber. At least one + PhoneNumber must be provided for all port-types. + items: + $ref: '#/components/schemas/PhoneNumber' + type: array + LoaAuthorizingPerson: + description: >- + The LoaAuthorizingPerson is mandatory for all port-types. This + is the first and last names of the person that has authorized + the port. The LoaAuthorizingPerson value may be up to 15 + characters in length. + type: string + OrderId: + description: Unique orderId that is used to manage the order. + type: string + PeerId: + description: >- + The numeric designation for the Location or SIP PEER ID that + applied to the Port-in Order. The SIP Peer ID is used to provide + a home within the location for the TN(s) that were ported in by + the Port-in Order + type: string + ProcessingStatus: + description: >- + The processing status of this order. Values may be: PROCESSING, + COMPLETED, FAILED. PROCESSING means that the system is still + processing the order. COMPLETED means that the order has been + successfully completed. FAILED means that errors occurred while + processing the order, and that the order did not make any + changes to the system. + enum: + - PENDING_DOCUMENTS + type: string + RespOrgException: + description: >- + This is set to true if the port-in is requesting the toll free + numbers to be ported to a RespOrg ID that does not belong to + Bandwidth. This value is only applicable to automated toll free + port-ins. + type: boolean + RocRequired: + description: >- + This is set to true if the port-in is getting ported from one + RespOrg to another, and can be used to tell when a LOA document + will be required for the port-in. This value is only applicable + to automated toll free port-ins. + type: boolean + SiteId: + description: >- + The numeric designation for the Site ID that applied to the + Port-in Order. The SiteId is used to provide a home within the + account for the TN(s) that were ported in by the Port-in Order + type: string + Status: + properties: + Code: + type: integer + Description: + type: string + type: object + TargetRespOrgId: + description: >- + The RespOrg ID that you are porting numbers to. This value is + only applicable to automated toll free port-ins. + type: string + type: object + title: Automated Toll-Free LNP Order Response type: object LnpOrderSuppAutomatedOffNet: allOf: @@ -5500,24 +5616,58 @@ components: $ref: '#/components/schemas/WirelessInfoSupp' title: LnpOrderSupp type: object + LnpOrderSuppAutomatedTollFree: + allOf: + - $ref: '#/components/schemas/LnpOrderBasicModifiableFields' + properties: + ListOfPhoneNumbers: + description: >- + May be SUPPed only in draft states (i.e. DRAFT, VALIDATE_DRAFT_TFNS, + VALID_DRAFT_TFNS, or INVALID_DRAFT_TFNS) + items: + $ref: '#/components/schemas/PhoneNumber' + type: array + LoaAuthorizingPerson: + type: string + RetryValidation: + description: >- + If 'TOLL_FREE_PORT_INS_PHASE_1' feature is enabled for account, + 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_TFNS or + INVALID_DRAFT_TFNS 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_TFNS or VALIDATE_DRAFT_TFNS 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, when + included in the request, but is not included in subsequent GET + requests for the order. + type: boolean + TargetRespOrgId: + description: >- + This is the RespOrg ID that you want the toll free numbers ported + to. Normally it will specify a Bandwidth RespOrg ID like JYT01, but + it could be something else for RespOrg Exception customers. Because + the TargetRespOrgId is mandatory for the toll free port-in order + (but not mandatory for the PUT operation), omitting it in the PUT + leaves the TargetRespOrgId unchanged. This field must be populated + when a draft toll free port-in is submitted. + maxLength: 5 + minLength: 5 + type: string + title: LnpOrderSupp + type: object LnpOrderSuppInternal: allOf: - $ref: '#/components/schemas/LnpOrderBasicModifiableFields' - $ref: '#/components/schemas/LnpOrderAdditionalModifiableFields' properties: - Immediately: - description: May be included in the PUT payload as is, but cannot be changed. - type: boolean LoaAuthorizingPerson: type: string NewBillingTelephoneNumber: type: string - OverrideValidation: - description: >- - This Bandwidth internal flag forces port-out to bypass validity - checking (if there are no terminal errors). This flag can be SUPPed - only for orders in EXCEPTION status. - type: boolean PartialPort: type: string WirelessInfo: @@ -5544,30 +5694,12 @@ components: - $ref: '#/components/schemas/LnpOrderBasicModifiableFields' properties: ListOfPhoneNumbers: - description: >- - May be SUPPed only in draft states (i.e. DRAFT, VALIDATE_DRAFT_TFNS, - VALID_DRAFT_TFNS, or INVALID_DRAFT_TFNS) + description: May be SUPPed only in DRAFT state items: $ref: '#/components/schemas/PhoneNumber' type: array LoaAuthorizingPerson: type: string - RetryValidation: - description: >- - If 'TOLL_FREE_PORT_INS_PHASE_1' feature is enabled for account, - 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_TFNS or - INVALID_DRAFT_TFNS 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_TFNS or VALIDATE_DRAFT_TFNS 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, when - included in the request, but is not included in subsequent GET - requests for the order. - type: boolean Subscriber: properties: BusinessName: @@ -5747,7 +5879,7 @@ components: BillingTelephoneNumber: description: >- The billing telephone number associated with the phone numbers that - are being ported. + are being ported. Non-toll-free. format: Numeric maxLength: 10 type: string @@ -5762,6 +5894,7 @@ components: maxLength: 40 type: string ListOfTelephoneNumbers: + description: Toll-free number not allowed items: $ref: '#/components/schemas/TelephoneNumber' type: array @@ -5769,12 +5902,6 @@ components: items: $ref: '#/components/schemas/LsrOrderError' type: array - OverrideValidation: - description: >- - This Bandwidth internal field is applicable only to Internal orders - that are in Exception state. A value of true bypasses all port-out - validation checking. - type: boolean PartialPort: description: >- The PartialPort must be set to true if the intent is to NOT port all @@ -5803,12 +5930,12 @@ components: RequestedFocDate: description: >- This is the FOC (Firm Order Commitment) date requested when creating - the LSR order. + the LSR order (not past, default next day). type: string SPID: description: >- The NPAC SPID corresponding to the carrier that the phone numbers - are porting to. + are porting to (required if account value 'mult'). maxLength: 4 type: string SiteId: @@ -6043,6 +6170,25 @@ components: TelephoneNumberToPort: type: string type: object + ManualTollFreeLnpOrderRequest: + description: >- + Manual indicates that the port-in will be processed manually by + Bandwidth’s Local Number Portability team. Currently all toll free + port-ins are handled manually by Bandwidth’s Local Number Portability + team. But Bandwidth is in the process of automating portions of toll + free porting, with a goal of eventually automating the entire process. + properties: + LnpOrder: + allOf: + - $ref: '#/components/schemas/LnpOrderBasic' + properties: + Subscriber: + allOf: + - $ref: '#/components/schemas/SubscriberBusiness' + type: object + type: object + title: Manual Toll-Free + type: object ManuallyPortableTollFreeNumberList: properties: DisconnectedTollFreeNumberList: @@ -6650,9 +6796,6 @@ components: AutoActivation: description: '' type: string - BillingType: - description: '' - type: string NewBillingTelephoneNumber: description: >- This field is used to specify a new billing telephone number @@ -7429,29 +7572,6 @@ components: type: array type: object type: object - PortinLosingCarrierInfo: - properties: - AccountNumberRequired: - type: boolean - MinimumPortingInterval: - format: int32 - type: integer - Name: - type: string - Spid: - type: string - Wireless: - type: boolean - title: LosingCarrier - type: object - PortinLosingCarrierResponse: - properties: - PortinLosingCarrierResponse: - properties: - LosingCarrier: - $ref: '#/components/schemas/PortinLosingCarrierInfo' - type: object - type: object PortinOrderId: properties: PortinOrderId: @@ -10760,25 +10880,6 @@ components: type: string type: object type: object - TollFreeLnpOrderRequest: - description: >- - Manual indicates that the port-in will be processed manually by - Bandwidth’s Local Number Portability team. Currently all toll free - port-ins are handled manually by Bandwidth’s Local Number Portability - team. But Bandwidth is in the process of automating portions of toll - free porting, with a goal of eventually automating the entire process. - properties: - LnpOrder: - allOf: - - $ref: '#/components/schemas/LnpOrderBasic' - properties: - Subscriber: - allOf: - - $ref: '#/components/schemas/SubscriberBusiness' - type: object - type: object - title: Toll free - type: object TollFreeNumber: properties: TollFreeNumber: @@ -14543,6 +14644,213 @@ paths: description: Error Response tags: - 10DLC + /accounts/{accountId}/campaignManagement/10dlc/brands/{brandId}: + delete: + description: Delete campaign registry brand + operationId: Delete Brand + parameters: + - $ref: '#/components/parameters/AccountIdPathParam' + - description: Brand id. + example: B5DG4HH + in: path + name: brandId + required: true + schema: + type: string + responses: + '204': + content: + application/xml: {} + description: Successfully deleted + tags: + - 10DLC + get: + description: Retrieve a campaign registry brand for the Account + operationId: Retrieve Brand + parameters: + - $ref: '#/components/parameters/AccountIdPathParam' + - description: Brand id. + example: B5DG4HH + in: path + name: brandId + required: true + schema: + type: string + responses: + '200': + content: + application/xml: + examples: + example: + value: |- + + + + PUBLIC_PROFIT + 111111111 + DUNS + MEDIUM_ACCOUNT + Raleigh + Bandwidth + US + Bandwidth + 123456789 + user@mail.com + +19195551234 + 27616 + NC + 123 street + NASDAQ + BAND + TECHNOLOGY + www.my.website.com + false + + + schema: + $ref: '#/components/schemas/BrandResponse' + description: OK + '400': + content: + application/xml: + examples: + example: + value: |- + + + + 12055 + 'LONG_CODE' feature is not enabled on account 900000 + + + schema: + $ref: '#/components/schemas/BrandErrorResponse' + description: Error Response + tags: + - 10DLC + put: + description: Update campaign registry brand on the Account + operationId: Update brand + parameters: + - $ref: '#/components/parameters/AccountIdPathParam' + - description: Brand id. + example: B5DG4HH + in: path + name: brandId + required: true + schema: + type: string + requestBody: + content: + application/xml: + examples: + Customer Brand: + summary: Customer Brand + value: |- + + + PUBLIC_PROFIT + 111111111 + DUNS + MEDIUM_ACCOUNT + Raleigh + Bandwidth + US + Bandwidth + 123456789 + user@mail.com + +19195551234 + 27616 + NC + 123 street + NASDAQ + BAND + TECHNOLOGY + www.my.website.com + false + + My Brand: + summary: My Brand + value: |- + + + PUBLIC_PROFIT + 111111111 + DUNS + MEDIUM_ACCOUNT + Raleigh + Bandwidth + US + Bandwidth + 123456789 + user@mail.com + +19195551234 + 27616 + NC + 123 street + NASDAQ + BAND + TECHNOLOGY + www.my.website.com + true + + schema: + $ref: '#/components/schemas/BrandRequest' + responses: + '200': + content: + application/xml: + examples: + example: + value: |- + + + + BJDHM3 + CMHSJ9 + PUBLIC_PROFIT + 111111111 + DUNS + MEDIUM_ACCOUNT + Raleigh + Bandwidth + US + Bandwidth + 123456789 + 111111111 + user@mail.com + +19195551234 + 27616 + NC + 123 street + NASDAQ + BAND + TECHNOLOGY + www.my.website.com + true + + + schema: + $ref: '#/components/schemas/BrandResponse' + description: OK + '400': + content: + application/xml: + examples: + example: + value: |- + + + + 1003 + CompanyName is required + + + schema: + $ref: '#/components/schemas/BrandErrorResponse' + description: Error Response + tags: + - 10DLC /accounts/{accountId}/campaignManagement/10dlc/brands/{brandId}/vetting: get: description: Retrieve brand external vetting records @@ -22469,46 +22777,31 @@ paths: value: |- - - ATT-011515-324234 - - FineCustomerid - - 123C - - 9192381468 - - 2015-11-15 - Jim Hopkins - - - BUSINESS - - BusinessName - - - 11 - - Park - - Ave - - New York - - NY - - 90025 - - - 123463 - - 1231 - - - - 9192381468 - 9192381467 - + ATT-011515-324234 + FineCustomerid + 123C + 9192381468 + 2015-11-15 + Jim Hopkins + + BUSINESS + BusinessName + + 11 + Park + Ave + New York + NY + 90025 + + 123463 + 1231 + + + + 9192381468 + 9192381467 + schema: $ref: '#/components/schemas/LsrOrder' @@ -25040,14 +25333,15 @@ paths: content: application/xml: examples: - Simple response: - value: "\n\n\t2016-03-25T21:15:00.000Z\n\tX455\n\t9195551234\n\t9175131245\n\t SITE ID \n\t SIPPEER ID \n\t\n\t\tBUSINESS\n\t\tFirst\n\t\tLast\n\t\t\n\t\t\t11235\n\t\t\tBack\n\t\t\tDenver\n\t\t\tCO\n\t\t\t27541\n\t\t\tCanyon\n\t\t\n\t\n\tThe Authguy\n\t\n\t\t771297665AABC\n\t\t1234\n\t\n\t\n\t\tProtected\n\t\tExternal\n\t\tImported\n\t\n\t\n\t\t9194809871\n\t\n\tmyOrder\n\ttrue\n\ttrue\n\tfalse\n\tDRAFT\n" - Toll Free port-in: - value: "\n\n\tMy order id\n\t2021-06-16Z\n\t2439\n\t23432\n\tThe Authgal\n\t\n\t\t8774809871\n\t\n" + Automated Toll-Free Port-in: + value: "\n\n\tMy order id\n\t2021-06-16Z\n\t2439\n\t23432\n\tThe Authgal\n\tJYT01\n\t\n\t\t8774809871\n\t\n" + Regular Port-in: + value: "\n\n\t2016-03-25T21:15:00.000Z\n\tX455\n\t9195551234\n\t9175131245\n\t SITE ID \n\t SIPPEER ID \n\t\n\t\tBUSINESS\n\t\tFirst\n\t\tLast\n\t\t\n\t\t\t11235\n\t\t\tBack\n\t\t\tDenver\n\t\t\tCO\n\t\t\t27541\n\t\t\tCanyon\n\t\t\n\t\n\tThe Authguy\n\t\n\t\t771297665AABC\n\t\t1234\n\t\n\t\n\t\tProtected\n\t\tExternal\n\t\tImported\n\t\n\t\n\t\t9194809871\n\t\n\tmyOrder\n\ttrue\n\ttrue\n\tDRAFT\n" schema: oneOf: - $ref: '#/components/schemas/OnNetLnpOrderRequest' - - $ref: '#/components/schemas/TollFreeLnpOrderRequest' + - $ref: '#/components/schemas/ManualTollFreeLnpOrderRequest' + - $ref: '#/components/schemas/AutomatedTollFreeLnpOrderRequest' - $ref: '#/components/schemas/OffNetLnpOrderRequest' - $ref: '#/components/schemas/InternalLnpOrderRequest' responses: @@ -25055,10 +25349,10 @@ paths: content: application/xml: examples: - Simple Order Response: - value: "\n\n\t03f194d5-3932-4e9f-8ba1-03ef767985e5\n\t\n\t\t201\n\t\tOrder request received. Please use the order id to check the status of your order later.\n\t\n\tPENDING_DOCUMENTS\n\t2016-03-25T21:15:00.000Z\n\tThe Authguy\n\t\n\t\tBUSINESS\n\t\tFirst\n\t\tLast\n\t\t\n\t\t\t11235\n\t\t\tBack\n\t\t\tDenver\n\t\t\tCO\n\t\t\t27541\n\t\t\tCanyon\n\t\t\tUnited States\n\t\t\n\t\n\t\n\t\t771297665AABC\n\t\t1234\n\t\n\t\n\t\tProtected\n\t\tExternal\n\t\tImported\n\t\n\t9195551234\n\t9175131245\n\t SITE ID \n\t SIPPEER ID \n\t\n\t\t9194809871\n\t\n\tmyOrder\n\ttrue\n\ttrue\n\ttrue\n" - Toll Free Order Response: - value: "\n\n\t03f194d5-3932-4e9f-8ba1-03ef767985e5\n\t\n\t\t201\n\t\tOrder request received. Please use the order id to check the status of your order later.\n\t\n\tVALIDATE_TFNS\n\t2016-03-25T21:15:00.000Z\n\tThe Authguy\n\t\n\t\t8774809871\n\t\n\tPROCESSING\n\tPhase1TollFree\n" + Automated Toll-Free Order Response: + value: "\n\n\t03f194d5-3932-4e9f-8ba1-03ef767985e5\n\t\n\t\t201\n\t\tOrder request received. Please use the order id to check the status of your order later.\n\t\n\tVALIDATE_TFNS\n\t2016-03-25T21:15:00.000Z\n\tThe Authguy\n\t\n\t\t8774809871\n\t\n\tPROCESSING\n\tPHASE_1_TOLLFREE\n\tJYT01\n" + Regular Order Response: + value: "\n\n\t03f194d5-3932-4e9f-8ba1-03ef767985e5\n\t\n\t\t201\n\t\tOrder request received. Please use the order id to check the status of your order later.\n\t\n\tPENDING_DOCUMENTS\n\t2016-03-25T21:15:00.000Z\n\tThe Authguy\n\t\n\t\tBUSINESS\n\t\tFirst\n\t\tLast\n\t\t\n\t\t\t11235\n\t\t\tBack\n\t\t\tDenver\n\t\t\tCO\n\t\t\t27541\n\t\t\tCanyon\n\t\t\tUnited States\n\t\t\n\t\n\t\n\t\t771297665AABC\n\t\t1234\n\t\n\t\n\t\tProtected\n\t\tExternal\n\t\tImported\n\t\n\t9195551234\n\t9175131245\n\t SITE ID \n\t SIPPEER ID \n\t\n\t\t9194809871\n\t\n\tmyOrder\n\ttrue\n\ttrue\n" schema: $ref: '#/components/schemas/LnpOrderResponse' description: >- @@ -25076,53 +25370,53 @@ paths: value: |- - - 400 - Validation Failed. Please check your input parameters. - - - 7309 - The site id was not supplied or is invalid. - - - 7312 - The sippeer id is invalid. - - - 7398 - Protected status is not available for numbers in off-net rate centers. - - EXCEPTION - The Authguy - - BUSINESS - First - Last - - 11235 - Back - Denver - CO - 27541 - Canyon - United States - - - - 771297665AABC - 1234 - - - Protected - External - Imported - - 9195551234 - 9175131245 - - 9194809871 - - true + + 400 + Validation Failed. Please check your input parameters. + + + 7309 + The site id was not supplied or is invalid. + + + 7312 + The sippeer id is invalid. + + + 7398 + Protected status is not available for numbers in off-net rate centers. + + EXCEPTION + The Authguy + + BUSINESS + First + Last + + 11235 + Back + Denver + CO + 27541 + Canyon + United States + + + + 771297665AABC + 1234 + + + Protected + External + Imported + + 9195551234 + 9175131245 + + 9194809871 + + true schema: $ref: '#/components/schemas/LnpOrderResponse' @@ -25279,15 +25573,103 @@ paths: application/xml: examples: Port-in in CANCELLED state: - value: "\n\n\t\n\t\t7205\n\t\tTelephone number is already being processed on another order\n\t\n\tCANCELLED\n\tb4e227b3-2caf-4546-9af7-849c60dce942\n\t2016-03-25T21:15:00.000Z\n\t\n\t2016-03-25T21:15:00.000Z\n\tSJM00002\n\tThe Authguy\n\t\n\t\tBUSINESS\n\t\tFirst\n\t\tLast\n\t\t\n\t\t\t11235\n\t\t\tBack\n\t\t\tDenver\n\t\t\tCO\n\t\t\t27541\n\t\t\tCanyon\n\t\t\tUnited States\n\t\t\tService\n\t\t\n\t\n\t\n\t\t771297665AABC\n\t\t1234\n\t\n\t\n\t\tProtected\n\t\tExternal\n\t\tImported\n\t\n\t9195551234\n\t9175131245\n\t\n\t\t9194809871\n\t\n\tFoo\n\t20\n\t2857\n\t317771\n\t9998\n\tMock Carrier\n\ttrue\n\tBandwidth CLEC\n\t2014-08-04T13:37:06.323Z\n\t2014-08-04T13:37:08.676Z\n\tjbm\n\tjbm\n\tfalse\n\tfalse\n\tfalse\n\tAUTOMATED\n" + value: |- + + + + 7205 + Telephone number is already being processed on another order + + CANCELLED + b4e227b3-2caf-4546-9af7-849c60dce942 + 2016-03-25T21:15:00.000Z + + 2016-03-25T21:15:00.000Z + SJM00002 + The Authguy + + BUSINESS + First + Last + + 11235 + Back + Denver + CO + 27541 + Canyon + United States + Service + + + + 771297665AABC + 1234 + + + Protected + External + Imported + + 9195551234 + 9175131245 + + 9194809871 + + Foo + 20 + 2857 + 317771 + 9998 + Mock Carrier + true + Bandwidth CLEC + 2014-08-04T13:37:06.323Z + 2014-08-04T13:37:08.676Z + jbm + jbm + false + false + AUTOMATED + Toll Free INVALID_DRAFT_TFNS state, non-portable TNs: value: "\n\n\tINVALID_DRAFT_TFNS\n\t2021-06-23T15:30:00Z\n\t2021-06-23T15:30:00Z\n\tJane Doe\n\t\n\t\t8336521001\n\t\t8336522001\n\t\n\t9900572\n\t14020\n\t521434\n\t2021-06-16T21:00:43.694Z\n\t2021-06-16T21:03:42.085Z\n\ttestuser\n\ttestuser\n\tMyTestOrder\n\tfalse\n\tMANUAL_TOLLFREE\n\tFAILED\n\t\n\t\t\n\t\t\t\n\t\t\t\t7642\n\t\t\t\tTN list contains at least one toll free number that cannot be ported due to spare status.\n\t\t\t\t\n\t\t\t\t\t8336521001\n\t\t\t\t\n\t\t\t\n\t\t\t\n\t\t\t\t7643\n\t\t\t\tTN list contains at least one toll free number that cannot be ported due to unavailable status.\n\t\t\t\t\n\t\t\t\t\t8336522001\n\t\t\t\t\n\t\t\t\n\t\t\n\t\n\tPHASE_1_TOLLFREE\n" Toll Free INVALID_DRAFT_TFNS state, vendor error: value: "\n\n\tINVALID_DRAFT_TFNS\n\t2021-06-23T15:30:00Z\n\t2021-06-23T15:30:00Z\n\tJane Doe\n\t\n\t\t8336000001\n\t\n\t9900572\n\t14020\n\t521434\n\t2021-06-16T21:00:43.694Z\n\t2021-06-16T21:03:42.085Z\n\ttestuser\n\ttestuser\n\tMyTestOrder\n\tfalse\n\tMANUAL_TOLLFREE\n\tFAILED\n\t\n\t\t\n\t\t\t\n\t\t\t\t7617\n\t\t\t\tBatch Number Query received vendor error: Service unavailable. If this condition persists, please contact Bandwidth for support.\n\t\t\t\t\n\t\t\t\t\t8336000001\n\t\t\t\t\n\t\t\t\n\t\t\n\t\n\tPHASE_1_TOLLFREE\n" Toll Free VALID_DRAFT_TFNS state: - value: "\n\n\tVALID_DRAFT_TFNS\n\t2021-06-23T15:30:00Z\n\t2021-06-23T15:30:00Z\n\tJane Doe\n\t\n\t\t8336532112\n\t\t8336532113\n\t\t8336532114\n\t\n\t9900572\n\t14020\n\t521434\n\t2021-06-16T18:51:42.161Z\n\t2021-06-16T19:51:06.244Z\n\ttestuser\n\ttestuser\n\tMyTestOrder\n\tfalse\n\tMANUAL_TOLLFREE\n\tCOMPLETE\n\tPHASE_1_TOLLFREE\n !scope internal\n \n\tTST52\n !scope internal\n \n\tJYT01\n\ttrue\n\tfalse\n" + value: |- + + + VALID_DRAFT_TFNS + 2021-06-23T15:30:00Z + 2021-06-23T15:30:00Z + Jane Doe + + 8336532112 + 8336532113 + 8336532114 + + 9900572 + 14020 + 521434 + 2021-06-16T18:51:42.161Z + 2021-06-16T19:51:06.244Z + testuser + testuser + MyTestOrder + false + MANUAL_TOLLFREE + COMPLETE + PHASE_1_TOLLFREE + TST52 + true + false + false + schema: - $ref: '#/components/schemas/LnpOrderResponse' + oneOf: + - $ref: '#/components/schemas/LnpOrderResponse' + - $ref: '#/components/schemas/LnpOrderResponseAutomatedTollFree' description: >- The information has been successfully retrieved and displayed in the payload. @@ -25330,48 +25712,63 @@ paths: content: application/xml: examples: - example: - description: example + Automated Toll-Free Request: value: |- - SJM00002 - 2014-12-04T13:00:00.000Z - 8045030092 - 9175131245 - - 23453245 - 1111 - - - Protected - External - Imported - - - RESIDENTIAL - TestName - TestLastName - - - true - 115 - Monarch Way - Cary - NC - 27518 - - - 743 - true - - 2019721004 - 2019721005 - - TestName TestLastName - Foo + SJM00002 + 2022-12-04T11:30:00-04:00 + 743 + 28845 + + 2019721004 + 2019721005 + + TestName TestLastName + JYT01 + + Regular Request: + value: |- + + + SJM00002 + 2014-12-04T13:00:00.000Z + 8045030092 + 9175131245 + + 23453245 + 1111 + + + Protected + External + Imported + + + RESIDENTIAL + TestName + TestLastName + + + true + 115 + Monarch Way + Cary + NC + 27518 + + + 743 + true + + 2019721004 + 2019721005 + + TestName TestLastName + + Foo schema: oneOf: @@ -25383,7 +25780,12 @@ paths: - properties: LnpOrderSupp: $ref: '#/components/schemas/LnpOrderSuppManualTollFree' - title: Toll-Free + title: Manual Toll-Free + type: object + - properties: + LnpOrderSupp: + $ref: '#/components/schemas/LnpOrderSuppAutomatedTollFree' + title: Automated Toll-Free type: object - properties: LnpOrderSupp: @@ -25410,21 +25812,41 @@ paths: content: application/xml: examples: - example: - description: example + Automated Toll-Free Response: value: |- - b6080e4c-7ddf-4faa-bbd8-328a72de9297 - - 200 - Supp request received. Please use the order id to check the status of your order later. - - REQUESTED_SUPP - 2014-12-04T13:00:00Z - 8045030092 - 9175131245 - false + b6080e4c-7ddf-4faa-bbd8-328a72de9297 + + 200 + Supp request received. Please use the order id to check the status of your order later. + + REQUESTED_SUPP + SJM00002 + 2022-12-04T11:30:00-04:00 + 743 + 28845 + + 2019721004 + 2019721005 + + TestName TestLastName + JYT01 + + Simple Order Response: + value: |- + + + b6080e4c-7ddf-4faa-bbd8-328a72de9297 + + 200 + Supp request received. Please use the order id to check the status of your order later. + + REQUESTED_SUPP + 2014-12-04T13:00:00Z + 8045030092 + 9175131245 + false schema: $ref: '#/components/schemas/LnpOrderPutResponse' @@ -25451,32 +25873,32 @@ paths: value: |- - c58fed09-a3fc-49b8-b461-2286146b73c1 - - 400 - Validation Failed. Please check your input parameters. - - - 7331 - Rate Center Not Present in Bandwidth Dashboard - - 7138391156 - - - - 7495 - Unable to change the TNs on this port. Please ensure that the new TNs are from the same losing carrier as the current TNs. - - 2024551000 - 2018391156 - 2018391157 - - - EXCEPTION - 4352154438 + c58fed09-a3fc-49b8-b461-2286146b73c1 + + 400 + Validation Failed. Please check your input parameters. + + + 7331 + Rate Center Not Present in Bandwidth Dashboard + + 7138391156 + + + + 7495 + Unable to change the TNs on this port. Please ensure that the new TNs are from the same losing carrier as the current TNs. + + 2024551000 + 2018391156 + 2018391157 + + + EXCEPTION + 4352154438 schema: - $ref: '#/components/schemas/LnpOrderResponse' + $ref: '#/components/schemas/LnpOrderPutResponse' description: >- List of telephone numbers cannot be changed due to validation errors. @@ -25489,45 +25911,44 @@ paths: value: |- - 969a26eb-3bc4-4db3-ab77-56808accb9b2 - - 409 - Validation Failed. Please check your input parameters. - - - 7717 - This port-in order is associated with a draft bulk port-in order. Either submit the bulk port-in order, or detach this order from the bulk port-in prior to submitting it. - - EXCEPTION - 1234 - Super Man - - RESIDENTIAL - John - Doe - - 10 - Awesome Lane - NewBern - NC - 99999 - United States - Service - - - - 771297665AABC - 1234ab - - 2019721103 - - 2019721103 - - false - PORTIN + 969a26eb-3bc4-4db3-ab77-56808accb9b2 + + 409 + Validation Failed. Please check your input parameters. + + + 7717 + This port-in order is associated with a draft bulk port-in order. Either submit the bulk port-in order, or detach this order from the bulk port-in prior to submitting it. + + EXCEPTION + 1234 + Super Man + + RESIDENTIAL + John + Doe + + 10 + Awesome Lane + NewBern + NC + 99999 + United States + Service + + + + 771297665AABC + 1234ab + + 2019721103 + + 2019721103 + + false schema: - $ref: '#/components/schemas/LnpOrderResponse' + $ref: '#/components/schemas/LnpOrderPutResponse' description: >- The port-in is associated with a bulk port-in in DRAFT state. To submit this port-in detach it from the parent bulk port-in. @@ -26233,27 +26654,6 @@ paths: summary: Update port-in loa file metadata tags: - Porting - /accounts/{accountId}/portins/{orderId}/losingCarrier: - get: - description: >- - Retrieves the losing carrier information associated with the specified - port-in ID number - operationId: GetPortInLosingCarrierInfo - parameters: - - $ref: '#/components/parameters/AccountIdPathParam' - - $ref: '#/components/parameters/OrderIdPathParam' - responses: - '200': - content: - application/xml: - schema: - $ref: '#/components/schemas/PortinLosingCarrierResponse' - description: >- - The information has been successfully retrieved and displayed in the - payload - summary: Get Port-in Losing Carrier Info - tags: - - Porting /accounts/{accountId}/portins/{orderId}/notes: get: description: Retrieve all notes associated with the order.
@@ -38719,3 +39119,4 @@ tags: - name: Tn Option - name: Tn Reservation - name: Tns + - name: Admin