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

Commit

Permalink
Add Code Snippets to Spec Files
Browse files Browse the repository at this point in the history
  • Loading branch information
@DX-Bandwidth
DX-Bandwidth committed Oct 17, 2023
1 parent bd64144 commit 7cdebd0
Showing 1 changed file with 16 additions and 24 deletions.
40 changes: 16 additions & 24 deletions site/specs/numbers_v2.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14109,6 +14109,9 @@ components:
- $ref: '#/components/schemas/CitySearchAndOrder_NANPA'
- $ref: '#/components/schemas/StateSearchAndOrder_NANPA'
- $ref: '#/components/schemas/CombinedSearchAndOrder_NANPA'
properties:
RequirementsPackageId:
type: integer
xml:
name: OrderResponse
type: object
Expand Down Expand Up @@ -14182,6 +14185,9 @@ components:
- $ref: '#/components/schemas/CitySearchAndOrder_NANPA'
- $ref: '#/components/schemas/StateSearchAndOrder_NANPA'
- $ref: '#/components/schemas/CombinedSearchAndOrder_NANPA'
properties:
RequirementsPackageId:
type: integer
OrderCompleteDate:
type: string
OrderStatus:
Expand Down Expand Up @@ -29300,7 +29306,6 @@ paths:
<Quantity>1</Quantity>
</AreaCodeSearchAndOrderType>
<PartialAllowed>true</PartialAllowed>
<requirementsPackageId>123456789</requirementsPackageId>
<SiteId>743</SiteId>
</Order>
CitySearchAndOrderType [NANPA]:
Expand All @@ -29317,7 +29322,6 @@ paths:
<State>NC</State>
</CitySearchAndOrderType>
<PartialAllowed>true</PartialAllowed>
<requirementsPackageId>123456789</requirementsPackageId>
<SiteId>743</SiteId>
</Order>
CombinedSearchAndOrderType (local vanity) [NANPA]:
Expand All @@ -29340,7 +29344,6 @@ paths:
<Quantity>1</Quantity>
<EndsIn>false</EndsIn>
</CombinedSearchAndOrderType>
<requirementsPackageId>123456789</requirementsPackageId>
<SiteId>743</SiteId>
</Order>
CombinedSearchAndOrderType (protected status) [NANPA]:
Expand All @@ -29364,7 +29367,6 @@ paths:
<TnAttribute>Imported</TnAttribute>
</TnAttributes>
<PartialAllowed>true</PartialAllowed>
<requirementsPackageId>123456789</requirementsPackageId>
<SiteId>743</SiteId>
</Order>
CombinedSearchAndOrderType [NANPA]:
Expand Down Expand Up @@ -29394,7 +29396,6 @@ paths:
<EnableLCA>false</EnableLCA>
</CombinedSearchAndOrderType>
<PartialAllowed>true</PartialAllowed>
<requirementsPackageId>123456789</requirementsPackageId>
<SiteId>743</SiteId>
</Order>
ExistingTelephoneNumberOrderType:
Expand All @@ -29419,7 +29420,7 @@ paths:
<ReservationId>[GUID]</ReservationId>
</ReservationIdList>
</ExistingTelephoneNumberOrderType>
<requirementsPackageId>123456789</requirementsPackageId>
<RequirementsPackageId>123456789</RequirementsPackageId>
<SiteId>743</SiteId>
</Order>
General:
Expand Down Expand Up @@ -29452,7 +29453,6 @@ paths:
<Lata>224</Lata>
</LATASearchAndOrderType>
<PartialAllowed>true</PartialAllowed>
<requirementsPackageId>123456789</requirementsPackageId>
<SiteId>743</SiteId>
</Order>
NPANXXSearchAndOrderType [NANPA]:
Expand Down Expand Up @@ -29481,7 +29481,6 @@ paths:
<Quantity>1</Quantity>
</NPANXXSearchAndOrderType>
<PartialAllowed>true</PartialAllowed>
<requirementsPackageId>123456789</requirementsPackageId>
<SiteId>743</SiteId>
</Order>
RateCenterSearchAndOrderType [NANPA]:
Expand All @@ -29498,7 +29497,6 @@ paths:
<Quantity>1</Quantity>
</RateCenterSearchAndOrderType>
<PartialAllowed>true</PartialAllowed>
<requirementsPackageId>123456789</requirementsPackageId>
<SiteId>743</SiteId>
</Order>
StateSearchAndOrderType [NANPA]:
Expand All @@ -29514,7 +29512,6 @@ paths:
<State>NC</State>
</StateSearchAndOrderType>
<PartialAllowed>true</PartialAllowed>
<requirementsPackageId>123456789</requirementsPackageId>
<SiteId>743</SiteId>
</Order>
TollFreeVanitySearchAndOrderType [NANPA]:
Expand All @@ -29533,7 +29530,6 @@ paths:
<TollFreeVanity>newcars</TollFreeVanity>
</TollFreeVanitySearchAndOrderType>
<PartialAllowed>true</PartialAllowed>
<requirementsPackageId>123456789</requirementsPackageId>
<SiteId>743</SiteId>
</Order>
TollFreeWildCharSearchAndOrderType [NANPA]:
Expand All @@ -29552,7 +29548,6 @@ paths:
<TollFreeWildCardPattern>8**</TollFreeWildCardPattern>
</TollFreeWildCharSearchAndOrderType>
<PartialAllowed>true</PartialAllowed>
<requirementsPackageId>123456789</requirementsPackageId>
<SiteId>743</SiteId>
</Order>
ZIPSearchAndOrderType [NANPA]:
Expand All @@ -29568,7 +29563,6 @@ paths:
<Zip>27606</Zip>
</ZIPSearchAndOrderType>
<PartialAllowed>true</PartialAllowed>
<requirementsPackageId>123456789</requirementsPackageId>
<SiteId>743</SiteId>
</Order>
schema:
Expand Down Expand Up @@ -29611,7 +29605,6 @@ paths:
</TnAttributes>
<PartialAllowed>true</PartialAllowed>
<SiteId>3013</SiteId>
<requirementsPackageId>123456789</requirementsPackageId>
</Order>
</OrderResponse>
schema:
Expand Down Expand Up @@ -29648,7 +29641,6 @@ paths:
</TnAttributes>
<PartialAllowed>true</PartialAllowed>
<SiteId>763</SiteId>
<requirementsPackageId>123456789</requirementsPackageId>
</Order>
</OrderResponse>
schema:
Expand Down Expand Up @@ -30539,7 +30531,7 @@ paths:
application/xml:
examples:
Automated NANP Toll-Free Port-in:
value: "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>\n<LnpOrder>\n\t<CustomerOrderId>My order id</CustomerOrderId>\n\t<RequestedFocDate>2021-06-16Z</RequestedFocDate>\n\t<SiteId>2439</SiteId>\n\t<PeerId>23432</PeerId>\n\t<LoaAuthorizingPerson>The Authgal</LoaAuthorizingPerson>\n\t<TargetRespOrgId>JYT01</TargetRespOrgId>\n\t<ListOfPhoneNumbers>\n\t\t<PhoneNumber>+18774809871</PhoneNumber>\n\t</ListOfPhoneNumbers>\n<requirementsPackageId>123456789</requirementsPackageId>\n</LnpOrder>"
value: "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>\n<LnpOrder>\n\t<CustomerOrderId>My order id</CustomerOrderId>\n\t<RequestedFocDate>2021-06-16Z</RequestedFocDate>\n\t<SiteId>2439</SiteId>\n\t<PeerId>23432</PeerId>\n\t<LoaAuthorizingPerson>The Authgal</LoaAuthorizingPerson>\n\t<TargetRespOrgId>JYT01</TargetRespOrgId>\n\t<ListOfPhoneNumbers>\n\t\t<PhoneNumber>+18774809871</PhoneNumber>\n\t</ListOfPhoneNumbers>\n<RequirementsPackageId>123456789</RequirementsPackageId>\n</LnpOrder>"
Global Port-in, Business Subscriber:
value: |-
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
Expand All @@ -30558,7 +30550,7 @@ paths:
<PhoneNumber>+3237470444</PhoneNumber>
</ListOfPhoneNumbers>
<CustomerOrderId>myOrder</CustomerOrderId>
<requirementsPackageId>123456789</requirementsPackageId>
<RequirementsPackageId>123456789</RequirementsPackageId>
</LnpOrder>
Global Port-in, Residential Subscriber:
value: |-
Expand All @@ -30579,10 +30571,10 @@ paths:
<PhoneNumber>+3237470444</PhoneNumber>
</ListOfPhoneNumbers>
<CustomerOrderId>myOrder</CustomerOrderId>
<requirementsPackageId>123456789</requirementsPackageId>
<RequirementsPackageId>123456789</RequirementsPackageId>
</LnpOrder>
On-net NANP Port-in:
value: "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>\n<LnpOrder>\n\t<RequestedFocDate>2016-03-25T21:15:00.000Z</RequestedFocDate>\n\t<AlternateSpid>X455</AlternateSpid>\n\t<BillingTelephoneNumber>+19195551234</BillingTelephoneNumber>\n\t<NewBillingTelephoneNumber>+19175131245</NewBillingTelephoneNumber>\n\t<SiteId>2439</SiteId>\n\t<PeerId>23432</PeerId>\n\t<Subscriber>\n\t\t<SubscriberType>BUSINESS</SubscriberType>\n\t\t<FirstName>First</FirstName>\n\t\t<LastName>Last</LastName>\n\t\t<ServiceAddress>\n\t\t\t<HouseNumber>11235</HouseNumber>\n\t\t\t<StreetName>Back</StreetName>\n\t\t\t<City>Denver</City>\n\t\t\t<StateCode>CO</StateCode>\n\t\t\t<Zip>27541</Zip>\n\t\t\t<County>Canyon</County>\n\t\t</ServiceAddress>\n\t</Subscriber>\n\t<LoaAuthorizingPerson>The Authguy</LoaAuthorizingPerson>\n\t<WirelessInfo>\n\t\t<AccountNumber>771297665AABC</AccountNumber>\n\t\t<PinNumber>1234</PinNumber>\n\t</WirelessInfo>\n\t<TnAttributes>\n\t\t<TnAttribute>Protected</TnAttribute>\n\t\t<TnAttribute>External</TnAttribute>\n\t\t<TnAttribute>Imported</TnAttribute>\n\t</TnAttributes>\n\t<ListOfPhoneNumbers>\n\t\t<PhoneNumber>+19194809871</PhoneNumber>\n\t</ListOfPhoneNumbers>\n\t<CustomerOrderId>myOrder</CustomerOrderId>\n\t<Triggered>true</Triggered>\n\t<PartialPort>true</PartialPort>\n\t<ProcessingStatus>DRAFT</ProcessingStatus>\n <requirementsPackageId>123456789</requirementsPackageId>\n</LnpOrder>"
value: "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>\n<LnpOrder>\n\t<RequestedFocDate>2016-03-25T21:15:00.000Z</RequestedFocDate>\n\t<AlternateSpid>X455</AlternateSpid>\n\t<BillingTelephoneNumber>+19195551234</BillingTelephoneNumber>\n\t<NewBillingTelephoneNumber>+19175131245</NewBillingTelephoneNumber>\n\t<SiteId>2439</SiteId>\n\t<PeerId>23432</PeerId>\n\t<Subscriber>\n\t\t<SubscriberType>BUSINESS</SubscriberType>\n\t\t<FirstName>First</FirstName>\n\t\t<LastName>Last</LastName>\n\t\t<ServiceAddress>\n\t\t\t<HouseNumber>11235</HouseNumber>\n\t\t\t<StreetName>Back</StreetName>\n\t\t\t<City>Denver</City>\n\t\t\t<StateCode>CO</StateCode>\n\t\t\t<Zip>27541</Zip>\n\t\t\t<County>Canyon</County>\n\t\t</ServiceAddress>\n\t</Subscriber>\n\t<LoaAuthorizingPerson>The Authguy</LoaAuthorizingPerson>\n\t<WirelessInfo>\n\t\t<AccountNumber>771297665AABC</AccountNumber>\n\t\t<PinNumber>1234</PinNumber>\n\t</WirelessInfo>\n\t<TnAttributes>\n\t\t<TnAttribute>Protected</TnAttribute>\n\t\t<TnAttribute>External</TnAttribute>\n\t\t<TnAttribute>Imported</TnAttribute>\n\t</TnAttributes>\n\t<ListOfPhoneNumbers>\n\t\t<PhoneNumber>+19194809871</PhoneNumber>\n\t</ListOfPhoneNumbers>\n\t<CustomerOrderId>myOrder</CustomerOrderId>\n\t<Triggered>true</Triggered>\n\t<PartialPort>true</PartialPort>\n\t<ProcessingStatus>DRAFT</ProcessingStatus>\n <RequirementsPackageId>123456789</RequirementsPackageId>\n</LnpOrder>"
schema:
oneOf:
- $ref: '#/components/schemas/OnNetNANPLnpOrderRequest'
Expand All @@ -30597,7 +30589,7 @@ paths:
application/xml:
examples:
Automated NANP Toll-Free Port-in Order Response:
value: "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>\n<LnpOrderResponse>\n\t<OrderId>03f194d5-3932-4e9f-8ba1-03ef767985e5</OrderId>\n\t<Status>\n\t\t<Code>201</Code>\n\t\t<Description>Order request received. Please use the order id to check the status of your order later.</Description>\n\t</Status>\n\t<ProcessingStatus>VALIDATE_TFNS</ProcessingStatus>\n\t<RequestedFocDate>2016-03-25T21:15:00.000Z</RequestedFocDate>\n\t<LoaAuthorizingPerson>The Authguy</LoaAuthorizingPerson>\n\t<ListOfPhoneNumbers>\n\t\t<PhoneNumber>+18774809871</PhoneNumber>\n\t</ListOfPhoneNumbers>\n\t<TollFreeValidationStatus>PROCESSING</TollFreeValidationStatus>\n\t<TollFreePortType>PHASE_1_TOLLFREE</TollFreePortType>\n\t<TargetRespOrgId>JYT01</TargetRespOrgId>\n <requirementsPackageId>123456789</requirementsPackageId>\n</LnpOrderResponse>"
value: "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>\n<LnpOrderResponse>\n\t<OrderId>03f194d5-3932-4e9f-8ba1-03ef767985e5</OrderId>\n\t<Status>\n\t\t<Code>201</Code>\n\t\t<Description>Order request received. Please use the order id to check the status of your order later.</Description>\n\t</Status>\n\t<ProcessingStatus>VALIDATE_TFNS</ProcessingStatus>\n\t<RequestedFocDate>2016-03-25T21:15:00.000Z</RequestedFocDate>\n\t<LoaAuthorizingPerson>The Authguy</LoaAuthorizingPerson>\n\t<ListOfPhoneNumbers>\n\t\t<PhoneNumber>+18774809871</PhoneNumber>\n\t</ListOfPhoneNumbers>\n\t<TollFreeValidationStatus>PROCESSING</TollFreeValidationStatus>\n\t<TollFreePortType>PHASE_1_TOLLFREE</TollFreePortType>\n\t<TargetRespOrgId>JYT01</TargetRespOrgId>\n <RequirementsPackageId>123456789</RequirementsPackageId>\n</LnpOrderResponse>"
Global Port-in Order Response, Business Subscriber:
value: |-
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
Expand All @@ -30622,7 +30614,7 @@ paths:
<PhoneNumber>+3237470444</PhoneNumber>
</ListOfPhoneNumbers>
<CustomerOrderId>myOrder</CustomerOrderId>
<requirementsPackageId>123456789</requirementsPackageId>
<RequirementsPackageId>123456789</RequirementsPackageId>
</LnpOrderResponse>
Global Port-in Order Response, Residential Subscriber:
value: |-
Expand All @@ -30649,10 +30641,10 @@ paths:
<PhoneNumber>+3237470444</PhoneNumber>
</ListOfPhoneNumbers>
<CustomerOrderId>myOrder</CustomerOrderId>
<requirementsPackageId>123456789</requirementsPackageId>
<RequirementsPackageId>123456789</RequirementsPackageId>
</LnpOrderResponse>
On-net NANP Port-in Order Response:
value: "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>\n<LnpOrderResponse>\n\t<OrderId>03f194d5-3932-4e9f-8ba1-03ef767985e5</OrderId>\n\t<Status>\n\t\t<Code>201</Code>\n\t\t<Description>Order request received. Please use the order id to check the status of your order later.</Description>\n\t</Status>\n\t<ProcessingStatus>PENDING_DOCUMENTS</ProcessingStatus>\n\t<RequestedFocDate>2016-03-25T21:15:00.000Z</RequestedFocDate>\n\t<LoaAuthorizingPerson>The Authguy</LoaAuthorizingPerson>\n\t<Subscriber>\n\t\t<SubscriberType>BUSINESS</SubscriberType>\n\t\t<FirstName>First</FirstName>\n\t\t<LastName>Last</LastName>\n\t\t<ServiceAddress>\n\t\t\t<HouseNumber>11235</HouseNumber>\n\t\t\t<StreetName>Back</StreetName>\n\t\t\t<City>Denver</City>\n\t\t\t<StateCode>CO</StateCode>\n\t\t\t<Zip>27541</Zip>\n\t\t\t<County>Canyon</County>\n\t\t\t<Country>United States</Country>\n\t\t</ServiceAddress>\n\t</Subscriber>\n\t<WirelessInfo>\n\t\t<AccountNumber>771297665AABC</AccountNumber>\n\t\t<PinNumber>1234</PinNumber>\n\t</WirelessInfo>\n\t<TnAttributes>\n\t\t<TnAttribute>Protected</TnAttribute>\n\t\t<TnAttribute>External</TnAttribute>\n\t\t<TnAttribute>Imported</TnAttribute>\n\t</TnAttributes>\n\t<BillingTelephoneNumber>+19195551234</BillingTelephoneNumber>\n\t<NewBillingTelephoneNumber>+19175131245</NewBillingTelephoneNumber>\n\t<SiteId> SITE ID </SiteId>\n\t<PeerId> SIPPEER ID </PeerId>\n\t<ListOfPhoneNumbers>\n\t\t<PhoneNumber>+19194809871</PhoneNumber>\n\t</ListOfPhoneNumbers>\n\t<CustomerOrderId>myOrder</CustomerOrderId>\n\t<Triggered>true</Triggered>\n\t<PartialPort>true</PartialPort>\n\t<requirementsPackageId>123456789</requirementsPackageId>\n</LnpOrderResponse>"
value: "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>\n<LnpOrderResponse>\n\t<OrderId>03f194d5-3932-4e9f-8ba1-03ef767985e5</OrderId>\n\t<Status>\n\t\t<Code>201</Code>\n\t\t<Description>Order request received. Please use the order id to check the status of your order later.</Description>\n\t</Status>\n\t<ProcessingStatus>PENDING_DOCUMENTS</ProcessingStatus>\n\t<RequestedFocDate>2016-03-25T21:15:00.000Z</RequestedFocDate>\n\t<LoaAuthorizingPerson>The Authguy</LoaAuthorizingPerson>\n\t<Subscriber>\n\t\t<SubscriberType>BUSINESS</SubscriberType>\n\t\t<FirstName>First</FirstName>\n\t\t<LastName>Last</LastName>\n\t\t<ServiceAddress>\n\t\t\t<HouseNumber>11235</HouseNumber>\n\t\t\t<StreetName>Back</StreetName>\n\t\t\t<City>Denver</City>\n\t\t\t<StateCode>CO</StateCode>\n\t\t\t<Zip>27541</Zip>\n\t\t\t<County>Canyon</County>\n\t\t\t<Country>United States</Country>\n\t\t</ServiceAddress>\n\t</Subscriber>\n\t<WirelessInfo>\n\t\t<AccountNumber>771297665AABC</AccountNumber>\n\t\t<PinNumber>1234</PinNumber>\n\t</WirelessInfo>\n\t<TnAttributes>\n\t\t<TnAttribute>Protected</TnAttribute>\n\t\t<TnAttribute>External</TnAttribute>\n\t\t<TnAttribute>Imported</TnAttribute>\n\t</TnAttributes>\n\t<BillingTelephoneNumber>+19195551234</BillingTelephoneNumber>\n\t<NewBillingTelephoneNumber>+19175131245</NewBillingTelephoneNumber>\n\t<SiteId> SITE ID </SiteId>\n\t<PeerId> SIPPEER ID </PeerId>\n\t<ListOfPhoneNumbers>\n\t\t<PhoneNumber>+19194809871</PhoneNumber>\n\t</ListOfPhoneNumbers>\n\t<CustomerOrderId>myOrder</CustomerOrderId>\n\t<Triggered>true</Triggered>\n\t<PartialPort>true</PartialPort>\n\t<RequirementsPackageId>123456789</RequirementsPackageId>\n</LnpOrderResponse>"
schema:
oneOf:
- $ref: '#/components/schemas/LnpOrderResponse'
Expand Down Expand Up @@ -30690,7 +30682,7 @@ paths:
</Errors>
<Errors>
<Code>1001</Code>
<Description>requirementsPackageId is missing or invalid.</Description>
<Description>RequirementsPackageId is missing or invalid.</Description>
</Errors>
<ProcessingStatus>EXCEPTION</ProcessingStatus>
<LoaAuthorizingPerson>The Authguy</LoaAuthorizingPerson>
Expand Down

0 comments on commit 7cdebd0

Please sign in to comment.