openapi: 3.0.1
info:
  title: Line Features
  description: >-
    Bandwidth's Line Features API


    This API provides endpoints to manage TN Options orders for phone number
    information as well as Line Information Database (LIDB) and 

    Directory Listing/Directory Assistance (DLDA) orders.
  contact:
    name: Bandwidth
    url: https://dev.bandwidth.com/apis/numbers-apis/line-features/
    email: support@bandwidth.com
  version: 1.0.0
  termsOfService: https://www.bandwidth.com/legal/terms-of-service/
servers:
  - url: https://api.bandwidth.com/api/v2
    description: Production
security:
  - Basic: []
  - Bearer: []
paths:
  /accounts/{accountId}/tnoptions:
    get:
      tags:
        - TN Options
      description: >-
        Retrieve a list of the TN Options orders that are associated with the
        account. A maximum of 1,000 orders can be retrieved per request. If no
        date range or specific query parameter (marked by <b>*</b> below) is
        provided, the order results will be limited to the last two years.
      operationId: getTnOptionOrders
      summary: Retrieve list TN Options orders
      parameters:
        - $ref: '#/components/parameters/accountIdPathParam'
        - $ref: '#/components/parameters/statusQueryParam'
        - $ref: '#/components/parameters/tnQueryParam'
        - $ref: '#/components/parameters/customerOrderIdQueryParam'
        - $ref: '#/components/parameters/modifiedDateFromQueryParam'
        - $ref: '#/components/parameters/modifiedDateToQueryParam'
        - $ref: '#/components/parameters/createdDateFromQueryParam'
        - $ref: '#/components/parameters/createdDateToQueryParam'
        - $ref: '#/components/parameters/lastModifiedAfterQueryParam'
        - $ref: '#/components/parameters/lastModifiedByQueryParam'
        - $ref: '#/components/parameters/orderIdFragmentQueryParam'
        - $ref: '#/components/parameters/orderIdDetailsQueryParam'
      responses:
        '200':
          $ref: '#/components/responses/getTnOptionOrdersSummaryResponse'
        '400':
          $ref: '#/components/responses/getTnOptionOrders400Response'
    post:
      tags:
        - TN Options
      description: >
        Create TN Options order to assign line features to the telephone number.


        **The two data elements in the submission are:**

        - **TnOptionGroups**: A list of TnOptionGroup objects, each containing a
        list of telephone numbers and a set of TN Options to assign to all TNs
        in the list.

        - **CustomerOrderId**: Optional customer-defined reference ID for this
        order. Only alphanumeric values, dashes, and spaces are allowed. Max
        length is 255 characters (JSON) or 40 characters (XML). Not unique —
        Bandwidth applies no uniqueness constraint, so multiple orders may share
        the same value. Each order receives its own unique Bandwidth-assigned
        `orderId`.


        **Valid attributes for TnOptionGroup object:**


        | XML Attribute             | JSON Name               | Product     |
        Number Region | VCP Support        |

        |--------------------------
        |-------------------------|-------------|---------------|--------------------|

        | TelephoneNumbers          | phoneNumbers            |            
        |               | Both               |

        | PortOutPasscode           | portOutPasscode         | Numbers     |
        NANP          | Both               |

        | Protected                 | protected               | Numbers     |
        NANP          | Both               |

        | Sms                       | sms                     | Messaging  
        |               | Both               |

        | A2pSettings               | a2pSettings             | Messaging   |
        NANP          | Both               |

        | NNID                      | nnid                    | Messaging   |
        NANP          | Both               |

        | ESPID                     | espid                   | Voice       |
        NANP          | VCP Disabled Only  |

        | CallForward               | callForward             | Voice      
        |               | VCP Disabled Only  |

        | CallVerificationEnabled   | callVerificationEnabled | Voice       |
        NANP          | VCP Disabled Only  |

        | CallingNameDisplay        | callingNameDisplay      | Voice       |
        NANP          | VCP Disabled Only  |

        | FinalDestinationUri       | finalDestinationUri     | Voice       |
        NANP          | VCP Disabled Only  |

        | NumberFormat              | numberFormat            | Voice       |
        NANP          | VCP Disabled Only  |

        | OriginationRoutePlan      | originationRoutePlan    | Voice       |
        NANP          | VCP Disabled Only  |

        | PindropEnabled            | pindropEnabled          | Voice       |
        NANP          | VCP Disabled Only  |

        | RPIDFormat                | rpidFormat              | Voice       |
        NANP          | VCP Disabled Only  |

        | RewriteUser               | rewriteUser             | Voice       |
        NANP          | VCP Disabled Only  |


        **Valid attributes for A2P Settings object:**


        | XML Attribute             | JSON Name               | Product     |
        Number Region | VCP Support        |

        |--------------------------
        |-------------------------|-------------|---------------|--------------------|

        | CampaignId                | campaignId              | Messaging   |
        NANP          | Both

        | Action                    | action                  | Messaging   |
        NANP          | Both               |


        **Valid attributes for Origination Route Plan object:**


        | XML Attribute             | JSON Name               | Product     |
        Number Region | VCP Support        |

        |--------------------------
        |-------------------------|-------------|---------------|--------------------|

        | Id                        | id                      | Voice       |
        NANP          | VCP Disabled Only  |

        | Action                    | action                  | Voice       |
        NANP          | VCP Disabled Only  |

        | Route (object)            | route                   | Voice       |
        NANP          | VCP Disabled Only  |


        **Valid attributes for Route object:**


        | XML Attribute             | JSON Name               | Product     |
        Number Region | VCP Support        |

        |--------------------------
        |-------------------------|-------------|---------------|--------------------|

        | Name                      | name                    | Voice       |
        NANP          | VCP Disabled Only  |

        | Endpoint                  | endpoint                | Voice       |
        NANP          | VCP Disabled Only  |

        | Priority                  | priority                | Voice       |
        NANP          | VCP Disabled Only  |

        | Weight                    | weight                  | Voice       |
        NANP          | VCP Disabled Only  |

        | EndpointType              | endpointType            | Voice       |
        NANP          | VCP Disabled Only  |



        When attributes tagged NANP are passed in the request body, only North
        American Numbering Plan phone numbers are allowed and updated.


        **Values for each TnOptionGroup object attribute:**

        - **TelephoneNumbers**:  
          - A list of telephone numbers as an array of strings.  
          - Each string is an E.164 formatted telephone number. If not E.164, assumes NANP 10-digit format.
        - **PortOutPasscode**: `[{custom string value} | UNCHANGED |
        SYSTEM_DEFAULT]`

        - **Protected**: `[true | false | UNCHANGED | SYSTEM_DEFAULT]`

        - **Sms**: `[ON | OFF | UNCHANGED]`

        - **NNID**: `[{custom integer value} | UNCHANGED | SYSTEM_DEFAULT]`

        - **CallForward**: `[10-digit phone number (string)  | UNCHANGED |
        SYSTEM_DEFAULT]`

        - **CallVerificationEnabled**: `[true | false]`

        - **CallingNameDisplay**: `[ON | OFF | UNCHANGED | SYSTEM_DEFAULT]`

        - **ESPID**: `[{custom string value} | UNCHANGED | SYSTEM_DEFAULT]`

        - **FinalDestinationUri**: `[{custom string value} | UNCHANGED |
        SYSTEM_DEFAULT]`

        - **NumberFormat**: `[10DIGIT | 11DIGIT | E164 | UNCHANGED |
        SYSTEM_DEFAULT]`

        - **OriginationRoutePlan**: `object`
            - **Id**: UUID that Bandwidth generates to identify the route plan.
            - **Action**: `[UNCHANGED | OFF | AS_SPECIFIED]`
            - **Route**:
                - **Name**: `[{custom string value} | UNCHANGED | SYSTEM_DEFAULT]`
                - **Endpoint**: `[{custom string value} | UNCHANGED | SYSTEM_DEFAULT]`
                - **Priority**: `[1-1000]`
                - **Weight**: `[1-1000]`
                - **EndpointType**: `[TN | IPv4 | SIP | FQDN]`
        - **A2PSettings**: `object`
          - **CampaignId**: `[{custom string value} | UNCHANGED | SYSTEM_DEFAULT]`
          - **Action**: `[UNCHANGED | SYSTEM_DEFAULT | OFF | DELETE | AS_SPECIFIED]`
        - **PindropEnabled**: `[true | false]`

        - **RPIDFormat**: `[10DIGIT | 11DIGIT | E164 | UNCHANGED |
        SYSTEM_DEFAULT]`

        - **RewriteUser**: `[{custom string value} | UNCHANGED |
        SYSTEM_DEFAULT]`

        - For all the above attributes:  
          - `SYSTEM_DEFAULT`: Removes the element profile value, reverting the TN to default system behavior.  
          - `UNCHANGED`: Value remains unchanged (read before write model. Leaving the element out of the payload is equivalent to `UNCHANGED`).

        **A2pSettings attribute actions:**


        | Number attribute | Action value   | Description of
        action                                                                                           
        |

        |------------------|----------------|------------------------------------------------------------------------------------------------------------------|

        | LongCode         | SYSTEM_DEFAULT | Removes the per-TN A2P attributes,
        and it reverts to the Location/SIP Peer
        characteristics.                      |

        | LongCode         | AS_SPECIFIED   | Sets the message class and
        campaign ID - this is the default if
        unspecified.                                     |

        | LongCode         | OFF            | Will set the TN as a 'P' TN. Any
        values for Class or Campaign ID are not
        valid.                                  |

        | LongCode         | DELETE         | Will delete the campaign ID from
        TN. Any values for Class or Campaign ID are not
        valid.                          |

        | LongCode         | UNCHANGED      | Do nothing with respect to
        A2P.                                                                                 
        |

        | TollFree         | SYSTEM_DEFAULT | Removes the per-TN A2P attributes,
        and it reverts to the Location/SIP Peer
        characteristics.                      |

        | TollFree         | AS_SPECIFIED   | Sets the message class and
        campaign ID - this is the default if
        unspecified.                                     |

        | TollFree         | OFF            | If set to is 'ON', this is valid
        for Toll Free numbers. If set to 'OFF', this is invalid for Toll Free
        Numbers.  |

        | TollFree         | UNCHANGED      | Do nothing with respect to
        A2P.                                                                                 
        |
      operationId: createTnOptionOrder
      summary: Create TN Options order
      parameters:
        - $ref: '#/components/parameters/accountIdPathParam'
      requestBody:
        $ref: '#/components/requestBodies/tnOptionOrderRequest'
      responses:
        '201':
          $ref: '#/components/responses/tnOptionOrderCreatedResponse'
        '400':
          $ref: '#/components/responses/tnOptionOrder400Response'
  /accounts/{accountId}/tnoptions/{orderId}:
    get:
      tags:
        - TN Options
      description: Retrieve information about a TN Options order with specified ID.
      operationId: getTnOptionOrder
      summary: Retrieve TN Options order
      parameters:
        - $ref: '#/components/parameters/accountIdPathParam'
        - $ref: '#/components/parameters/orderIdPathParam'
      responses:
        '200':
          $ref: '#/components/responses/getTnOptionOrderResponse'
        '400':
          $ref: '#/components/responses/getTnOptionOrder400Response'
  /accounts/{accountId}/tnoptions/{orderId}/history:
    get:
      tags:
        - TN Options
      description: Retrieve the history information associated with an order.
      operationId: getOrderHistory
      summary: Retrieve TN Options order history
      parameters:
        - $ref: '#/components/parameters/accountIdPathParam'
        - $ref: '#/components/parameters/orderIdPathParam'
      responses:
        '200':
          $ref: '#/components/responses/getTnOptionOrderHistory200Response'
        '400':
          $ref: '#/components/responses/badTnOptionRequestError'
        '404':
          $ref: '#/components/responses/getTnOptionOrderHistory404Response'
  /accounts/{accountId}/lidbs:
    get:
      tags:
        - LIDB Orders
      operationId: listLidbOrders
      summary: List LIDB orders
      parameters:
        - $ref: '#/components/parameters/accountIdPathParam'
        - $ref: '#/components/parameters/requiredTnQueryParam'
        - $ref: '#/components/parameters/lastModifiedAfterQueryParam'
        - $ref: '#/components/parameters/modifiedDateFromQueryParam'
        - $ref: '#/components/parameters/modifiedDateToQueryParam'
      responses:
        '200':
          $ref: '#/components/responses/lidbOrderGet200Response'
        '400':
          $ref: '#/components/responses/lidbOrderGet400Response'
        '401':
          $ref: '#/components/responses/errorResponse401'
        '403':
          $ref: '#/components/responses/errorResponse403'
        '404':
          $ref: '#/components/responses/errorResponse404'
        '429':
          $ref: '#/components/responses/errorResponse429'
        '500':
          $ref: '#/components/responses/errorResponse500'
    post:
      tags:
        - LIDB Orders
      operationId: createLidbOrder
      summary: Create LIDB order
      parameters:
        - $ref: '#/components/parameters/accountIdPathParam'
      requestBody:
        $ref: '#/components/requestBodies/lidbOrderRequest'
      responses:
        '201':
          $ref: '#/components/responses/lidbOrderPostSuccessResponse'
        '400':
          $ref: '#/components/responses/lidbOrderPostErrorResponse'
        '401':
          $ref: '#/components/responses/errorResponse401'
        '403':
          $ref: '#/components/responses/errorResponse403'
        '404':
          $ref: '#/components/responses/errorResponse404'
        '429':
          $ref: '#/components/responses/errorResponse429'
        '500':
          $ref: '#/components/responses/errorResponse500'
  /accounts/{accountId}/lidbs/{lidbId}:
    get:
      tags:
        - LIDB Orders
      operationId: readLidbOrder
      summary: Fetch LIDB order status
      description: >
        The descriptive payload for the LIDB Orders query provides a broad range
        of information about the LIDB Order identified in the URL. Included
        amongst the information is:      
          - **errors**: The errors discovered with codes and explanations.
          - **Various Dates**: Such as order creation, modification, and completion dates.
          - **processingStatus** (`RECEIVED`, `PROCESSING`, `COMPLETE`, `PARTIAL`, `FAILED`): The overall status of the order.
          - **lidbPhoneNumberGroups**: List of LidbTnGroup elements that contains a list of TNs with SubscriberInformation, UseType (`RESIDENTIAL` or `BUSINESS`), and Visibility (`PUBLIC` or `PRIVATE`).
      parameters:
        - $ref: '#/components/parameters/accountIdPathParam'
        - $ref: '#/components/parameters/lidbIdPathParam'
      responses:
        '200':
          $ref: '#/components/responses/lidbOrderGetIdResponse'
        '400':
          $ref: '#/components/responses/lidbOrderGetId400Response'
        '401':
          $ref: '#/components/responses/errorResponse401'
        '403':
          $ref: '#/components/responses/errorResponse403'
        '404':
          $ref: '#/components/responses/lidbOrderGetId404Response'
        '429':
          $ref: '#/components/responses/errorResponse429'
        '500':
          $ref: '#/components/responses/errorResponse500'
  /accounts/{accountId}/dldas:
    get:
      tags:
        - DLDA Orders
      operationId: readDldaOrders
      summary: List DLDA orders
      description: >
        Retrieve a list of the DLDA orders that are associated with the account.
        A 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. 

        Results can be sorted by a specified field.
      parameters:
        - $ref: '#/components/parameters/accountIdPathParamDlda'
        - $ref: '#/components/parameters/tnQueryParamDlda'
        - $ref: '#/components/parameters/pageStartIdDlda'
        - $ref: '#/components/parameters/resultsPerPageDlda'
        - $ref: '#/components/parameters/searchTextDlda'
      responses:
        '200':
          $ref: '#/components/responses/dldaOrdersGet200Response'
        '400':
          $ref: '#/components/responses/dldaOrderGet400Response'
        '401':
          $ref: '#/components/responses/errorResponse401'
        '403':
          $ref: '#/components/responses/errorResponse403'
        '404':
          $ref: '#/components/responses/errorResponse404'
        '429':
          $ref: '#/components/responses/errorResponse429'
        '500':
          $ref: '#/components/responses/errorResponse500'
    post:
      tags:
        - DLDA Orders
      operationId: createDldaOrder
      summary: Create DLDA order
      description: >
        Business Listings: Sorted starting from the beginning of the business
        name. Enter the full business name in the LastName field.Leave the
        FirstName field blank unless there is a non-sorting part of the name,
        which can be placed in FirstName. 

        Example: For "Joe's Pizza, the best pizza in town", use LastName: "Joe's
        Pizza", FirstName: "the best pizza in town". 

        Residential Listings: Sorted by the LastName field as usual.
      parameters:
        - $ref: '#/components/parameters/accountIdPathParamDlda'
      requestBody:
        $ref: '#/components/requestBodies/dldaCreateOrderRequest'
      responses:
        '201':
          $ref: '#/components/responses/dldaOrdersPost201Response'
        '400':
          $ref: '#/components/responses/dldaOrdersPost400Response'
        '401':
          $ref: '#/components/responses/errorResponse401'
        '403':
          $ref: '#/components/responses/errorResponse403'
        '404':
          $ref: '#/components/responses/errorResponse404'
        '429':
          $ref: '#/components/responses/errorResponse429'
        '500':
          $ref: '#/components/responses/errorResponse500'
  /accounts/{accountId}/dldas/{orderId}:
    get:
      tags:
        - DLDA Orders
      operationId: readDldaOrder
      summary: Fetching DLDA order status
      description: Retrieve information about a DLDA Order with specified ID.
      parameters:
        - $ref: '#/components/parameters/accountIdPathParamDlda'
        - $ref: '#/components/parameters/orderIdPathParamDlda'
      responses:
        '200':
          $ref: '#/components/responses/dldaOrderIdGet200Response'
        '400':
          $ref: '#/components/responses/dldaOrderGet400ErrorResponse'
        '401':
          $ref: '#/components/responses/errorResponse401'
        '403':
          $ref: '#/components/responses/errorResponse403'
        '404':
          $ref: '#/components/responses/dldaOrderIdGet404ErrorResponse'
        '429':
          $ref: '#/components/responses/errorResponse429'
        '500':
          $ref: '#/components/responses/errorResponse500'
    put:
      tags:
        - DLDA Orders
      operationId: updateDldaOrder
      summary: Update DLDA order
      parameters:
        - $ref: '#/components/parameters/accountIdPathParamDlda'
        - $ref: '#/components/parameters/orderIdPathParamDlda'
      requestBody:
        $ref: '#/components/requestBodies/dldaUpdateOrderRequest'
      responses:
        '200':
          $ref: '#/components/responses/dldaOrdersUpdate200Response'
        '400':
          $ref: '#/components/responses/dldaOrdersUpdate400Response'
        '401':
          $ref: '#/components/responses/errorResponse401'
        '403':
          $ref: '#/components/responses/errorResponse403'
        '404':
          $ref: '#/components/responses/errorResponse404'
        '429':
          $ref: '#/components/responses/errorResponse429'
        '500':
          $ref: '#/components/responses/errorResponse500'
  /accounts/{accountId}/dldas/{orderId}/history:
    get:
      tags:
        - DLDA Orders
      operationId: readDldaOrderHistory
      summary: Fetch DLDA order history
      description: >
        Retrieve the history information associated with a named DLDA order.  

        This indicates the various states that the order has passed through, as
        well as the current state of the order as the last entry.
      parameters:
        - $ref: '#/components/parameters/accountIdPathParamDlda'
        - $ref: '#/components/parameters/orderIdPathParamDlda'
      responses:
        '200':
          $ref: '#/components/responses/dldaOrderIdGetHistory200Response'
        '400':
          $ref: '#/components/responses/dldaOrderGet400ErrorResponse'
        '401':
          $ref: '#/components/responses/errorResponse401'
        '403':
          $ref: '#/components/responses/errorResponse403'
        '404':
          $ref: '#/components/responses/dldaOrderIdGetHistory404ErrorResponse'
        '429':
          $ref: '#/components/responses/errorResponse429'
        '500':
          $ref: '#/components/responses/errorResponse500'
components:
  securitySchemes:
    Basic:
      type: http
      scheme: basic
      description: >-
        Basic authentication is a simple authentication scheme built into the
        HTTP protocol. To use it, send your HTTP requests with an Authorization
        header that contains the word Basic followed by a space and a
        base64-encoded string `username:password`.

        Example: `Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=`
    Bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Bearer authentication (also called token authentication) is an HTTP
        authentication scheme that involves security 

        tokens called bearer tokens. The name “Bearer authentication” can be
        understood as “give access to the bearer

        of this token.” The client must send this token in the `Authorization`
        header when making requests to

        protected resources.


        - Example: `Authorization: Bearer <token>`


        Where `<token>` should be replaced with the token string without angle
        brackets.


        For more information, see the following guide:
        [Credentials](https://dev.bandwidth.com/docs/account/credentials/management)
  parameters:
    accountIdPathParam:
      name: accountId
      in: path
      required: true
      schema:
        type: integer
        example: 1234567
      description: The unique account associated with the order.
    orderIdPathParam:
      name: orderId
      description: >
        Order ID is the unique identifier for the TN Options order. It is a UUID
        that is generated by Bandwidth when

        the order is created. It can be used to retrieve the details of a
        specific TN Options order.
      in: path
      required: true
      schema:
        type: string
      example: bf1305b8-8998-1111-2222-51ba3ce52d4e
    statusQueryParam:
      name: status
      description: The status of the TN Options order being searched for.
      in: query
      required: false
      schema:
        type: string
        enum:
          - RECEIVED
          - PROCESSING
          - COMPLETE
          - PARTIAL
          - FAILED
      example: PROCESSING
    tnQueryParam:
      name: phoneNumber
      description: |
        A phone number that is referenced in the order.
      in: query
      required: false
      schema:
        type: string
      example: '+19199918388'
    customerOrderIdQueryParam:
      name: customerOrderId
      description: >
        Filter orders by a customer-assigned reference ID. Because
        `customerOrderId` is not unique — Bandwidth applies no uniqueness
        constraint — this query may return multiple orders if the same value was
        used across multiple orders. Each result will have a distinct
        Bandwidth-assigned `orderId`. To retrieve a single specific order, use
        its `orderId` instead.
      in: query
      required: false
      schema:
        type: string
      example: ABCCorp12345
    modifiedDateFromQueryParam:
      name: modifiedDateFrom
      description: >
        For Date-based searches, the starting date of a date range (inclusive)
        that will be used to find TN Options

        orders that were modified within the date range. It is in the form
        yyyy-MM-dd.
      in: query
      required: false
      schema:
        type: string
      example: '2013-10-22'
    modifiedDateToQueryParam:
      name: modifiedDateTo
      description: >
        For Date-based searches, the ending date of a date range (inclusive)
        that will be used to find TN Options orders

        that were modified within the date range.  It is in the form yyyy-MM-dd.
      in: query
      required: false
      schema:
        type: string
      example: '2013-10-25'
    createdDateFromQueryParam:
      name: createdDateFrom
      description: >
        Checks the order's creation date against this value. Orders that have a
        creation date after this date will

        be included. Format is yyyy-MM-dd.
      in: query
      required: false
      schema:
        type: string
      example: '2013-10-22'
    createdDateToQueryParam:
      name: createdDateTo
      description: >
        Checks the order's creation date against this value. Orders that have a
        creation date before this date will

        be included. Format is yyyy-MM-dd.
      in: query
      required: false
      schema:
        type: string
      example: '2013-10-25'
    lastModifiedAfterQueryParam:
      name: lastModifiedAfter
      description: >
        Checks the order's last modified date against this value. Orders that
        have a modification date after this date

        will be included. Format is yyyy-MM-dd.
      in: query
      required: false
      schema:
        type: string
      example: '2013-10-25'
    lastModifiedByQueryParam:
      name: lastModifiedBy
      description: >-
        This is the user-name of the user that last modified the TN Options
        order.
      in: query
      required: false
      schema:
        type: string
      example: smckinnon
    orderIdFragmentQueryParam:
      name: orderIdFragment
      description: >
        <b>*</b> This search parameter represents the internal Bandwidth App API
        ID that has been assigned to

        the TN Options order. This parameter is the first few characters of the
        internal ID - 

        the entire ID does not need to be specified.
      in: query
      required: false
      schema:
        type: string
      example: ed1c0bed-e2
    orderIdDetailsQueryParam:
      name: orderDetails
      description: >-
        If set to true, a list of order details will be displayed instead the
        summary information.
      in: query
      required: false
      schema:
        type: boolean
    lidbIdPathParam:
      name: lidbid
      in: path
      required: true
      description: LIDB order ID
      schema:
        type: string
    requiredTnQueryParam:
      name: phoneNumber
      in: query
      required: true
      description: |
        A phone Number that is referenced in the order
      schema:
        type: string
      example: '+19199918388'
    accountIdPathParamDlda:
      description: User's account ID.
      example: '1234567'
      in: path
      name: accountId
      required: true
      schema:
        type: string
    orderIdPathParamDlda:
      name: orderId
      in: path
      description: DLDA order id
      required: true
      schema:
        type: string
      example: f179237b-c1cb-449d-9590-aaa9d0bf3ca4
    tnQueryParamDlda:
      name: phoneNumber
      description: A phone Number that is referenced in the order
      in: query
      required: true
      schema:
        type: string
      example: '+19199918388'
    resultsPerPageDlda:
      description: The number of items to include in a page.
      example: 5000
      in: query
      name: size
      required: false
      schema:
        default: 500
        type: integer
    pageStartIdDlda:
      description: >-
        An ID of the first element in a page.  This value will indicate the
        first value, not the page number, of the initial entry in the page being
        requested.<br> It can be an id of address. The initial page is tagged
        with the ID `1`.
      example: '3'
      in: query
      name: page
      required: false
      schema:
        default: '1'
        type: string
    searchTextDlda:
      description: The text to search simultaneously through e911locationIds.
      example: name
      in: query
      name: suggestions
      required: false
      schema:
        type: string
  schemas:
    tnOptionOrderJsonRequestVcpDisabled:
      type: object
      title: VCP Disabled TN Options Order Request
      properties:
        customerOrderId:
          type: string
          description: >-
            Optional customer-defined reference ID for this order. Only
            alphanumeric values, dashes, and spaces are allowed. Not unique —
            Bandwidth applies no uniqueness constraint, so multiple orders may
            share the same value. Each order receives its own unique
            Bandwidth-assigned `orderId`.
          maxLength: 255
        tnOptionGroups:
          type: array
          description: >-
            Each group contains a list of telephone numbers and set of TN
            options you want to assign to all TNs in the list
          items:
            $ref: '#/components/schemas/tnOptionGroupJsonVcpDisabledRequest'
    tnOptionOrderJsonRequestVcpEnabled:
      type: object
      title: VCP Enabled TN Options Order Request
      properties:
        customerOrderId:
          type: string
          description: >-
            Optional customer-defined reference ID for this order. Only
            alphanumeric values, dashes, and spaces are allowed. Not unique —
            Bandwidth applies no uniqueness constraint, so multiple orders may
            share the same value. Each order receives its own unique
            Bandwidth-assigned `orderId`.
          maxLength: 255
        tnOptionGroups:
          type: array
          description: >-
            Each group contains list of telephone numbers and set of TN Options
            you want to assign to all TNs in the list
          items:
            $ref: '#/components/schemas/tnOptionGroupJsonVcpEnabled'
    tnOptionGroupJsonVcpEnabled:
      type: object
      properties:
        portOutPasscode:
          anyOf:
            - title: Custom Passcode
              minLength: 4
              maxLength: 10
              pattern: ^[a-zA-Z0-9]+$
              description: |
                Custom alphanumeric value (4-10 chars).
            - title: Enum Values
              type: string
              enum:
                - UNCHANGED
                - SYSTEM_DEFAULT
        protected:
          type: string
          enum:
            - 'true'
            - 'false'
            - UNCHANGED
            - SYSTEM_DEFAULT
        sms:
          type: string
          enum:
            - 'ON'
            - 'OFF'
            - UNCHANGED
            - SYSTEM_DEFAULT
        a2pSettings:
          $ref: '#/components/schemas/a2pSettingsJson'
        nnid:
          anyOf:
            - title: Custom Value
              type: string
              minLength: 1
              maxLength: 64
            - title: Enum Values
              type: string
              enum:
                - UNCHANGED
                - SYSTEM_DEFAULT
        phoneNumbers:
          type: array
          items:
            type: string
            description: E-164 TNs
    tnOptionGroupJsonVcpDisabledRequest:
      type: object
      properties:
        numberFormat:
          type: string
          enum:
            - 10DIGIT
            - 11DIGIT
            - E164
            - UNCHANGED
            - SYSTEM_DEFAULT
        rpidFormat:
          type: string
          enum:
            - 10DIGIT
            - 11DIGIT
            - E164
            - UNCHANGED
            - SYSTEM_DEFAULT
        rewriteUser:
          anyOf:
            - type: string
              title: Enum Values
              enum:
                - UNCHANGED
                - SYSTEM_DEFAULT
            - type: string
              title: Custom Value
              description: >-
                This field must be a string up to 30 characters long, containing
                only letters (a-z, A-Z), digits (0-9),

                and the following symbols: +, @, :, ., (, ), _, ;, ?, =, -. No
                spaces or other special characters are allowed.
              pattern: ^[a-zA-Z0-9+@:.()_;?=-]{0,30}$
        callForward:
          anyOf:
            - type: string
              title: Enum Values
              enum:
                - UNCHANGED
                - SYSTEM_DEFAULT
            - type: string
              title: Custom Value
              pattern: (\+1[2-9][0-9]{2}[2-9]{6}|[2-9][0-9]{5,17})
              description: >-
                This field must be a string representing a valid call forwarding
                number. It permits either:

                A US number in the format +1NXXNXXXXXX (where N is 2-9, X is
                0-9).

                A number with 6 to 18 digits, starting with a digit 2-9.
        callingNameDisplay:
          type: string
          enum:
            - 'ON'
            - 'OFF'
            - UNCHANGED
            - SYSTEM_DEFAULT
        portOutPasscode:
          anyOf:
            - title: Custom Passcode
              type: string
              minLength: 4
              maxLength: 10
              pattern: ^[a-zA-Z0-9]+$
              description: |
                Custom alphanumeric value (4-10 chars).
            - title: Enum Values
              type: string
              enum:
                - UNCHANGED
                - SYSTEM_DEFAULT
              description: Special Values
        protected:
          type: string
          enum:
            - 'true'
            - 'false'
            - UNCHANGED
            - SYSTEM_DEFAULT
        sms:
          type: string
          enum:
            - 'ON'
            - 'OFF'
            - UNCHANGED
            - SYSTEM_DEFAULT
        finalDestinationUri:
          anyOf:
            - title: Custom Value
              type: string
              minLength: 10
              maxLength: 60
              description: >
                a 10 digit telephone number or a SIP URI ( without the sip:
                prefix ) in the form address-string@host IP:port, where the host
                IP is an IPv4 address in the standard numerical n.n.n.n. form,
                and the port is numeric, and optional containing [a-z,A-Z,0-9],
                with ':', '.' and '@' to delimit the components of the overall
                string, and less than 60 characters long.
            - title: Enum Values
              type: string
              enum:
                - UNCHANGED
                - SYSTEM_DEFAULT
        a2pSettings:
          $ref: '#/components/schemas/a2pSettingsJson'
        nnid:
          anyOf:
            - title: Custom Value
              type: string
              minLength: 1
              maxLength: 64
            - title: Enum Values
              type: string
              enum:
                - UNCHANGED
                - SYSTEM_DEFAULT
        espid:
          anyOf:
            - title: Custom Value
              type: string
              minLength: 1
              maxLength: 64
            - title: Enum Values
              type: string
              enum:
                - UNCHANGED
                - SYSTEM_DEFAULT
        originationRoutePlan:
          $ref: '#/components/schemas/originationRoutePlanJson'
        pindropEnabled:
          type: string
          enum:
            - 'true'
            - 'false'
        callVerificationEnabled:
          type: string
          enum:
            - 'true'
            - 'false'
        phoneNumbers:
          type: array
          items:
            type: string
            description: E164 TNs
    tnOptionGroupJsonVcpDisabledResponse:
      type: object
      properties:
        numberFormat:
          type: string
          enum:
            - 10DIGIT
            - 11DIGIT
            - E164
            - UNCHANGED
            - SYSTEM_DEFAULT
        rpidFormat:
          type: string
          enum:
            - 10DIGIT
            - 11DIGIT
            - E164
            - UNCHANGED
            - SYSTEM_DEFAULT
        rewriteUser:
          anyOf:
            - type: string
              title: Enum Values
              enum:
                - UNCHANGED
                - SYSTEM_DEFAULT
            - type: string
              title: Custom Value
              description: >-
                This field must be a string up to 30 characters long, containing
                only letters (a-z, A-Z), digits (0-9),

                and the following symbols: +, @, :, ., (, ), _, ;, ?, =, -. No
                spaces or other special characters are allowed.
              pattern: ^[a-zA-Z0-9+@:.()_;?=-]{0,30}$
        callForward:
          anyOf:
            - type: string
              title: Enum Values
              enum:
                - UNCHANGED
                - SYSTEM_DEFAULT
            - type: string
              title: Custom Value
              pattern: (\+1[2-9][0-9]{2}[2-9]{6}|[2-9][0-9]{5,17})
              description: >-
                This field must be a string representing a valid call forwarding
                number. It permits either:

                A US number in the format +1NXXNXXXXXX (where N is 2-9, X is
                0-9).

                A number with 6 to 18 digits, starting with a digit 2-9.
        callingNameDisplay:
          type: string
          enum:
            - 'ON'
            - 'OFF'
            - UNCHANGED
            - SYSTEM_DEFAULT
        portOutPasscode:
          anyOf:
            - title: Custom Passcode
              type: string
              minLength: 4
              maxLength: 10
              pattern: ^[a-zA-Z0-9]+$
              description: |
                Custom alphanumeric value (4-10 chars).
            - title: Enum Values
              type: string
              enum:
                - UNCHANGED
                - SYSTEM_DEFAULT
              description: Special Values
        protected:
          type: string
          enum:
            - 'TRUE'
            - 'FALSE'
            - UNCHANGED
            - SYSTEM_DEFAULT
        sms:
          type: string
          enum:
            - 'ON'
            - 'OFF'
            - UNCHANGED
            - SYSTEM_DEFAULT
        finalDestinationUri:
          anyOf:
            - title: Custom Value
              type: string
              minLength: 10
              maxLength: 60
              description: >
                a 10 digit telephone number or a SIP URI ( without the sip:
                prefix ) in the form address-string@host IP:port, where the host
                IP is an IPv4 address in the standard numerical n.n.n.n. form,
                and the port is numeric, and optional containing [a-z,A-Z,0-9],
                with ':', '.' and '@' to delimit the components of the overall
                string, and less than 60 characters long.
            - title: Enum Values
              type: string
              enum:
                - UNCHANGED
                - SYSTEM_DEFAULT
        a2pSettings:
          $ref: '#/components/schemas/a2pSettingsJson'
        nnid:
          anyOf:
            - title: Custom Value
              type: string
              minLength: 1
              maxLength: 64
            - title: Enum Values
              type: string
              enum:
                - UNCHANGED
                - SYSTEM_DEFAULT
        espid:
          anyOf:
            - title: Custom Value
              type: string
              minLength: 1
              maxLength: 64
            - title: Enum Values
              type: string
              enum:
                - UNCHANGED
                - SYSTEM_DEFAULT
        originationRoutePlan:
          $ref: '#/components/schemas/originationRoutePlanJson'
        pindropEnabled:
          type: string
          enum:
            - 'TRUE'
            - 'FALSE'
        callVerificationEnabled:
          type: string
          enum:
            - 'TRUE'
            - 'FALSE'
        phoneNumbers:
          type: array
          items:
            type: string
            description: E164 TNs
    originationRoutePlanJson:
      type: object
      description: >-
        The originationRoutePlan element consists of an action and a list of
        prioritized and weighted routes that tell Bandwidth where to send phone
        calls to phone numbers associated with the route plan.
      properties:
        id:
          type: string
          format: uuid
        routes:
          type: array
          items:
            $ref: '#/components/schemas/originationRoutePayloadJson'
        action:
          type: string
          enum:
            - UNCHANGED
            - 'OFF'
            - AS_SPECIFIED
    originationRoutePayloadJson:
      type: object
      properties:
        name:
          description: >-
            A friendly name for a route. This is not used for any back-end call
            routing.
          type: string
        endpoint:
          type: string
          description: >
            Must be one of the following: - a NANP 10-digit telephone number - a
            SIP URI - an IPv4 address - a Fully Qualified Domain Name (FQDN)
        priority:
          type: integer
          format: int32
        weight:
          type: integer
          format: int32
        endpointType:
          type: string
          enum:
            - TN
            - IPv4
            - SIP
            - FQDN
    a2pSettingsJson:
      type: object
      properties:
        campaignId:
          type: string
          minLength: 1
          maxLength: 64
        action:
          type: string
          enum:
            - UNCHANGED
            - SYSTEM_DEFAULT
            - 'OFF'
            - DELETE
            - AS_SPECIFIED
    tnOptionOrderJsonResponse:
      type: object
      properties:
        orderId:
          type: string
        accountId:
          type: integer
          format: int32
        lastModifiedDate:
          type: string
        createdByUser:
          type: string
        customerOrderId:
          type: string
          description: >-
            The customer-defined reference ID for this order, if one was
            provided at creation. Not unique — Bandwidth applies no uniqueness
            constraint, so multiple orders may share the same value. Each order
            has a distinct Bandwidth-assigned `orderId`.
        orderCreateDate:
          type: string
        processingStatus:
          type: string
          enum:
            - RECEIVED
            - PROCESSING
            - COMPLETE
            - PARTIAL
            - FAILED
        tnOptionGroups:
          type: array
          items:
            $ref: '#/components/schemas/tnOptionGroupJsonVcpDisabledResponse'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/tnOptionOrderErrorJson'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/tnOptionOrderWarningPayloadJson'
    tnOptionOrderJsonResponsePayload:
      type: object
      title: TnOptionOrder
      properties:
        orderId:
          type: string
        accountId:
          type: integer
          format: int32
        lastModifiedDate:
          type: string
        createdByUser:
          type: string
        customerOrderId:
          type: string
          description: >-
            The customer-defined reference ID for this order, if one was
            provided at creation. Not unique — Bandwidth applies no uniqueness
            constraint, so multiple orders may share the same value. Each order
            has a distinct Bandwidth-assigned `orderId`.
        orderCreateDate:
          type: string
        processingStatus:
          type: string
          enum:
            - RECEIVED
            - PROCESSING
            - COMPLETE
            - PARTIAL
            - FAILED
        tnOptionGroups:
          type: array
          items:
            $ref: '#/components/schemas/tnOptionGroupJsonVcpDisabledResponse'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/tnOptionOrderErrorJson'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/tnOptionOrderWarningPayloadJson'
    tnOptionOrderErrorJson:
      type: object
      title: Error
      properties:
        code:
          type: integer
          format: int32
        description:
          type: string
        phoneNumber:
          type: string
    tnOptionOrderWarningPayloadJson:
      type: object
      title: Warning
      properties:
        phoneNumber:
          type: string
        description:
          type: string
    tnOptionOrderErrorResponseJson:
      type: object
      properties:
        code:
          description: Numeric designation of corresponding error
          type: integer
        description:
          description: 'Detailed explanation about error '
          type: string
    tnOptionOrderReportSummaryJsonResponse:
      type: object
      title: Summary Response
      properties:
        totalCount:
          type: integer
        orders:
          type: array
          title: tnOptionOrderSummary
          items:
            $ref: '#/components/schemas/orderSummaryJson'
    tnOptionOrderReportDetailedJsonResponse:
      type: object
      title: Detailed Response
      properties:
        totalCount:
          type: integer
        orders:
          type: array
          items:
            $ref: '#/components/schemas/tnOptionOrderJsonResponsePayload'
    orderSummaryJson:
      type: object
      properties:
        accountId:
          type: integer
        phoneNumberCount:
          type: integer
        userId:
          type: string
        lastModifiedDate:
          type: string
        orderDate:
          type: string
        orderType:
          type: string
        orderStatus:
          type: string
        orderId:
          type: string
    paginationLinks:
      type: object
      title: Links
      properties:
        first:
          type: string
        next:
          type: string
        previous:
          type: string
        last:
          type: string
    note:
      type: object
      properties:
        Note:
          type: object
          properties:
            Id:
              description: >-
                This is the Order Note identifier that is automatically
                generated by system.
              type: string
            UserId:
              description: >-
                The UserId is authenticated for access to the network via a
                username string.
              type: string
            Description:
              description: This is the Order Note description.
              type: string
            LastDateModifier:
              description: This is the date when Order Note was last modified.
              type: string
    noteJson:
      type: object
      properties:
        note:
          type: object
          properties:
            id:
              description: >-
                This is the Order Note identifier that is automatically
                generated by system.
              type: string
            userId:
              description: >-
                The userId is authenticated for access to the network via a
                username string.
              type: string
            description:
              description: This is the Order Note description.
              type: string
            lastDateModified:
              description: This is the date when Order Note was last modified.
              type: string
    telephoneNumberDetails:
      type: object
      properties:
        States:
          type: array
          xml:
            wrapped: true
          items:
            $ref: '#/components/schemas/stateWithCount'
        RateCenters:
          type: array
          xml:
            wrapped: true
          items:
            $ref: '#/components/schemas/rateCenterWithCount'
        Cities:
          type: array
          xml:
            wrapped: true
          items:
            $ref: '#/components/schemas/cityWithCount'
        Tiers:
          type: array
          xml:
            wrapped: true
          items:
            $ref: '#/components/schemas/tiers'
        Vendors:
          type: array
          xml:
            wrapped: true
          items:
            $ref: '#/components/schemas/vendors'
    stateWithCount:
      type: object
      properties:
        State:
          type: string
        Count:
          type: integer
    rateCenterWithCount:
      type: object
      properties:
        RateCenter:
          type: string
        Count:
          type: integer
    cityWithCount:
      type: object
      properties:
        City:
          type: string
        Count:
          type: integer
    tiers:
      type: object
      properties:
        Tier:
          type: string
        Count:
          type: integer
    vendors:
      type: object
      properties:
        VendorName:
          type: string
        VendorId:
          type: integer
        Count:
          type: integer
    phoneNumberDetails:
      type: object
      properties:
        states:
          type: array
          xml:
            wrapped: true
          items:
            $ref: '#/components/schemas/stateWithCountJson'
        rateCenters:
          type: array
          xml:
            wrapped: true
          items:
            $ref: '#/components/schemas/rateCenterWithCountJson'
        cities:
          type: array
          xml:
            wrapped: true
          items:
            $ref: '#/components/schemas/cityWithCountJson'
        tiers:
          type: array
          xml:
            wrapped: true
          items:
            $ref: '#/components/schemas/tiersJson'
        vendors:
          type: array
          xml:
            wrapped: true
          items:
            $ref: '#/components/schemas/vendorsJson'
    stateWithCountJson:
      type: object
      properties:
        state:
          type: string
        count:
          type: integer
    rateCenterWithCountJson:
      type: object
      properties:
        rateCenter:
          type: string
        count:
          type: integer
    cityWithCountJson:
      type: object
      properties:
        city:
          type: string
        count:
          type: integer
    tiersJson:
      type: object
      properties:
        tier:
          type: string
        count:
          type: integer
    vendorsJson:
      type: object
      properties:
        vendorName:
          type: string
        vendorId:
          type: integer
        count:
          type: integer
    tnOptionOrderReportSummaryResponse:
      type: object
      title: Summary Response
      properties:
        TnOptionOrderReportResponse:
          type: object
          properties:
            TnOptionOrders:
              type: object
              properties:
                TotalCount:
                  type: integer
                TnOptionOrderSummary:
                  $ref: '#/components/schemas/orderSummary'
    tnOptionOrderReportDetailedResponse:
      type: object
      title: Detailed Response
      properties:
        TnOptionOrderReportResponse:
          type: object
          properties:
            TnOptionOrders:
              type: object
              properties:
                TotalCount:
                  type: integer
                TnOptionOrder:
                  $ref: '#/components/schemas/tnOptionOrderResponsePayload'
    retrieveTnOptionOrderResponse:
      type: object
      title: Retrieve TN Options Order Response
      properties:
        TnOptionOrder:
          $ref: '#/components/schemas/tnOptionOrderResponsePayload'
    retrieveTnOptionOrderJsonResponse:
      type: object
      title: Retrieve TN Options Order Response
      $ref: '#/components/schemas/tnOptionOrderJsonResponsePayload'
    tnOptionOrderResponsePayload:
      type: object
      title: TnOptionOrder
      properties:
        OrderId:
          type: string
        AccountId:
          type: integer
          format: int32
        LastModifiedDate:
          type: string
        CreatedByUser:
          type: string
        CustomerOrderId:
          type: string
          description: >-
            The customer-defined reference ID for this order, if one was
            provided at creation. Not unique — Bandwidth applies no uniqueness
            constraint, so multiple orders may share the same value. Each order
            has a distinct Bandwidth-assigned `orderId`.
        OrderCreateDate:
          type: string
        ProcessingStatus:
          type: string
          enum:
            - RECEIVED
            - PROCESSING
            - COMPLETE
            - PARTIAL
            - FAILED
        TnOptionGroups:
          type: object
          properties:
            TnOptionGroup:
              $ref: '#/components/schemas/tnOptionGroupVcpDisabledXml'
        ErrorList:
          type: array
          items:
            $ref: '#/components/schemas/tnOptionOrderError'
        Warnings:
          type: array
          items:
            $ref: '#/components/schemas/tnOptionOrderWarningPayload'
    tnOptionOrderError:
      type: object
      title: Error
      properties:
        Code:
          type: integer
          format: int32
        Description:
          type: string
        TelephoneNumber:
          type: string
    tnOptionOrderWarningPayload:
      type: object
      title: Warning
      properties:
        TelephoneNumber:
          type: string
        Description:
          type: string
    tnOptionGroupVcpEnabledXml:
      type: object
      properties:
        PortOutPasscode:
          anyOf:
            - title: Custom Passcode
              type: string
              minLength: 4
              maxLength: 10
              pattern: ^[a-zA-Z0-9]+$
              description: |
                Custom alphanumeric value (4-10 chars).
            - title: Enum Values
              type: string
              enum:
                - UNCHANGED
                - SYSTEM_DEFAULT
        Protected:
          type: string
          enum:
            - 'true'
            - 'false'
            - UNCHANGED
            - SYSTEM_DEFAULT
        Sms:
          type: string
          enum:
            - 'ON'
            - 'OFF'
            - UNCHANGED
        A2pSettings:
          $ref: '#/components/schemas/a2pSettings'
        NNID:
          anyOf:
            - title: Custom Value
              type: string
              minLength: 1
              maxLength: 64
            - title: Enum Values
              type: string
              enum:
                - UNCHANGED
                - SYSTEM_DEFAULT
        TelephoneNumbers:
          type: array
          items:
            type: string
            description: 10-digit TN
            xml:
              name: TelephoneNumber
    tnOptionGroupVcpDisabledXml:
      type: object
      properties:
        NumberFormat:
          type: string
          enum:
            - 10DIGIT
            - 11DIGIT
            - E164
            - UNCHANGED
            - SYSTEM_DEFAULT
        RPIDFormat:
          type: string
          enum:
            - 10DIGIT
            - 11DIGIT
            - E164
            - UNCHANGED
            - SYSTEM_DEFAULT
        RewriteUser:
          anyOf:
            - type: string
              title: Enum Values
              enum:
                - UNCHANGED
                - SYSTEM_DEFAULT
            - type: string
              title: Custom Value
              description: >-
                This field must be a string up to 30 characters long, containing
                only letters (a-z, A-Z), digits (0-9),

                and the following symbols: +, @, :, ., (, ), _, ;, ?, =, -. No
                spaces or other special characters are allowed.
              pattern: ^[a-zA-Z0-9+@:.()_;?=-]{0,30}$
        CallForward:
          anyOf:
            - type: string
              title: Enum Values
              enum:
                - UNCHANGED
                - SYSTEM_DEFAULT
            - type: string
              title: Custom Value
              pattern: (\+1[2-9][0-9]{2}[2-9]{6}|[2-9][0-9]{5,17})
              description: >-
                This field must be a string representing a valid call forwarding
                number. It permits either:

                A US number in the format +1NXXNXXXXXX (where N is 2-9, X is
                0-9).

                A number with 6 to 18 digits, starting with a digit 2-9.
        CallingNameDisplay:
          type: string
          enum:
            - 'ON'
            - 'OFF'
            - UNCHANGED
            - SYSTEM_DEFAULT
        PortOutPasscode:
          anyOf:
            - title: Custom Passcode
              type: string
              minLength: 4
              maxLength: 10
              pattern: ^[a-zA-Z0-9]+$
              description: |
                Custom alphanumeric value (4-10 chars).
            - title: Enum Values
              type: string
              enum:
                - UNCHANGED
                - SYSTEM_DEFAULT
        Protected:
          type: string
          enum:
            - 'true'
            - 'false'
            - UNCHANGED
            - SYSTEM_DEFAULT
        Sms:
          type: string
          enum:
            - 'ON'
            - 'OFF'
            - UNCHANGED
            - SYSTEM_DEFAULT
        FinalDestinationURI:
          anyOf:
            - title: Custom Value
              type: string
              minLength: 10
              maxLength: 60
              description: >
                a 10 digit telephone number or a SIP URI ( without the sip:
                prefix ) in the form address-string@host IP:port, where the host
                IP is an IPv4 address in the standard numerical n.n.n.n. form,
                and the port is numeric, and optional containing [a-z,A-Z,0-9],
                with ':', '.' and '@' to delimit the components of the overall
                string, and less than 60 characters long.
            - title: Enum Values
              type: string
              enum:
                - UNCHANGED
                - SYSTEM_DEFAULT
        A2pSettings:
          $ref: '#/components/schemas/a2pSettings'
        NNID:
          anyOf:
            - title: Custom Value
              type: string
              minLength: 1
              maxLength: 64
            - title: Enum Values
              type: string
              enum:
                - UNCHANGED
                - SYSTEM_DEFAULT
        ESPID:
          anyOf:
            - title: Custom Value
              type: string
              minLength: 1
              maxLength: 64
            - title: Enum Values
              type: string
              enum:
                - UNCHANGED
                - SYSTEM_DEFAULT
        OriginationRoutePlan:
          $ref: '#/components/schemas/originationRoutePlan'
        PindropEnabled:
          type: string
          enum:
            - 'true'
            - 'false'
            - UNCHANGED
            - SYSTEM_DEFAULT
        CallVerificationEnabled:
          type: string
          enum:
            - 'true'
            - 'false'
        TelephoneNumbers:
          type: array
          items:
            type: string
            description: 10-digit TN
            xml:
              name: TelephoneNumber
    orderSummary:
      type: object
      properties:
        AccountId:
          type: integer
        UserId:
          type: string
        OrderId:
          type: string
        LastModifiedDate:
          type: string
        CountOfTNs:
          type: integer
        LastModifiedNote:
          $ref: '#/components/schemas/note'
        SuppCount:
          type: integer
        OrderType:
          type: string
        CustomerOrderId:
          type: string
          description: >-
            The customer-defined reference ID for this order, if one was
            provided at creation. Not unique — Bandwidth applies no uniqueness
            constraint, so multiple orders may share the same value. Each order
            has a distinct Bandwidth-assigned `orderId`.
        OrderDate:
          type: string
        OrderStatus:
          type: string
        TelephoneNumberDetails:
          $ref: '#/components/schemas/telephoneNumberDetails'
    tnOptionOrderReportErrorResponse:
      type: object
      title: TnOptionOrderReportResponse
      properties:
        TnOptionOrderReportResponse:
          $ref: '#/components/schemas/responseStatus'
    tnOptionOrderReportErrorResponseWithoutErrorCode:
      type: object
      title: TnOptionOrderReportResponseWithoutErrorCode
      properties:
        TnOptionOrderReportResponse:
          $ref: '#/components/schemas/responseStatusWithoutErrorCode'
    responseStatus:
      type: object
      title: ResponseStatus
      properties:
        ResponseStatus:
          $ref: '#/components/schemas/errorCodeAndDescription'
    responseStatusJson:
      type: object
      properties:
        errorCode:
          description: Numeric designation of corresponding error
          type: integer
        description:
          description: Detailed explanation about error
          type: string
    responseStatusWithoutErrorCode:
      type: object
      title: ResponseStatus
      properties:
        ResponseStatus:
          $ref: '#/components/schemas/description'
    description:
      type: object
      properties:
        Description:
          description: Detailed explanation about error
          type: string
    errorCodeAndDescription:
      type: object
      properties:
        ErrorCode:
          description: Numeric designation of corresponding error
          type: integer
        Description:
          description: 'Detailed explanation about error '
          type: string
    tnOptionOrderReportErrorResponseJson:
      type: object
      title: tnOptionOrderReportResponse
      properties:
        code:
          description: Numeric designation of corresponding error
          type: integer
        description:
          description: Detailed explanation about error
          type: string
    tnOptionOrderReportErrorResponseWithoutErrorCodeJson:
      type: object
      properties:
        description:
          description: Detailed explanation about error
          type: string
    getTnOptionOrderHistoryResponse:
      type: object
      properties:
        OrderHistoryWrapper:
          type: object
          properties:
            OrderHistory:
              $ref: '#/components/schemas/orderHistory'
    orderHistory:
      type: object
      properties:
        OrderDate:
          description: This is the date/time when the order history entry was created.
          type: string
        Note:
          description: This is the order note that accompanied the order history entry.
          type: string
        Author:
          description: >-
            This is the user that initiated the event that caused the order
            history to be updated.
          type: string
        Difference:
          description: SUPP changes difference.
          type: string
        Status:
          description: >-
            This is the state that the order was in when the order history event
            occurred.
          type: string
    orderHistoryJson:
      type: object
      properties:
        orderHistory:
          type: array
          items:
            $ref: '#/components/schemas/orderHistoryEntryJson'
    orderHistoryEntryJson:
      type: object
      properties:
        orderDate:
          description: This is the date/time when the order history entry was created.
          type: string
          format: date-time
        note:
          description: This is the order note that accompanied the order history entry.
          type: string
        author:
          description: >-
            This is the user that initiated the event that caused the order
            history to be updated.
          type: string
        difference:
          description: SUPP changes difference.
          type: string
        status:
          $ref: '#/components/schemas/processingStatus'
    processingStatus:
      type: string
      description: >-
        This is the state that the order was in when the order history event
        occurred.
      enum:
        - RECEIVED
        - PROCESSING
        - PARTIAL
        - COMPLETE
        - FAILED
    originationRoutePlan:
      type: object
      description: >-
        The OriginationRoutePlan element consists of an action and a list of
        prioritized and weighted routes that tell Bandwidth where to send phone
        calls to phone numbers associated with the route plan.
      properties:
        Id:
          type: string
          format: uuid
        Route:
          type: array
          items:
            $ref: '#/components/schemas/originationRoutePayload'
        Action:
          type: string
          enum:
            - UNCHANGED
            - 'OFF'
            - AS_SPECIFIED
    originationRoutePayload:
      type: object
      properties:
        Name:
          description: >-
            A friendly name for a route.  This is not used for any back-end call
            routing.
          type: string
        Endpoint:
          type: string
          description: >
            Must be one of the following: - a NANP 10-digit telephone number - a
            SIP URI - an IPv4 address - a Fully Qualified Domain Name (FQDN)
        Priority:
          type: integer
          format: int32
        Weight:
          type: integer
          format: int32
        EndpointType:
          type: string
          enum:
            - TN
            - IPv4
            - SIP
            - FQDN
    a2pSettings:
      type: object
      properties:
        CampaignId:
          type: string
          minLength: 1
          maxLength: 64
        Action:
          type: string
          enum:
            - UNCHANGED
            - SYSTEM_DEFAULT
            - 'OFF'
            - DELETE
            - AS_SPECIFIED
    tnOptionOrderXmlRequestVcpEnabled:
      type: object
      title: VCP Enabled TN Options Order Request
      properties:
        TnOptionOrder:
          $ref: '#/components/schemas/tnOptionOrderXmlPayloadVcpEnabled'
    tnOptionOrderXmlPayloadVcpEnabled:
      type: object
      title: TnOptionOrder
      properties:
        CustomerOrderId:
          type: string
          description: >-
            Optional customer-defined reference ID for this order. Only
            alphanumeric values, dashes and spaces are allowed. Not unique —
            Bandwidth applies no uniqueness constraint, so multiple orders may
            share the same value. Each order receives its own unique
            Bandwidth-assigned `orderId`.
          maxLength: 255
        TnOptionGroups:
          description: >-
            Each group contains list of telephone numbers and set of TN options
            you want to assign to all TNs in the list
          type: object
          properties:
            TnOptionGroup:
              $ref: '#/components/schemas/tnOptionGroupVcpEnabledXml'
    tnOptionOrderXmlRequestVcpDisabled:
      type: object
      title: VCP Disabled TN Options Order Request
      properties:
        TnOptionOrder:
          $ref: '#/components/schemas/tnOptionOrderXmlPayloadVcpDisabled'
    tnOptionOrderXmlPayloadVcpDisabled:
      type: object
      title: TnOptionOrder
      properties:
        CustomerOrderId:
          type: string
          description: >-
            Optional customer-defined reference ID for this order. Only
            alphanumeric values, dashes and spaces are allowed. Not unique —
            Bandwidth applies no uniqueness constraint, so multiple orders may
            share the same value. Each order receives its own unique
            Bandwidth-assigned `orderId`.
          maxLength: 255
        TnOptionGroups:
          description: >-
            Each group contains list of telephone numbers and set of TN options
            you want to assign to all TNs in the list.
          type: object
          properties:
            TnOptionGroup:
              $ref: '#/components/schemas/tnOptionGroupVcpDisabledXml'
    tnOptionOrderResponse:
      type: object
      properties:
        TnOptionOrderResponse:
          type: object
          properties:
            TnOptionOrder:
              $ref: '#/components/schemas/tnOptionOrderResponsePayload'
    tnOptionOrderErrorResponse:
      type: object
      properties:
        TnOptionOrderResponse:
          $ref: '#/components/schemas/responseStatus'
    genericError:
      title: Generic Error
      type: object
      properties:
        data:
          type: object
          nullable: true
        errors:
          type: array
          items:
            $ref: '#/components/schemas/error'
        links:
          type: array
          items:
            $ref: '#/components/schemas/link'
      required:
        - data
        - errors
        - links
    error:
      title: Error
      type: object
      properties:
        id:
          type: string
          description: A unique identifier for this particular instance of this problem
          example: optional-error-id
        type:
          $ref: '#/components/schemas/errorType'
        description:
          $ref: '#/components/schemas/errorDescription'
        code:
          $ref: '#/components/schemas/code'
        meta:
          type: object
          description: >-
            A meta object containing application-specific information or
            non-standard metadata about the error
        source:
          $ref: '#/components/schemas/errorSource'
      required:
        - code
        - description
    link:
      title: Link
      description: The URI link details to self or a related resource with the relation
      type: object
      properties:
        href:
          type: string
          description: URI of the link
          example: /resource/uri
        rel:
          type: string
          description: Specifies the relationship between this link and the resource
          example: self
        method:
          type: string
          description: HTTP method to be used
          example: GET
      required:
        - href
        - rel
        - method
    code:
      type: integer
      format: int32
      description: >-
        An application-specific error code for services with extensive error
        scenarios to supplement `description`
      minimum: 4
      example: 51130
    errorDescription:
      type: string
      description: >-
        A human-readable explanation that SHOULD be specific to this occurrence
        of the problem
      example: There was an issue with a field in your request body
    errorType:
      type: string
      description: >-
        A short, human-readable summary of the problem that SHOULD NOT change
        from occurrence to occurrence of the problem
      example: REQUEST_ERROR
    errorSource:
      title: Error Source
      type: object
      properties:
        parameter:
          type: string
          description: A string indicating which URI query parameter caused the error
          example: someParameter
        field:
          type: string
          description: A string indicating which request body field caused the error
          example: someField
        header:
          type: string
          description: A string indicating which header field caused the error
          example: someHeader
        reference:
          type: string
          description: >-
            A string that references a resource ID or path to the resource (or
            non-existent resource) causing the error
          example: /some/reference
    jsonLidbOrderHistoryResponse:
      properties:
        totalCount:
          type: integer
        orders:
          items:
            $ref: '#/components/schemas/jsonOrderSummary'
          type: array
      type: object
    jsonOrderSummary:
      properties:
        accountId:
          type: integer
        phoneNumberCount:
          type: integer
        userId:
          type: string
        lastModifiedDate:
          type: string
          format: date-time
        orderDate:
          type: string
          format: date-time
        orderId:
          type: string
        orderStatus:
          type: string
      type: object
    lidbOrderHistoryResponse:
      properties:
        ResponseSelectWrapper:
          properties:
            ListOrderIdUserIdDate:
              properties:
                OrderIdUserIdDate:
                  items:
                    $ref: '#/components/schemas/orderSummary'
                  type: array
                TotalCount:
                  type: integer
              type: object
          type: object
      type: object
    jsonLidbOrderResponse:
      properties:
        lidbOrderResponse:
          $ref: '#/components/schemas/jsonLidbOrderResponsePayload'
      type: object
    jsonLidbOrderResponsePayload:
      type: object
      properties:
        orderId:
          type: string
        customerOrderId:
          description: >-
            Optional customer-defined reference ID for this order. Only
            alphanumeric values, dashes and spaces are allowed. Not unique —
            Bandwidth applies no uniqueness constraint, so multiple orders may
            share the same value. Each order receives its own unique
            Bandwidth-assigned `orderId`.
          maxLength: 255
          type: string
        processingStatus:
          description: Order status.
          enum:
            - RECEIVED
            - PROCESSING
            - COMPLETE
            - PARTIAL
            - FAILED
          type: string
        errors:
          type: array
          items:
            $ref: '#/components/schemas/jsonLidbOrderError'
        lidbPhoneNumberGroups:
          type: array
          items:
            $ref: '#/components/schemas/jsonLidbDetailTnGroup'
    jsonLidbOrderError:
      properties:
        code:
          format: int32
          type: integer
        description:
          type: string
        phoneNumber:
          type: string
      title: Error
      type: object
    jsonLidbDetailTnGroup:
      properties:
        phoneNumbers:
          description: >-
            A list of phone numbers that will all assume the
            SubscriberInformation that is listed in the payload. In an
            enterprise context it is not uncommon for all of the served
            telephone numbers to use the same string for the Subscriber
            Information.
          items:
            $ref: '#/components/schemas/jsonPhoneNumber'
          type: array
        subscriberInformation:
          description: >-
            This is the field that is displayed to the user receiving the phone
            call from the Telephone numbers in the TelephoneNumberList
          type: string
        useType:
          enum:
            - BUSINESS
            - RESIDENTIAL
          type: string
        visibility:
          description: ' If it is tagged as PRIVATE then the data will be provided, but the display will not be provided on a standard phone call.'
          enum:
            - PUBLIC
            - PRIVATE
          type: string
      required:
        - useType
        - visibility
      title: LidbPhoneNumberGroup
      type: object
    jsonPhoneNumber:
      properties:
        phoneNumber:
          description: Phone Number in E.164 format.
          type: string
      type: object
    lidbOrderResponse:
      properties:
        LidbOrderResponse:
          $ref: '#/components/schemas/lidbOrderResponsePayload'
    lidbOrderResponsePayload:
      properties:
        LidbOrder:
          properties:
            OrderId:
              type: string
            CustomerOrderId:
              description: >-
                The Customer Order ID is an ID assigned by the account owner to
                provide a reference number for the Order. The element is
                optional. Only alphanumeric values, dashes and spaces are
                allowed.
              maxLength: 255
              type: string
            ProcessingStatus:
              type: string
            ErrorList:
              items:
                $ref: '#/components/schemas/lidbOrderError'
              type: array
            LidbTnGroups:
              items:
                $ref: '#/components/schemas/lidbDetailTnGroup'
              type: array
          type: object
      type: object
    lidbOrderPayload:
      properties:
        CustomerOrderId:
          description: >-
            Optional customer-defined reference ID for this order. Only
            alphanumeric values, dashes and spaces are allowed. Not unique —
            Bandwidth applies no uniqueness constraint, so multiple orders may
            share the same value. Each order receives its own unique
            Bandwidth-assigned `orderId`.
          maxLength: 255
          type: string
        LidbTnGroups:
          items:
            $ref: '#/components/schemas/lidbDetailTnGroup'
          type: array
      type: object
    lidbOrderError:
      properties:
        Code:
          format: int32
          type: integer
        Description:
          type: string
        TelephoneNumber:
          type: string
      title: Error
      type: object
    lidbDetailTnGroup:
      properties:
        TelephoneNumbers:
          description: >-
            A list of telephone numbers that will all assume the
            SubscriberInformation that is listed in the payload. In an
            enterprise context it is not uncommon for all of the served
            telephone numbers to use the same string for the Subscriber
            Information.
          items:
            $ref: '#/components/schemas/telephoneNumber'
          type: array
        SubscriberInformation:
          description: >-
            This is the field that is displayed to the user receiving the phone
            call from the Telephone numbers in the TelephoneNumberList
          type: string
        UseType:
          enum:
            - BUSINESS
            - RESIDENTIAL
          type: string
        Visibility:
          description: ' If it is tagged as PRIVATE then the data will be provided, but the display will not be provided on a standard phone call.'
          enum:
            - PUBLIC
            - PRIVATE
          type: string
      required:
        - UseType
        - Visibility
      title: LidbTnGroup
      type: object
    telephoneNumber:
      properties:
        TelephoneNumber:
          description: Simple Telephone Number.
          type: string
      type: object
    lidbOrder:
      properties:
        LidbOrder:
          $ref: '#/components/schemas/lidbOrderPayload'
      type: object
    jsonLidbOrder:
      properties:
        lidbOrder:
          $ref: '#/components/schemas/jsonLidbOrderPayload'
      type: object
    jsonLidbOrderPayload:
      properties:
        customerOrderId:
          description: >-
            Optional customer-defined reference ID for this order. Only
            alphanumeric values, dashes and spaces are allowed. Not unique —
            Bandwidth applies no uniqueness constraint, so multiple orders may
            share the same value. Each order receives its own unique
            Bandwidth-assigned `orderId`.
          maxLength: 255
          type: string
        lidbPhoneNumberGroups:
          items:
            $ref: '#/components/schemas/jsonLidbDetailTnGroup'
          type: array
      type: object
    jsonLidbOrderReportErrorResponse:
      properties:
        description:
          description: Detailed explanation about error
          type: string
        errorCode:
          description: Numeric designation of corresponding error
          type: integer
    lidbOrderReportErrorResponse:
      properties:
        LidbOrderReportResponse:
          $ref: '#/components/schemas/responseStatus'
      type: object
    responseSelectWrapper:
      properties:
        ResponseSelectWrapper:
          properties:
            ListOrderIdUserIdDate:
              properties:
                Links:
                  $ref: '#/components/schemas/links'
                OrderIdUserIdDate:
                  items:
                    $ref: '#/components/schemas/orderIdUserIdDate'
                  type: array
                TotalCount:
                  type: integer
              type: object
          type: object
      type: object
    responseSelectWrapperJson:
      properties:
        totalCount:
          type: integer
        links:
          $ref: '#/components/schemas/linksJson'
        orders:
          items:
            $ref: '#/components/schemas/orderIdUserIdDateJson'
          type: array
      type: object
    links:
      items:
        oneOf:
          - $ref: '#/components/schemas/selfLink'
      title: Links
      type: array
    linksJson:
      properties:
        first:
          description: The first (or only) page of results matching the query.
          type: string
        last:
          description: >-
            If more results exist than specified by 'size', this link return the
            last page of result.
          type: string
        next:
          description: >-
            If more results exist than specified by 'size', this link returns
            the next page of 'size' results.
          type: string
        previous:
          description: >-
            If the results are more than one page, this link returns the
            previous page of 'size' results.
          type: string
      type: object
    selfLink:
      properties:
        href:
          description: URI of the link
          example: /self/uri
          type: string
        method:
          description: HTTP method to be used
          example: GET
          type: string
        rel:
          description: Specifies the relationship between this link and the resource.
          example: SelfResource
          type: string
      title: Self Link
      type: object
    orderIdUserIdDate:
      properties:
        CountOfTNs:
          type: integer
        OrderDate:
          type: string
        OrderStatus:
          type: string
        OrderType:
          type: string
        TelephoneNumberDetails:
          $ref: '#/components/schemas/telephoneNumberDetails'
        lastModifiedDate:
          format: date-time
          type: string
        orderId:
          type: string
        userId:
          type: string
      type: object
    orderIdUserIdDateJson:
      properties:
        phoneNumberCount:
          type: integer
        userId:
          type: string
        lastModifiedDate:
          format: date-time
          type: string
        orderType:
          type: string
        orderDate:
          format: date-time
          type: string
        orderId:
          type: string
        orderStatus:
          type: string
        phoneNumberDetails:
          $ref: '#/components/schemas/telephoneNumberDetailsJson'
      type: object
    telephoneNumberDetailsJson:
      properties:
        cities:
          items:
            $ref: '#/components/schemas/cityWithCountJson'
          type: array
        rateCenters:
          items:
            $ref: '#/components/schemas/rateCenterWithCountJson'
          type: array
        states:
          items:
            $ref: '#/components/schemas/stateWithCountJson'
          type: array
        tiers:
          items:
            $ref: '#/components/schemas/tiersJson'
          type: array
        vendors:
          items:
            $ref: '#/components/schemas/vendorsJson'
          type: array
      type: object
    jsonLidbOrderErrorResponse:
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/jsonLidbOrderError'
        lidbOrder:
          $ref: '#/components/schemas/jsonLidbOrderPayload'
        status:
          properties:
            code:
              description: Numeric designation of corresponding error
              type: integer
            description:
              description: Detailed explanation about error
              type: string
          type: object
      type: object
    lidbOrderErrorResponse:
      properties:
        LidbOrderResponse:
          properties:
            ErrorList:
              items:
                $ref: '#/components/schemas/lidbOrderError'
              type: array
            LidbOrder:
              $ref: '#/components/schemas/lidbOrderPayload'
            Status:
              properties:
                Code:
                  description: Numeric designation of corresponding error
                  type: integer
                Description:
                  description: 'Detailed explanation about error '
                  type: string
              type: object
          type: object
      type: object
    dldaOrder:
      properties:
        DldaOrder:
          $ref: '#/components/schemas/dldaOrderPayload'
      type: object
    jsonDldaOrder:
      properties:
        customerOrderId:
          description: >-
            The Customer Order ID is an ID assigned by the account owner to
            provide a reference number for the Order. Only alphanumeric values,
            dashes and spaces are allowed.
          maxLength: 255
          type: string
        deleteDldaPhoneNumberGroups:
          type: string
        dldaPhoneNumberGroups:
          items:
            $ref: '#/components/schemas/jsonDldaPhoneNumberGroup'
          type: array
      type: object
    dldaOrderPayload:
      properties:
        CustomerOrderId:
          description: >-
            The Customer Order ID is an ID assigned by the account owner to
            provide a reference number for the Order. Only alphanumeric values,
            dashes and spaces are allowed.
          maxLength: 255
          type: string
        DeleteDldaTnGroups:
          type: string
        DldaTnGroups:
          items:
            $ref: '#/components/schemas/dldaTnGroup'
          type: array
      type: object
    dldaTnGroup:
      description: AddressType has to be DLDA
      properties:
        Address:
          $ref: '#/components/schemas/address'
        ListAddress:
          type: boolean
        ListingName:
          $ref: '#/components/schemas/dldaListingName'
        ListingType:
          enum:
            - LISTED
            - NON_LISTED
            - NON_PUBLISHED
          type: string
        SubscriberType:
          enum:
            - RESIDENTIAL
            - BUSINESS
          type: string
        TelephoneNumbers:
          description: >-
            A list of telephone numbers you need to bind information from
            payload
          items:
            type: string
            xml:
              name: TelephoneNumber
          type: array
      required:
        - SubscriberType
        - ListingType
        - ListAddress
      type: object
    dldaListingName:
      properties:
        Designation:
          type: string
        FirstName:
          description: Required in case RESIDENTIAL SubscriberType is chosen
          type: string
        FirstName2:
          description: ''
          type: string
        LastName:
          type: string
        PlaceListingAs:
          type: string
        TitleOfAddress:
          type: string
        TitleOfAddress2:
          type: string
        TitleOfAddress2Name2:
          type: string
        TitleOfAddressName2:
          type: string
        TitleOfLineage:
          type: string
        TitleOfLineageName2:
          type: string
      required:
        - LastName
      type: object
    jsonDldaListingName:
      properties:
        designation:
          type: string
        firstName:
          description: Required in case RESIDENTIAL SubscriberType is chosen
          type: string
        firstName2:
          description: ''
          type: string
        lastName:
          type: string
        placeListingAs:
          type: string
        titleOfAddress:
          type: string
        titleOfAddress2:
          type: string
        titleOfAddress2Name2:
          type: string
        titleOfAddressName2:
          type: string
        titleOfLineage:
          type: string
        titleOfLineageName2:
          type: string
      required:
        - LastName
      type: object
    addressType:
      enum:
        - SERVICE
        - BILLING
        - DLDA
        - E911
      type: string
    jsonAddressType:
      enum:
        - SERVICE
        - BILLING
        - DLDA
        - E911
      type: string
    address:
      properties:
        AddressLine2:
          description: >-
            AddressLine2 is used to specify Unit, Suite, Floor, etc. in the
            Service Address. AddressLine2 is optional when not needed to fully
            specify the ServiceAddress.
          type: string
        AddressType:
          $ref: '#/components/schemas/addressType'
        City:
          description: City is mandatory in cases where the ServiceAddress is mandatory.
          type: string
        Country:
          description: >-
            Country is the country of the ServiceAddress. This value will be
            derived from the StateCode, so it should generally be omitted.
          type: string
        County:
          description: The county where the subscriber or business is located.
          type: string
        HouseNumber:
          description: >-
            The HouseNumber is the street address number of the ServiceAddress.
            HouseNumber is mandatory for port-in orders in which the
            ServiceAddress is mandatory.
          type: string
        HousePrefix:
          description: >-
            The HousePrefix is the non-numeric address number prefix of the
            ServiceAddress. This element is optional when not needed to fully
            specify the ServiceAddress.
          type: string
        HouseSuffix:
          description: >-
            The HouseSuffix is the non-numeric address number suffix of the
            ServiceAddress. This element is optional when not needed to fully
            specify the ServiceAddress.
          type: string
        Latitude:
          type: string
        Longitude:
          type: string
        PlusFour:
          description: >-
            PlusFour is the 4 digits that are sometimes suffixed to the Zip
            Code.
          type: string
        PostDirectional:
          description: >-
            The PostDirectional is the street name post directional of the
            ServiceAddress. This element is optional when not needed to fully
            specify the ServiceAddress.
          type: string
        PreDirectional:
          description: >-
            The PreDirectional is the non-numeric street name prefix of the
            ServiceAddress. This element is optional when not needed to fully
            specify the ServiceAddress.
          type: string
        ResetAddressFields:
          type: boolean
        StateCode:
          description: >-
            StateCode is the 2-letter abbreviation of the state of the
            ServiceAddress. StateCode is mandatory in cases where the
            ServiceAddress is mandatory.
          type: string
        StreetName:
          description: >-
            The StreetName is mandatory in cases where the ServiceAddress is
            mandatory.
          type: string
        StreetSuffix:
          description: >-
            The StreetSuffix is the street suffix of the ServiceAddress. This
            element is optional when not needed to fully specify the
            ServiceAddress.
          type: string
        Zip:
          description: >-
            Zip is the Zip Code of the ServiceAddress. Zip is mandatory in cases
            where the ServiceAddress is mandatory.
          type: string
      type: object
    jsonAddress:
      properties:
        addressLine2:
          description: >-
            AddressLine2 is used to specify Unit, Suite, Floor, etc. in the
            Service Address. AddressLine2 is optional when not needed to fully
            specify the ServiceAddress.
          type: string
        addressType:
          $ref: '#/components/schemas/jsonAddressType'
        city:
          description: City is mandatory in cases where the ServiceAddress is mandatory.
          type: string
        country:
          description: >-
            Country is the country of the ServiceAddress. This value will be
            derived from the StateCode, so it should generally be omitted.
          type: string
        county:
          description: The county where the subscriber or business is located.
          type: string
        houseNumber:
          description: >-
            The HouseNumber is the street address number of the ServiceAddress.
            HouseNumber is mandatory for port-in orders in which the
            ServiceAddress is mandatory.
          type: string
        housePrefix:
          description: >-
            The HousePrefix is the non-numeric address number prefix of the
            ServiceAddress. This element is optional when not needed to fully
            specify the ServiceAddress.
          type: string
        houseSuffix:
          description: >-
            The HouseSuffix is the non-numeric address number suffix of the
            ServiceAddress. This element is optional when not needed to fully
            specify the ServiceAddress.
          type: string
        latitude:
          type: string
        longitude:
          type: string
        plusFour:
          description: >-
            PlusFour is the 4 digits that are sometimes suffixed to the Zip
            Code.
          type: string
        postDirectional:
          description: >-
            The PostDirectional is the street name post directional of the
            ServiceAddress. This element is optional when not needed to fully
            specify the ServiceAddress.
          type: string
        preDirectional:
          description: >-
            The PreDirectional is the non-numeric street name prefix of the
            ServiceAddress. This element is optional when not needed to fully
            specify the ServiceAddress.
          type: string
        resetAddressFields:
          type: boolean
        stateCode:
          description: >-
            StateCode is the 2-letter abbreviation of the state of the
            ServiceAddress. StateCode is mandatory in cases where the
            ServiceAddress is mandatory.
          type: string
        streetName:
          description: >-
            The StreetName is mandatory in cases where the ServiceAddress is
            mandatory.
          type: string
        streetSuffix:
          description: >-
            The StreetSuffix is the street suffix of the ServiceAddress. This
            element is optional when not needed to fully specify the
            ServiceAddress.
          type: string
        zip:
          description: >-
            Zip is the Zip Code of the ServiceAddress. Zip is mandatory in cases
            where the ServiceAddress is mandatory.
          type: string
      type: object
    dldaOrderResponse:
      properties:
        DldaOrderResponse:
          properties:
            DldaOrder:
              $ref: '#/components/schemas/dldaOrderResponsePayload'
          type: object
      type: object
    jsonDldaOrderResponse:
      properties:
        dldaOrderResponse:
          properties:
            dldaOrder:
              $ref: '#/components/schemas/jsonDldaOrderResponsePayload'
          type: object
      type: object
    dldaOrderResponsePayload:
      properties:
        AccountId:
          type: integer
        CreatedByUser:
          type: string
        CustomerOrderId:
          description: >-
            The Customer Order ID is an ID assigned by the account owner to
            provide a reference number for the Order. Only alphanumeric values,
            dashes and spaces are allowed.
          maxLength: 255
          type: string
        DldaTnGroups:
          items:
            $ref: '#/components/schemas/dldaTnGroup'
          type: array
        ErrorList:
          type: array
          items:
            properties:
              Error:
                type: object
                properties:
                  Code:
                    type: integer
                    format: int32
                  TelephoneNumber:
                    type: string
                  Description:
                    type: string
        LastModifiedDate:
          format: date-time
          type: string
        OrderCreateDate:
          type: string
        OrderId:
          type: string
        ProcessingStatus:
          type: string
      type: object
    jsonDldaOrderResponsePayload:
      properties:
        customerOrderId:
          description: >-
            The Customer Order ID is an ID assigned by the account owner to
            provide a reference number for the Order. Only alphanumeric values,
            dashes and spaces are allowed.
          maxLength: 255
          type: string
        orderCreateDate:
          type: string
        accountId:
          type: integer
        createdByUser:
          type: string
        orderId:
          type: string
        lastModifiedDate:
          format: date-time
          type: string
        errors:
          type: array
          items:
            properties:
              error:
                type: object
                properties:
                  phoneNumber:
                    type: string
                  code:
                    type: integer
                    format: int32
                  description:
                    type: string
        processingStatus:
          description: Order status.
          enum:
            - RECEIVED
            - PROCESSING
            - COMPLETE
            - PARTIAL
            - FAILED
          type: string
        dldaPhoneNumberGroups:
          items:
            $ref: '#/components/schemas/jsonDldaPhoneNumberGroup'
          type: array
      type: object
    jsonDldaPhoneNumberGroup:
      description: AddressType has to be DLDA
      properties:
        phoneNumbers:
          description: A list of phone numbers you need to bind information from payload
          items:
            type: string
            xml:
              name: phoneNumber
          type: array
        subscriberType:
          enum:
            - RESIDENTIAL
            - BUSINESS
          type: string
        listingType:
          enum:
            - LISTED
            - NON_LISTED
            - NON_PUBLISHED
          type: string
        listingName:
          $ref: '#/components/schemas/jsonDldaListingName'
        listAddress:
          type: boolean
        address:
          $ref: '#/components/schemas/jsonAddress'
    dldaOrderErrorResponse:
      type: object
      properties:
        DldaOrderResponse:
          type: object
          properties:
            DldaOrder:
              $ref: '#/components/schemas/dldaOrderResponsePayload'
            ResponseStatus:
              $ref: '#/components/schemas/responseStatus'
    jsonDldaOrderErrorResponse:
      type: object
      properties:
        errorCode:
          description: Numeric designation of corresponding error
          type: integer
        description:
          description: Detailed explanation about error
          type: string
        dldaOrder:
          $ref: '#/components/schemas/jsonDldaOrderResponsePayload'
    dldaOrderErrorNotFoundResponse:
      properties:
        DldaOrderResponse:
          $ref: '#/components/schemas/responseStatus'
      type: object
    jsonDldaOrderErrorNotFoundResponse:
      properties:
        dldaOrderResponse:
          $ref: '#/components/schemas/responseStatusJson'
      type: object
    dldaOrderReportErrorResponse:
      properties:
        DldaOrderReportResponse:
          $ref: '#/components/schemas/responseStatus'
      type: object
    jsonDldaOrderReportErrorResponse:
      properties:
        dldaOrderReportResponse:
          $ref: '#/components/schemas/responseStatusJson'
      type: object
    orderHistoryWrapper:
      properties:
        OrderHistoryWrapper:
          properties:
            OrderHistory:
              $ref: '#/components/schemas/orderHistory'
          type: object
      type: object
    jsonOrderHistoryWrapper:
      properties:
        orderHistory:
          type: object
          properties:
            orderDate:
              description: This is the date/time when the order history entry was created.
              format: date-time
              type: string
            note:
              description: This is the order note that accompanied the order history entry.
              type: string
            author:
              description: >-
                This is the user that initiated the event that caused the order
                history to be updated.
              type: string
            status:
              description: >-
                This is the state that the order was in when the order history
                event occurred.
              type: string
      type: object
  requestBodies:
    tnOptionOrderRequest:
      content:
        application/xml:
          schema:
            anyOf:
              - $ref: '#/components/schemas/tnOptionOrderXmlRequestVcpDisabled'
              - $ref: '#/components/schemas/tnOptionOrderXmlRequestVcpEnabled'
          examples:
            createTnOptionOrderXmlRequestExampleVcpDisabled:
              $ref: >-
                #/components/examples/createTnOptionOrderXmlRequestExampleVcpDisabled
            createTnOptionOrderXmlRequestExampleVcpEnabled:
              $ref: >-
                #/components/examples/createTnOptionOrderXmlRequestExampleVcpEnabled
        application/json:
          schema:
            anyOf:
              - $ref: '#/components/schemas/tnOptionOrderJsonRequestVcpDisabled'
              - $ref: '#/components/schemas/tnOptionOrderJsonRequestVcpEnabled'
          examples:
            createTnOptionJsonRequestExampleVcpDisabled:
              $ref: >-
                #/components/examples/createTnOptionJsonRequestExampleVcpDisabled
            createTnOptionJsonRequestExampleVcpEnabled:
              $ref: '#/components/examples/createTnOptionJsonRequestExampleVcpEnabled'
    lidbOrderRequest:
      content:
        application/xml:
          examples:
            lidbOrderPostXmlPayloadExample:
              $ref: '#/components/examples/lidbOrderPostXmlPayloadExample'
          schema:
            $ref: '#/components/schemas/lidbOrder'
        application/json:
          examples:
            lidbOrderPostJsonPayloadExample:
              $ref: '#/components/examples/lidbOrderPostJsonPayloadExample'
          schema:
            $ref: '#/components/schemas/jsonLidbOrder'
    dldaCreateOrderRequest:
      content:
        application/xml:
          examples:
            dldaOrderPostXmlPayloadExample:
              $ref: '#/components/examples/dldaOrderPostXmlPayloadExample'
          schema:
            $ref: '#/components/schemas/dldaOrder'
        application/json:
          examples:
            dldaOrderPostJsonPayloadExample:
              $ref: '#/components/examples/dldaOrderPostJsonPayloadExample'
          schema:
            $ref: '#/components/schemas/jsonDldaOrder'
    dldaUpdateOrderRequest:
      content:
        application/xml:
          examples:
            dldaOrderUpdateXmlPayloadExample:
              $ref: '#/components/examples/dldaOrderUpdateXmlPayloadExample'
          schema:
            $ref: '#/components/schemas/dldaOrder'
        application/json:
          examples:
            dldaOrderUpdateJsonPayloadExample:
              $ref: '#/components/examples/dldaOrderUpdateJsonPayloadExample'
          schema:
            $ref: '#/components/schemas/jsonDldaOrder'
  responses:
    tnOptionOrderCreatedResponse:
      description: Created
      content:
        application/xml:
          schema:
            $ref: '#/components/schemas/tnOptionOrderResponse'
          examples:
            createTnOptionXmlResponseExample:
              $ref: '#/components/examples/createTnOptionXmlResponseExample'
        application/json:
          schema:
            $ref: '#/components/schemas/tnOptionOrderJsonResponse'
          examples:
            createTnOptionJsonResponseExample:
              $ref: '#/components/examples/createTnOptionJsonResponseExample'
    tnOptionOrder400Response:
      description: Bad Request
      content:
        application/xml:
          schema:
            $ref: '#/components/schemas/tnOptionOrderErrorResponse'
          examples:
            createTnOptionXmlErrorResponseExample:
              $ref: '#/components/examples/createTnOptionXmlErrorResponseExample'
        application/json:
          schema:
            $ref: '#/components/schemas/tnOptionOrderErrorResponseJson'
          examples:
            createTnOptionJsonErrorResponseExample:
              $ref: '#/components/examples/createTnOptionJsonErrorResponseExample'
    getTnOptionOrdersSummaryResponse:
      description: >
        The descriptive payload for the TN Options orders query provides a broad
        range of information about the TN Options

        orders found by the query, including the data associated with the order,
        the state of the order, and details

        about the order if it was successful.
      content:
        application/xml:
          schema:
            anyOf:
              - $ref: '#/components/schemas/tnOptionOrderReportSummaryResponse'
              - $ref: '#/components/schemas/tnOptionOrderReportDetailedResponse'
          examples:
            TnOptionOrderReportSummaryResponseExample:
              $ref: >-
                #/components/examples/getTnOptionOrderReportSummaryResponseXmlExample
            TnOptionOrderReportDetailedResponseExample:
              $ref: >-
                #/components/examples/getTnOptionOrderReportDetailedResponseXmlExample
        application/json:
          schema:
            anyOf:
              - $ref: '#/components/schemas/tnOptionOrderReportSummaryJsonResponse'
              - $ref: '#/components/schemas/tnOptionOrderReportDetailedJsonResponse'
          examples:
            tnOptionOrderReportSummaryResponseExample:
              $ref: >-
                #/components/examples/getTnOptionOrderReportSummaryJsonResponseExample
            tnOptionOrderReportDetailedResponseExample:
              $ref: >-
                #/components/examples/getTnOptionOrderReportDetailedJsonResponseExample
    getTnOptionOrders400Response:
      description: Bad Request
      content:
        application/xml:
          schema:
            $ref: '#/components/schemas/tnOptionOrderReportErrorResponse'
          examples:
            getTnOptionOrders400ResponseExample:
              $ref: '#/components/examples/getTnOptionOrders400ResponseExample'
        application/json:
          schema:
            $ref: '#/components/schemas/tnOptionOrderReportErrorResponseJson'
          examples:
            getTnOptionOrders400JsonResponseExample:
              $ref: '#/components/examples/getTnOptionOrders400JsonResponseExample'
    getTnOptionOrderResponse:
      description: >
        The descriptive payload for the TN Options orders query provides a broad
        range of information about the TN Options

        order identified in the URL. Included amongst the information is:


        - **ErrorList**: The errors discovered with codes and explanations.

        - **Warnings**: The warnings discovered with explanations.

        - **ProcessingStatus** (`RECEIVED`, `PROCESSING`, `COMPLETE`, `PARTIAL`,
        `FAILED`): The overall status of the order.
      content:
        application/xml:
          schema:
            $ref: '#/components/schemas/retrieveTnOptionOrderResponse'
          examples:
            getTnOptionOrderDetailedResponseExample:
              $ref: '#/components/examples/retrieveTnOptionOrderResponseXmlExample'
        application/json:
          schema:
            $ref: '#/components/schemas/retrieveTnOptionOrderJsonResponse'
          examples:
            getTnOptionOrderDetailedJsonResponseExample:
              $ref: '#/components/examples/retrieveTnOptionOrderJsonResponseExample'
    getTnOptionOrder400Response:
      description: Bad Request
      content:
        application/xml:
          schema:
            $ref: '#/components/schemas/tnOptionOrderReportErrorResponse'
          examples:
            getTnOptionOrder400ResponseExample:
              $ref: '#/components/examples/getTnOptionOrder400ResponseExample'
        application/json:
          schema:
            $ref: '#/components/schemas/tnOptionOrderReportErrorResponseJson'
          examples:
            getTnOptionOrder400ResponseJsonExample:
              $ref: '#/components/examples/getTnOptionOrder400ResponseJsonExample'
    getTnOptionOrderHistory200Response:
      description: >
        The history payload is a set of history records. Each record contains:


        - **OrderDate**: The date that the order history event happened.

        - **Status**: The new state of the TN Options order (`RECEIVED`,
        `PROCESSING`, `COMPLETE`, `PARTIAL`, `FAILED`).

        - **Note**: A note or additional information included with the state
        change.

        - **Author**: The user ID that implemented the state change.
      content:
        application/xml:
          schema:
            $ref: '#/components/schemas/getTnOptionOrderHistoryResponse'
          examples:
            getTnOptionOrderHistoryResponseExample:
              $ref: '#/components/examples/getTnOptionOrderHistoryResponseExample'
        application/json:
          schema:
            $ref: '#/components/schemas/orderHistoryJson'
          examples:
            getTnOptionOrderHistoryJsonResponseExample:
              $ref: '#/components/examples/getTnOptionOrderHistoryJsonResponseExample'
    getTnOptionOrderHistory404Response:
      description: Not Found
      content:
        application/xml:
          schema:
            $ref: >-
              #/components/schemas/tnOptionOrderReportErrorResponseWithoutErrorCode
          examples:
            getTnOptionOrderHistory404ResponseExample:
              $ref: >-
                #/components/examples/tnOptionOrderReportErrorResponseWithoutErrorCodeExample
        application/json:
          schema:
            $ref: >-
              #/components/schemas/tnOptionOrderReportErrorResponseWithoutErrorCodeJson
          examples:
            getTnOptionOrderHistory404JsonResponseExample:
              $ref: >-
                #/components/examples/tnOptionOrderReportErrorResponseWithoutErrorCodeExampleJson
    badRequestError:
      description: Bad Request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/genericError'
          examples:
            badRequestErrorExample:
              $ref: '#/components/examples/badRequestErrorExample'
    badTnOptionRequestError:
      description: Bad Request
      content:
        application/xml:
          schema:
            $ref: '#/components/schemas/tnOptionOrderReportErrorResponse'
          examples:
            badTnOptionRequestErrorExample:
              $ref: '#/components/examples/getTnOptionOrderHistory400ResponseExample'
        application/json:
          schema:
            $ref: '#/components/schemas/tnOptionOrderReportErrorResponseJson'
          examples:
            badRequestErrorExample:
              $ref: >-
                #/components/examples/getTnOptionOrderHistory400ResponseJsonExample
    lidbOrderGet200Response:
      content:
        application/json:
          examples:
            example:
              description: Example JSON response
              value:
                orders:
                  - accountId: 9999999
                    phoneNumberCount: 0
                    userId: team_ua
                    lastModifiedDate: '2014-02-25T16:02:43.195Z'
                    orderDate: '2014-02-25T16:02:43.195Z'
                    orderType: lidb
                    orderId: abe36738-6929-4c6f-926c-88e534e2d46f
                    orderStatus: FAILED
                totalCount: 2122
          schema:
            $ref: '#/components/schemas/jsonLidbOrderHistoryResponse'
        application/xml:
          examples:
            example:
              description: example
              value: |-
                <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
                <ResponseSelectWrapper>
                    <ListOrderIdUserIdDate>
                        <TotalCount>2122</TotalCount>
                        <OrderIdUserIdDate>
                            <accountId>9999999</accountId>
                            <CountOfTNs>0</CountOfTNs>
                            <lastModifiedDate>2014-02-25T16:02:43.195Z</lastModifiedDate>
                            <OrderType>lidb</OrderType>
                            <OrderDate>2014-02-25T16:02:43.195Z</OrderDate>
                            <orderId>abe36738-6929-4c6f-926c-88e534e2d46f</orderId>
                            <OrderStatus>FAILED</OrderStatus>
                            <TelephoneNumberDetails/>
                            <userId>team_ua</userId>
                        </OrderIdUserIdDate>
                        <OrderIdUserIdDate>
                            <accountId>9999999</accountId>
                            <CountOfTNs>0</CountOfTNs>
                            <lastModifiedDate>2014-02-25T16:02:39.021Z</lastModifiedDate>
                            <OrderType>lidb</OrderType>
                            <OrderDate>2014-02-25T16:02:39.021Z</OrderDate>
                            <orderId>ba5b6297-139b-4430-aab0-9ff02c4362f4</orderId>
                            <OrderStatus>FAILED</OrderStatus>
                            <userId>team_ua</userId>
                        </OrderIdUserIdDate>
                    </ListOrderIdUserIdDate>
                </ResponseSelectWrapper>
          schema:
            $ref: '#/components/schemas/lidbOrderHistoryResponse'
      description: OK
    lidbOrderPostSuccessResponse:
      content:
        application/json:
          examples:
            lidbOrderGetExample:
              $ref: '#/components/examples/lidbOrderCreatedJsonResponseExample'
          schema:
            $ref: '#/components/schemas/jsonLidbOrderResponse'
        application/xml:
          examples:
            lidbOrderGetExample:
              $ref: '#/components/examples/lidbOrderCreatedXmlResponseExample'
          schema:
            $ref: '#/components/schemas/lidbOrderResponse'
      description: Created
    lidbOrderPostErrorResponse:
      content:
        application/json:
          examples:
            lidbOrderGetExample:
              $ref: '#/components/examples/lidbOrderCreatedJsonErrorResponseExample'
          schema:
            $ref: '#/components/schemas/jsonLidbOrderErrorResponse'
        application/xml:
          examples:
            lidbOrderGetExample:
              $ref: '#/components/examples/lidbOrderCreatedXmlErrorResponseExample'
          schema:
            $ref: '#/components/schemas/lidbOrderErrorResponse'
      description: Bad Request
    lidbOrderGetIdResponse:
      description: OK
      content:
        application/json:
          examples:
            example:
              description: Example JSON response
              value:
                createdByUser: jbm
                customerOrderId: testCustomerOrderId
                errors: []
                lastModifiedDate: '2014-02-20T19:33:17.6Z'
                lidbPhoneNumberGroups:
                  - fullNumber: 8042105618
                    phoneNumbers:
                      - phoneNumber: '4082213311'
                    subscriberInformation: Fred
                    useType: BUSINESS
                    visibility: PRIVATE
                  - fullNumber: 8042105760
                    phoneNumbers:
                      - phoneNumber: '4082212850'
                      - phoneNumber: '4082213310'
                    subscriberInformation: Fred
                    useType: RESIDENTIAL
                    visibility: PUBLIC
                orderCompleteDate: '2014-02-20T19:33:17.6Z'
                orderCreateDate: '2014-05-28T14:46:21.724Z'
                orderId: 255bda29-fc57-44e8-a6c2-59b45388c6d0
                processingStatus: RECEIVED
          schema:
            $ref: '#/components/schemas/jsonLidbOrderResponsePayload'
        application/xml:
          examples:
            example:
              description: example
              value: |-
                <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
                <LidbOrder>
                    <CustomerOrderId>testCustomerOrderId</CustomerOrderId>
                    <orderId>255bda29-fc57-44e8-a6c2-59b45388c6d0</orderId>
                    <OrderCreateDate>2014-05-28T14:46:21.724Z</OrderCreateDate>
                    <ProcessingStatus>RECEIVED</ProcessingStatus>
                    <CreatedByUser>jbm</CreatedByUser>
                    <LastModifiedDate>2014-02-20T19:33:17.600Z</LastModifiedDate>
                    <OrderCompleteDate>2014-02-20T19:33:17.600Z</OrderCompleteDate>
                    <ErrorList/>
                    <LidbTnGroups>
                        <LidbTnGroup>
                            <TelephoneNumbers>
                                <TelephoneNumber>4082213311</TelephoneNumber>
                            </TelephoneNumbers>
                            <FullNumber>8042105618</FullNumber>
                            <SubscriberInformation>Fred</SubscriberInformation>
                            <UseType>BUSINESS</UseType>
                            <Visibility>PRIVATE</Visibility>
                        </LidbTnGroup>
                        <LidbTnGroup>
                            <TelephoneNumbers>
                                <TelephoneNumber>4082212850</TelephoneNumber>
                                <TelephoneNumber>4082213310</TelephoneNumber>
                            </TelephoneNumbers>
                            <FullNumber>8042105760</FullNumber>
                            <SubscriberInformation>Fred</SubscriberInformation>
                            <UseType>RESIDENTIAL</UseType>
                            <Visibility>PUBLIC</Visibility>
                        </LidbTnGroup>
                    </LidbTnGroups>
                </LidbOrder>
          schema:
            $ref: '#/components/schemas/lidbOrderResponsePayload'
    lidbOrderGetId404Response:
      content:
        application/json:
          examples:
            example:
              description: LIDB Order not found
              value:
                errorCode: 15523
                description: The resource does not exist
          schema:
            $ref: '#/components/schemas/jsonLidbOrderReportErrorResponse'
        application/xml:
          examples:
            example:
              description: example
              value: |-
                <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
                <LidbOrderReportResponse>
                    <ResponseStatus>
                        <Description>The resource does not exist</Description>
                    </ResponseStatus>
                </LidbOrderReportResponse>
          schema:
            $ref: '#/components/schemas/lidbOrderReportErrorResponse'
      description: Not Found
    lidbOrderGetId400Response:
      description: Bad Request
      content:
        application/json:
          examples:
            example:
              value:
                errorCode: 1008
                description: '''fcdde5a-2426-47ef-b309-33eb019c10a7'' is not a valid UUID'
          schema:
            $ref: '#/components/schemas/jsonLidbOrderReportErrorResponse'
        application/xml:
          examples:
            example:
              value: |-
                <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
                <LidbOrderReportResponse>
                    <ResponseStatus>
                      <ErrorCode>1008</ErrorCode>
                      <Description>'fcdde5a-2426-47ef-b309-33eb019c10a7' is not a valid UUID</Description>
                    </ResponseStatus>
                </LidbOrderReportResponse>
          schema:
            $ref: '#/components/schemas/responseStatus'
    dldaOrderGet400ErrorResponse:
      description: Bad Request
      content:
        application/json:
          examples:
            example:
              value:
                errorCode: 1008
                description: '''fcdde5a-2426-47ef-b309-33eb019c10a7'' is not a valid UUID'
          schema:
            $ref: '#/components/schemas/jsonDldaOrderReportErrorResponse'
        application/xml:
          examples:
            example:
              value: |-
                <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
                <DldaOrderReportResponse>
                  <ResponseStatus>
                    <ErrorCode>1008</ErrorCode>
                    <Description>'fcdde5a-2426-47ef-b309-33eb019c10a7' is not a valid UUID</Description>
                  </ResponseStatus>
                </DldaOrderReportResponse>
          schema:
            $ref: '#/components/schemas/responseStatus'
    lidbOrderGet400Response:
      description: Bad Request
      content:
        application/json:
          examples:
            example:
              value:
                errorCode: 12512
                description: Telephone number '44374333407787b' is not valid
          schema:
            $ref: '#/components/schemas/jsonLidbOrderReportErrorResponse'
        application/xml:
          examples:
            example:
              value: |-
                <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
                <LidbOrderReportResponse>
                  <ResponseStatus>
                    <ErrorCode>12512</ErrorCode>
                    <Description>Telephone number '44374333407787b' is not valid</Description>
                  </ResponseStatus>
                </LidbOrderReportResponse>
          schema:
            $ref: '#/components/schemas/lidbOrderReportErrorResponse'
    dldaOrderGet400Response:
      description: Bad Request
      content:
        application/json:
          examples:
            example:
              value:
                errorCode: 12512
                description: Telephone number '44374333407787b' is not valid
          schema:
            $ref: '#/components/schemas/jsonDldaOrderReportErrorResponse'
        application/xml:
          examples:
            example:
              value: |-
                <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
                <DldaOrderReportResponse>
                  <ResponseStatus>
                    <ErrorCode>12512</ErrorCode>
                    <Description>Telephone number ' 7834563789387' is not valid</Description>
                  </ResponseStatus>
                </DldaOrderReportResponse>
          schema:
            $ref: '#/components/schemas/dldaOrderReportErrorResponse'
    successResponseCreate:
      description: Created
    successResponseOk:
      description: OK
    errorResponse401:
      description: Unauthorized
    errorResponse403:
      description: Forbidden
    errorResponse404:
      description: Not Found
    errorResponse429:
      description: Too Many Requests
    errorResponse500:
      description: Internal Server Error
    dldaOrdersGet200Response:
      description: OK
      content:
        application/xml:
          examples:
            dldaOrderGet200ExampleResponse:
              $ref: '#/components/examples/dldaOrderGetXmlExampleResponse'
          schema:
            $ref: '#/components/schemas/responseSelectWrapper'
        application/json:
          examples:
            dldaOrderGet200ExampleResponse:
              $ref: '#/components/examples/dldaOrderGetJsonExampleResponse'
          schema:
            $ref: '#/components/schemas/responseSelectWrapperJson'
    dldaOrdersPost201Response:
      description: Created
      content:
        application/xml:
          examples:
            dldaOrderPostExample:
              $ref: '#/components/examples/dldaOrderPostXmlExampleResponse'
          schema:
            $ref: '#/components/schemas/dldaOrderResponse'
        application/json:
          examples:
            dldaOrderPostExample:
              $ref: '#/components/examples/dldaOrderPostJsonExampleResponse'
          schema:
            $ref: '#/components/schemas/jsonDldaOrderResponse'
    dldaOrderIdGet404ErrorResponse:
      description: Not Found
      content:
        application/xml:
          examples:
            example:
              description: example
              value: |-
                <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
                <DldaOrderResponse>
                   <ResponseStatus>
                      <Description>The resource does not exist</Description>
                   </ResponseStatus>
                </DldaOrderResponse>
          schema:
            $ref: '#/components/schemas/dldaOrderErrorNotFoundResponse'
        application/json:
          examples:
            example:
              description: json example
              value:
                description: The resource does not exist
          schema:
            $ref: '#/components/schemas/jsonDldaOrderErrorNotFoundResponse'
    dldaOrderIdGet200Response:
      description: >
        The descriptive payload for the DlDA Orders query provides a broad range
        of information about the DLDA Order identified in the URL. Included
        amongst the information is:      

        - **errors**: The errors discovered with codes and explanations.

        - **Various Dates**: Such as order creation, modification, and
        completion dates.

        - **processingStatus**: The overall status of the order (`RECEIVED`,
        `PROCESSING`, `COMPLETE`, `PARTIAL`, `FAILED`).

        - **DldaPhoneNumberGroups**: List of DldaPhoneNumberGroup elements that
        contains list of Phone Number with Directory Listing and Directory
        Assistance information, SubscriberType(RESIDENTIAL or BUSINESS),
        ListingType(LISTED, NON_LISTED or NON_PUBLISHED).
      content:
        application/xml:
          examples:
            dldaOrderIdGet200ExampleResponse:
              $ref: '#/components/examples/dldaOrderIdGetXmlExampleResponse'
          schema:
            $ref: '#/components/schemas/dldaOrderResponse'
        application/json:
          examples:
            dldaOrderIdGet200ExampleResponse:
              $ref: '#/components/examples/dldaOrderIdGetJsonExampleResponse'
          schema:
            $ref: '#/components/schemas/jsonDldaOrderResponse'
    dldaOrdersPost400Response:
      description: Bad Request
      content:
        application/xml:
          examples:
            lidbOrderPost400XmlResponseExample:
              $ref: '#/components/examples/dldaOrderPost400XmlExampleResponse'
          schema:
            $ref: '#/components/schemas/dldaOrderErrorResponse'
        application/json:
          examples:
            lidbOrderPost400JsonResponseExample:
              $ref: '#/components/examples/dldaOrderPost400JsonExampleResponse'
          schema:
            $ref: '#/components/schemas/jsonDldaOrderErrorResponse'
    dldaOrderIdGetHistory200Response:
      description: |-
        The history payload is a set of history records, each of which contains:
            <table style="text-align: left; width: 80%;" border="1" cellpadding="2" cellspacing="2">
                <tbody>
                    <tr>
                        <td>OrderDate</td>
                        <td>The date that the order history event happened</td>
                    </tr>
                    <tr>
                        <td>Status</td>
                        <td>The new state of the DLDA order - RECEIVED, PROCESSING, COMPLETE, PARTIAL, FAILED</td>
                    </tr>
                    <tr>
                        <td>Note</td>
                        <td>A Note or additional information included with the state change </td>
                   </tr>
                   <tr>
                        <td>Author</td>
                        <td>The user id that implemented the state change</td>
                    </tr>
                </tbody>
            </table>
      content:
        application/xml:
          examples:
            dldaOrderIdGetHistory200ExampleResponse:
              $ref: '#/components/examples/dldaOrderIdGetHistoryXmlExampleResponse'
          schema:
            $ref: '#/components/schemas/orderHistoryWrapper'
        application/json:
          examples:
            dldaOrderIdGetHistory200ExampleResponse:
              $ref: '#/components/examples/dldaOrderIdGetHistoryJsonExampleResponse'
          schema:
            $ref: '#/components/schemas/jsonOrderHistoryWrapper'
    dldaOrderIdGetHistory404ErrorResponse:
      description: Not Found
      content:
        application/xml:
          examples:
            example:
              value: |-
                <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
                <DldaOrderReportResponse>
                   <ResponseStatus>
                      <Description>The resource does not exist</Description>
                   </ResponseStatus>
                </DldaOrderReportResponse>
          schema:
            $ref: '#/components/schemas/dldaOrderReportErrorResponse'
        application/json:
          examples:
            example:
              value:
                description: The resource does not exist
          schema:
            $ref: '#/components/schemas/jsonDldaOrderReportErrorResponse'
    dldaOrdersUpdate200Response:
      description: OK
      content:
        application/xml:
          examples:
            dldaOrderUpdate200ExampleResponse:
              $ref: '#/components/examples/dldaOrderUpdateXmlExampleResponse'
          schema:
            $ref: '#/components/schemas/dldaOrderResponse'
        application/json:
          examples:
            dldaOrderUpdate200ExampleResponse:
              $ref: '#/components/examples/dldaOrderUpdateJsonExampleResponse'
          schema:
            $ref: '#/components/schemas/jsonDldaOrderResponse'
    dldaOrdersUpdate400Response:
      description: Bad Request
      content:
        application/xml:
          examples:
            example:
              value: |-
                <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
                <DldaOrderResponse>
                   <ResponseStatus>
                      <ErrorCode>16105</ErrorCode>
                      <Description>Order cannot be changed or cancelled because it is already being processed</Description>
                   </ResponseStatus>
                </DldaOrderResponse>
          schema:
            $ref: '#/components/schemas/responseStatus'
        application/json:
          examples:
            example:
              value:
                errorCode: 16105
                description: >-
                  Order cannot be changed or cancelled because it is already
                  being processed
          schema:
            $ref: '#/components/schemas/responseStatusJson'
  examples:
    createTnOptionJsonRequestExampleVcpDisabled:
      summary: VCP Disabled TN Options Request Body
      value:
        customerOrderId: TnOptionOrder1
        tnOptionGroups:
          - numberFormat: E164
            portOutPasscode: a1b2c3
            protected: 'true'
            sms: 'ON'
            rpidFormat: 10DIGIT
            rewriteUser: '3072489876'
            callForward: '+16362345678'
            callingNameDisplay: 'ON'
            finalDestinationUri: '+12018551025'
            pindropEnabled: 'true'
            nnid: UNCHANGED
            espid: SYSTEM_DEFAULT
            originationRoutePlan:
              id: 01d04236-a908-4d03-b6ff-8865308defe2
              routes:
                - endpoint: sip:clarkkent@dailyplanet.com
                  name: Primary Route
                  priority: 1
                  weight: 1
                  endpointType: SIP
              action: AS_SPECIFIED
            a2pSettings:
              campaignId: campaignId010
              action: AS_SPECIFIED
            phoneNumbers:
              - '+12018551020'
          - numberFormat: E164
            protected: 'false'
            sms: 'OFF'
            phoneNumbers:
              - '+12018551025'
    createTnOptionJsonRequestExampleVcpEnabled:
      summary: VCP Enabled TN Options Request Body
      value:
        customerOrderId: TnOptionOrder1
        tnOptionGroups:
          - portOutPasscode: UNCHANGED
            protected: 'true'
            sms: 'ON'
            a2pSettings:
              campaignId: campaign123
              action: AS_SPECIFIED
            nnid: UNCHANGED
            phoneNumbers:
              - '+12018551025'
    createTnOptionOrderXmlRequestExampleVcpEnabled:
      summary: VCP Enabled TN Options Request Body
      value: |-
        <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
        <TnOptionOrder>
          <CustomerOrderId>TnOptionOrder1</CustomerOrderId>
          <TnOptionGroups>
            <TnOptionGroup>
              <PortOutPasscode>a1b2c3</PortOutPasscode>
              <Protected>true</Protected>
              <Sms>ON</Sms>
              <A2pSettings>
                <CampaignId>campaignId010</CampaignId>
                <Action>AS_SPECIFIED</Action>
              </A2pSettings>
              <TelephoneNumbers>
                <TelephoneNumber>+12018551020</TelephoneNumber>
              </TelephoneNumbers>
            </TnOptionGroup>
            <TnOptionGroup>
              <Protected>false</Protected>
              <Sms>OFF</Sms>
              <TelephoneNumbers>
                <TelephoneNumber>+12018551025</TelephoneNumber>
              </TelephoneNumbers>
            </TnOptionGroup>
          </TnOptionGroups>
        </TnOptionOrder>
    createTnOptionOrderXmlRequestExampleVcpDisabled:
      summary: VCP Disabled TN Options Request Body
      value: |-
        <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
        <TnOptionOrder>
          <CustomerOrderId>TnOptionOrder1</CustomerOrderId>
          <TnOptionGroups>
            <TnOptionGroup>
              <NumberFormat>10DIGIT</NumberFormat>
              <PortOutPasscode>a1b2c3</PortOutPasscode>
              <Protected>true</Protected>
              <Sms>ON</Sms>
              <RPIDFormat>10DIGIT</RPIDFormat>
              <RewriteUser>3072489876</RewriteUser>
              <CallForward>1636234567</CallForward>
              <CallingNameDisplay>ON</CallingNameDisplay>
              <FinalDestinationURI>+12018551025</FinalDestinationURI>
              <PindropEnabled>true</PindropEnabled>
              <NNID>UNCHANGED</NNID>
              <ESPID>SYSTEM_DEFAULT</ESPID>
              <OriginationRoutePlan>
                <Id>01d04236-a908-4d03-b6ff-8865308defe2</Id>
                <Route>
                  <Endpoint>sip:clarkkent@dailyplanet.com</Endpoint>
                  <Name>Primary Route</Name>
                  <Priority>1</Priority>
                  <Weight>1</Weight>
                  <EndpointType>SIP</EndpointType>
                </Route>
                <Action>AS_SPECIFIED</Action>
              </OriginationRoutePlan>
              <A2pSettings>
                <CampaignId>campaignId010</CampaignId>
                <Action>AS_SPECIFIED</Action>
              </A2pSettings>
              <TelephoneNumbers>
                <TelephoneNumber>+12018551020</TelephoneNumber>
              </TelephoneNumbers>
            </TnOptionGroup>
            <TnOptionGroup>
              <NumberFormat>10DIGIT</NumberFormat>
              <Protected>false</Protected>
              <Sms>OFF</Sms>
              <TelephoneNumbers>
                <TelephoneNumber>+12018551025</TelephoneNumber>
              </TelephoneNumbers>
            </TnOptionGroup>
          </TnOptionGroups>
        </TnOptionOrder>
    createTnOptionXmlResponseExample:
      value: |-
        <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
        <TnOptionOrderResponse>
          <TnOptionOrder>
            <OrderCreateDate>2016-01-15T12:01:14.324Z</OrderCreateDate>
            <AccountId>14</AccountId>
            <CreatedByUser>jbm</CreatedByUser>
            <OrderId>ddbdc72e-dc27-490c-904e-d0c11291b095</OrderId>
            <LastModifiedDate>2016-01-15T12:01:14.324Z</LastModifiedDate>
            <ProcessingStatus>RECEIVED</ProcessingStatus>
            <TnOptionGroups>
              <TnOptionGroup>
                <NumberFormat>10DIGIT</NumberFormat>
                <PortOutPasscode>a1b2c3</PortOutPasscode>
                <Protected>true</Protected>
                <Sms>ON</Sms>
                <RPIDFormat>10DIGIT</RPIDFormat>
                <RewriteUser>SYSTEM_DEFAULT</RewriteUser>
                <CallForward>3361234567</CallForward>
                <CallingNameDisplay>ON</CallingNameDisplay>
                <FinalDestinationURI>+12018551025</FinalDestinationURI>
                <PindropEnabled>true</PindropEnabled>
                <NNID>UNCHANGED</NNID>
                <ESPID>SYSTEM_DEFAULT</ESPID>
                <OriginationRoutePlan>
                  <Id>01d04236-a908-4d03-b6ff-8865308defe2</Id>
                  <Route>
                    <Endpoint>sip:clarkkent@dailyplanet.com</Endpoint>
                    <Name>Primary Route</Name>
                    <Priority>1</Priority>
                    <Weight>1</Weight>
                    <EndpointType>SIP</EndpointType>
                  </Route>
                  <Action>AS_SPECIFIED</Action>
                </OriginationRoutePlan>
                <A2pSettings>
                  <CampaignId>campaignId010</CampaignId>
                  <Action>AS_SPECIFIED</Action>
                </A2pSettings>
                <TelephoneNumbers>
                  <TelephoneNumber>+12018551020</TelephoneNumber>
                </TelephoneNumbers>
              </TnOptionGroup>
              <TnOptionGroup>
                <NumberFormat>10DIGIT</NumberFormat>
                <Protected>false</Protected>
                <Sms>OFF</Sms>
                <TelephoneNumbers>
                  <TelephoneNumber>+12018551025</TelephoneNumber>
                </TelephoneNumbers>
              </TnOptionGroup>
            </TnOptionGroups>
            <ErrorList/>
          </TnOptionOrder>
        </TnOptionOrderResponse>
    createTnOptionJsonResponseExample:
      value:
        orderCreateDate: '2016-01-15T12:01:14.324Z'
        accountId: 14
        createdByUser: jbm
        orderId: ddbdc72e-dc27-490c-904e-d0c11291b095
        lastModifiedDate: '2016-01-15T12:01:14.324Z'
        processingStatus: RECEIVED
        tnOptionGroups:
          - numberFormat: E164
            portOutPasscode: a1b2c3
            protected: 'TRUE'
            sms: 'ON'
            rpidFormat: 10DIGIT
            rewriteUser: '3072489876'
            callForward: '+16362345678'
            callingNameDisplay: 'ON'
            finalDestinationUri: '+12018551025'
            pindropEnabled: 'TRUE'
            nnid: UNCHANGED
            espid: SYSTEM_DEFAULT
            originationRoutePlan:
              id: 01d04236-a908-4d03-b6ff-8865308defe2
              routes:
                - endpoint: sip:clarkkent@dailyplanet.com
                  name: Primary Route
                  priority: 1
                  weight: 1
                  endpointType: SIP
              action: AS_SPECIFIED
            a2pSettings:
              campaignId: campaignId010
              action: AS_SPECIFIED
            phoneNumbers:
              - '+12018551020'
          - numberFormat: E164
            protected: 'FALSE'
            sms: 'OFF'
            phoneNumbers:
              - '+12018551025'
        errors: []
    createTnOptionJsonErrorResponseExample:
      value:
        code: 5193
        description: >-
          Port-Out Passcode is invalid. The value must be 4–10 alphanumeric
          characters, or the literal values UNCHANGED or SYSTEM_DEFAULT.
    createTnOptionXmlErrorResponseExample:
      value: |-
        <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
        <TnOptionOrderResponse>
          <ResponseStatus>
            <ErrorCode>5193</ErrorCode>
            <Description>Port-Out Passcode is invalid. The value must be 4–10 alphanumeric characters, or the literal values UNCHANGED or SYSTEM_DEFAULT.</Description>
          </ResponseStatus>
        </TnOptionOrderResponse>
    retrieveTnOptionOrderResponseXmlExample:
      value: |-
        <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
        <TnOptionOrder>
          <OrderCreateDate>2016-01-15T11:22:58.789Z</OrderCreateDate>
          <AccountId>14</AccountId>
          <CreatedByUser>jbm</CreatedByUser>
          <OrderId>ddbdc72e-dc27-490c-904e-d0c11291b095</OrderId>
          <LastModifiedDate>2016-01-15T11:22:58.969Z</LastModifiedDate>
          <ProcessingStatus>COMPLETE</ProcessingStatus>
          <TnOptionGroups>
              <TnOptionGroup>
                <NumberFormat>10DIGIT</NumberFormat>
                <PortOutPasscode>a1b2c3</PortOutPasscode>
                <Protected>true</Protected>
                <Sms>ON</Sms>
                <RPIDFormat>10DIGIT</RPIDFormat>
                <RewriteUser>SYSTEM_DEFAULT</RewriteUser>
                <CallForward>3361234567</CallForward>
                <CallingNameDisplay>ON</CallingNameDisplay>
                <FinalDestinationURI>+12018551025</FinalDestinationURI>
                <PindropEnabled>true</PindropEnabled>
                <NNID>UNCHANGED</NNID>
                <ESPID>SYSTEM_DEFAULT</ESPID>
                <OriginationRoutePlan>
                  <Id>01d04236-a908-4d03-b6ff-8865308defe2</Id>
                  <Route>
                    <Endpoint>sip:clarkkent@dailyplanet.com</Endpoint>
                    <Name>Primary Route</Name>
                    <Priority>1</Priority>
                    <Weight>1</Weight>
                    <EndpointType>SIP</EndpointType>
                  </Route>
                  <Action>AS_SPECIFIED</Action>
                </OriginationRoutePlan>
                <A2pSettings>
                  <CampaignId>campaignId010</CampaignId>
                  <Action>AS_SPECIFIED</Action>
                </A2pSettings>
                <TelephoneNumbers>
                  <TelephoneNumber>+12018551020</TelephoneNumber>
                </TelephoneNumbers>
              </TnOptionGroup>
              <TnOptionGroup>
                <NumberFormat>10DIGIT</NumberFormat>
                <Protected>false</Protected>
                <Sms>OFF</Sms>
                <TelephoneNumbers>
                  <TelephoneNumber>+12018551025</TelephoneNumber>
                </TelephoneNumbers>
              </TnOptionGroup>
            </TnOptionGroups>
          <ErrorList/>
          <Warnings>
            <Warning>
              <TelephoneNumber>+12174101601</TelephoneNumber>
              <Description>SMS is already Enabled or number is in processing.</Description>
            </Warning>
          </Warnings>
        </TnOptionOrder>
    getTnOptionOrderReportSummaryResponseXmlExample:
      summary: Summary Response
      value: |-
        <?xml version="1.0" encoding="UTF-8"?>
        <TnOptionOrderReportResponse>
           <TnOptionOrders>
              <TotalCount>2</TotalCount>
              <TnOptionOrderSummary>
                 <AccountId>14</AccountId>
                 <CountOfTNs>2</CountOfTNs>
                 <userId>jbm</userId>
                 <LastModifiedDate>2016-01-15T12:01:14.363Z</LastModifiedDate>
                 <OrderDate>2016-01-15T12:01:14.324Z</OrderDate>
                 <OrderType>tn_option</OrderType>
                 <OrderStatus>FAILED</OrderStatus>
                 <OrderId>ddbdc72e-dc27-490c-904e-d0c11291b095</OrderId>
              </TnOptionOrderSummary>
              <TnOptionOrderSummary>
                 <AccountId>14</AccountId>
                 <CountOfTNs>3</CountOfTNs>
                 <UserId>jbm</UserId>
                 <LastModifiedDate>2016-01-15T11:22:58.969Z</LastModifiedDate>
                 <OrderDate>2016-01-15T11:22:58.789Z</OrderDate>
                 <OrderType>tn_option</OrderType>
                 <OrderStatus>COMPLETE</OrderStatus>
                 <OrderId>409033ee-88ec-43e3-85f3-538f30733963</OrderId>
              </TnOptionOrderSummary>
           </TnOptionOrders>
        </TnOptionOrderReportResponse>
    getTnOptionOrderReportDetailedResponseXmlExample:
      summary: Detailed Response
      value: |-
        <?xml version="1.0" encoding="UTF-8"?>
        <TnOptionOrderReportResponse>
           <TnOptionOrders>
              <TotalCount>2</TotalCount>
              <TnOptionOrder>
                 <OrderCreateDate>2016-01-15T12:01:14.324Z</OrderCreateDate>
                 <AccountId>14</AccountId>
                 <CreatedByUser>jbm</CreatedByUser>
                 <OrderId>ddbdc72e-dc27-490c-904e-d0c11291b095</OrderId>
                 <LastModifiedDate>2016-01-15T12:01:14.363Z</LastModifiedDate>
                 <ProcessingStatus>FAILED</ProcessingStatus>
                 <TnOptionGroups>
                    <TnOptionGroup>
                       <Protected>true</Protected>
                       <Sms>ON</Sms>
                       <TelephoneNumbers>
                          <TelephoneNumber>+12018551020</TelephoneNumber>
                       </TelephoneNumbers>
                    </TnOptionGroup>
                    <TnOptionGroup>
                       <Protected>false</Protected>
                       <Sms>OFF</Sms>
                       <TelephoneNumbers>
                          <TelephoneNumber>+12018551025</TelephoneNumber>
                       </TelephoneNumbers>
                    </TnOptionGroup>
                 </TnOptionGroups>
                 <ErrorList>
                    <Error>
                       <Code>5076</Code>
                       <Description>Telephone number is not available.</Description>
                       <TelephoneNumber>+12018551025</TelephoneNumber>
                    </Error>
                    <Error>
                       <Code>5076</Code>
                       <Description>Telephone number is not available.</Description>
                       <TelephoneNumber>+12018551020</TelephoneNumber>
                    </Error>
                 </ErrorList>
              </TnOptionOrder>
              <TnOptionOrder>
                 <OrderCreateDate>2016-01-15T11:22:58.789Z</OrderCreateDate>
                 <AccountId>14</AccountId>
                 <CreatedByUser>jbm</CreatedByUser>
                 <OrderId>409033ee-88ec-43e3-85f3-538f30733963</OrderId>
                 <LastModifiedDate>2016-01-15T11:22:58.969Z</LastModifiedDate>
                 <ProcessingStatus>COMPLETE</ProcessingStatus>
                 <TnOptionGroups>
                    <TnOptionGroup>
                       <CallingNameDisplay>on</CallingNameDisplay>
                       <TelephoneNumbers>
                          <TelephoneNumber>+12174101601</TelephoneNumber>
                       </TelephoneNumbers>
                    </TnOptionGroup>
                    <TnOptionGroup>
                       <CallingNameDisplay>off</CallingNameDisplay>
                       <TelephoneNumbers>
                          <TelephoneNumber>+12174101602</TelephoneNumber>
                       </TelephoneNumbers>
                    </TnOptionGroup>
                    <TnOptionGroup>
                       <CallingNameDisplay>SYSTEM_DEFAULT</CallingNameDisplay>
                       <TelephoneNumbers>
                          <TelephoneNumber>+12174101603</TelephoneNumber>
                       </TelephoneNumbers>
                    </TnOptionGroup>
                 </TnOptionGroups>
                 <ErrorList />
              </TnOptionOrder>
           </TnOptionOrders>
        </TnOptionOrderReportResponse>
    getTnOptionOrderReportSummaryJsonResponseExample:
      summary: Summary Response
      value:
        totalCount: 2
        orders:
          - accountId: 14
            phoneNumberCount: 2
            userId: jbm
            lastModifiedDate: '2016-01-15T12:01:14.363Z'
            orderDate: '2016-01-15T12:01:14.324Z'
            orderType: tn_option
            orderStatus: FAILED
            orderId: ddbdc72e-dc27-490c-904e-d0c11291b095
          - accountId: 14
            phoneNumberCount: 3
            userId: jbm
            lastModifiedDate: '2016-01-15T11:22:58.969Z'
            orderDate: '2016-01-15T11:22:58.789Z'
            orderType: tn_option
            orderStatus: COMPLETE
            orderId: 409033ee-88ec-43e3-85f3-538f30733963
    retrieveTnOptionOrderJsonResponseExample:
      summary: Order Response
      value:
        orderCreateDate: '2016-01-15T12:01:14.324Z'
        accountId: 14
        createdByUser: jbm
        orderId: ddbdc72e-dc27-490c-904e-d0c11291b095
        lastModifiedDate: '2016-01-15T12:01:14.363Z'
        processingStatus: FAILED
        tnOptionGroups:
          - numberFormat: E164
            portOutPasscode: a1b2c3
            protected: 'TRUE'
            sms: 'ON'
            rpidFormat: 10DIGIT
            rewriteUser: '3072489876'
            callForward: '+16362345678'
            callingNameDisplay: 'ON'
            finalDestinationUri: '+12018551025'
            pindropEnabled: 'TRUE'
            nnid: UNCHANGED
            espid: SYSTEM_DEFAULT
            originationRoutePlan:
              id: 01d04236-a908-4d03-b6ff-8865308defe2
              routes:
                - endpoint: sip:clarkkent@dailyplanet.com
                  name: Primary Route
                  priority: 1
                  weight: 1
                  endpointType: SIP
              action: AS_SPECIFIED
            a2pSettings:
              campaignId: campaignId010
              action: AS_SPECIFIED
            phoneNumbers:
              - '+12018551020'
          - numberFormat: E164
            protected: 'FALSE'
            sms: 'OFF'
            phoneNumbers:
              - '+12018551025'
        errors:
          - code: 5076
            description: Telephone number is not available.
            phoneNumber: '+12018551025'
          - code: 5076
            description: Telephone number is not available.
            phoneNumber: '+12018551020'
    getTnOptionOrderReportDetailedJsonResponseExample:
      summary: Detailed Response
      value:
        totalCount: 2
        orders:
          - orderCreateDate: '2016-01-15T12:01:14.324Z'
            accountId: 14
            createdByUser: jbm
            orderId: ddbdc72e-dc27-490c-904e-d0c11291b095
            lastModifiedDate: '2016-01-15T12:01:14.363Z'
            processingStatus: FAILED
            tnOptionGroups:
              - protected: 'TRUE'
                sms: 'ON'
                phoneNumbers:
                  - '+12018551020'
              - protected: 'FALSE'
                sms: 'OFF'
                phoneNumbers:
                  - '+12018551025'
            errors:
              - code: 5076
                description: Telephone number is not available.
                phoneNumber: '+12018551025'
              - code: 5076
                description: Telephone number is not available.
                phoneNumber: '+12018551020'
            warnings: []
          - orderCreateDate: '2016-01-15T11:22:58.789Z'
            accountId: 14
            createdByUser: jbm
            orderId: 409033ee-88ec-43e3-85f3-538f30733963
            lastModifiedDate: '2016-01-15T11:22:58.969Z'
            processingStatus: COMPLETE
            tnOptionGroups:
              - callingNameDisplay: 'ON'
                phoneNumbers:
                  - '+12174101601'
              - callingNameDisplay: 'OFF'
                phoneNumbers:
                  - '+12174101602'
              - callingNameDisplay: SYSTEM_DEFAULT
                phoneNumbers:
                  - '+12174101603'
            errors: []
            warnings: []
    getTnOptionOrders400JsonResponseExample:
      value:
        code: 15523
        description: >-
          Order '3e9af1de-cf60-4727-bfe8-45d478fc63f8' does not correspond to a
          given account '12346168'
    getTnOptionOrders400ResponseExample:
      value: |-
        <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
        <TnOptionOrderReportResponse>
          <ResponseStatus>
            <ErrorCode>15523</ErrorCode>
            <Description>Order '3e9af1de-cf60-4727-bfe8-45d478fc63f8' does not correspond to a given account '12346168'</Description>
          </ResponseStatus>
        </TnOptionOrderReportResponse>
    getTnOptionOrder400ResponseExample:
      value: |-
        <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
        <TnOptionOrderReportResponse>
          <ResponseStatus>
            <ErrorCode>15523</ErrorCode>
            <Description>Order 'bfcdde5a-2426-47ef-b309-33eb019c10a7' does not correspond to a given account '12346160'</Description>
          </ResponseStatus>
        </TnOptionOrderReportResponse>
    getTnOptionOrder400ResponseJsonExample:
      value:
        code: 15523
        description: >-
          Order 'bfcdde5a-2426-47ef-b309-33eb019c10a7' does not correspond to a
          given account '12346160'
    getTnOptionOrderHistoryResponseExample:
      value: |-
        <?xml version="1.0" encoding="UTF-8"?>
        <OrderHistoryWrapper>
           <OrderHistory>
              <OrderDate>2020-09-17T08:56:39.607Z</OrderDate>
              <Note>Order has been received by the system.</Note>
              <Author>admin</Author>
              <Status>received</Status>
           </OrderHistory>
           <OrderHistory>
              <OrderDate>2020-09-17T08:56:39.743Z</OrderDate>
              <Note>Order processing has started.</Note>
              <Author>admin</Author>
              <Status>processing</Status>
           </OrderHistory>
           <OrderHistory>
              <OrderDate>2020-09-17T08:56:39.820Z</OrderDate>
              <Note>Order is complete.</Note>
              <Author>admin</Author>
              <Status>complete</Status>
           </OrderHistory>
        </OrderHistoryWrapper>
    tnOptionOrderReportErrorResponseWithoutErrorCodeExample:
      value: |-
        <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
        <TnOptionOrderReportResponse>
          <ResponseStatus>
            <Description>The resource does not exist</Description>
          </ResponseStatus>
        </TnOptionOrderReportResponse>
    tnOptionOrderReportErrorResponseWithoutErrorCodeExampleJson:
      value:
        description: The resource does not exist
    getTnOptionOrderHistory400ResponseExample:
      value: |-
        <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
        <TnOptionOrderReportResponse>
          <ResponseStatus>
            <ErrorCode>1008</ErrorCode>
            <Description>'fcdde5a-2426-47ef-b309-33eb019c10a7' is not a valid UUID</Description>
          </ResponseStatus>
        </TnOptionOrderReportResponse>
    getTnOptionOrderHistory400ResponseJsonExample:
      value:
        code: 1008
        description: '''fcdde5a-2426-47ef-b309-33eb019c10a7'' is not a valid UUID'
    getTnOptionOrderHistoryJsonResponseExample:
      summary: An example of a get TN Option Order History response in JSON.
      value:
        orderHistory:
          - orderDate: '2015-06-16T14:03:10.225Z'
            note: TN Option order is received.
            author: admin
            status: RECEIVED
          - orderDate: '2015-06-16T14:03:10.330Z'
            note: TN Option order is processing.
            author: admin
            status: PROCESSING
          - orderDate: '2015-06-16T14:03:10.789Z'
            note: TN Option order is partial.
            author: admin
            status: PARTIAL
    unauthorizedErrorExample:
      summary: An example of a generic Unauthorized Error
      value:
        data: null
        errors:
          - type: authentication-credentials
            description: Invalid or missing credentials.
            code: 206401
        links: []
    badRequestErrorExample:
      summary: An example of a generic Bad Request Error
      value:
        data: null
        errors:
          - type: bad-request
            description: There was an issue with your request.
            code: 205617
        links: []
    lidbOrderPostXmlPayloadExample:
      summary: Example xml request payload to request Create Lidb Order
      value: |-
        <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
        <LidbOrder>
            <CustomerOrderId>my-order-123</CustomerOrderId>
            <LidbTnGroups>
                <LidbTnGroup>
                    <TelephoneNumbers>
                        <TelephoneNumber>+18045030097</TelephoneNumber>
                        <TelephoneNumber>+18045030098</TelephoneNumber>
                    </TelephoneNumbers>
                    <SubscriberInformation>Joes Garage</SubscriberInformation>
                    <UseType>RESIDENTIAL</UseType>
                    <Visibility>PUBLIC</Visibility>
                </LidbTnGroup>
                <LidbTnGroup>
                    <TelephoneNumbers>
                        <TelephoneNumber>+18888595935</TelephoneNumber>
                    </TelephoneNumbers>
                    <SubscriberInformation>Joes Storage</SubscriberInformation>
                    <UseType>RESIDENTIAL</UseType>
                    <Visibility>PRIVATE</Visibility>
                </LidbTnGroup>
            </LidbTnGroups>
        </LidbOrder>
    lidbOrderCreatedJsonResponseExample:
      value:
        orderId: 1d863522-c9bf-430c-8e79-cc63cad04a1d
        customerOrderId: my-order-123
        processingStatus: RECEIVED
        errors:
          - code: 11020
            description: >-
              Cannot add LIDB to a phone number that already has LIDB or is in
              process
            phoneNumber: '+18888595935'
        lidbPhoneNumberGroups:
          - phoneNumbers:
              - '+18045030097'
              - '+18045030098'
            subscriberInformation: Joes Garage
            useType: RESIDENTIAL
            visibility: PUBLIC
          - phoneNumbers:
              - '+18888595935'
            subscriberInformation: Joes Storage
            useType: RESIDENTIAL
            visibility: PRIVATE
    lidbOrderCreatedXmlResponseExample:
      summary: Xml example for created response
      value: |-
        <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
        <LidbOrderResponse>
            <LidbOrder>
                <orderId>1d863522-c9bf-430c-8e79-cc63cad04a1d</orderId>
                <CustomerOrderId>my-order-123</CustomerOrderId>
                <ProcessingStatus>RECEIVED</ProcessingStatus>
                <ErrorList>
                  <Error>
                    <TelephoneNumber>+18888595935</TelephoneNumber>
                    <Code>11020</Code>
                    <Description>Cannot add LIDB to a telephone number that already has LIDB or is in process</Description>
                  </Error>
                </ErrorList>
                <LidbTnGroups>
                  <LidbTnGroup>
                    <TelephoneNumbers>
                      <TelephoneNumber>+18045030097</TelephoneNumber>
                      <TelephoneNumber>+18045030098</TelephoneNumber>
                    </TelephoneNumbers>
                    <SubscriberInformation>Joes Garage</SubscriberInformation>
                    <UseType>RESIDENTIAL</UseType>
                    <Visibility>PUBLIC</Visibility>
                  </LidbTnGroup>
                  <LidbTnGroup>
                    <TelephoneNumbers>
                      <TelephoneNumber>+18888595935</TelephoneNumber>
                    </TelephoneNumbers>
                    <SubscriberInformation>Joes Storage</SubscriberInformation>
                    <UseType>RESIDENTIAL</UseType>
                    <Visibility>PRIVATE</Visibility>
                  </LidbTnGroup>
                </LidbTnGroups>
            </LidbOrder>
        </LidbOrderResponse>
    lidbOrderPostJsonPayloadExample:
      value:
        customerOrderId: my-order-123
        lidbPhoneNumberGroups:
          - phoneNumbers:
              - '+18045030097'
              - '+18045030098'
            subscriberInformation: Joes Garage
            useType: RESIDENTIAL
            visibility: PUBLIC
          - phoneNumbers:
              - '+18888595935'
            subscriberInformation: Joes Storage
            useType: RESIDENTIAL
            visibility: PRIVATE
    lidbOrderCreatedJsonErrorResponseExample:
      value:
        status:
          code: 400
          description: Validation Failed. Please check your input parameters.
        errors:
          - code: 11007
            description: >-
              No visibility supplied. Visibility must be one of the following -
              PUBLIC, PRIVATE
        lidbPhoneNumberGroups:
          - phoneNumbers:
              - phoneNumber: '+19199998830'
            subscriberInformation: Joes Garage
            useType: RESIDENTIAL
    lidbOrderCreatedXmlErrorResponseExample:
      summary: Xml example for lidb order creation error.
      value: |-
        <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
        <LidbOrderResponse>
            <Status>
                <Code>400</Code>
                <Description>Validation Failed. Please check your input parameters.</Description>
            </Status>
            <ErrorList>
                <Error>
                    <Code>11007</Code>
                    <Description>No visibility supplied. Visibility must be one of the following - PUBLIC, PRIVATE</Description>
                </Error>
            </ErrorList>
            <LidbOrder>
              <LidbTnGroups>
                  <LidbTnGroup>
                      <TelephoneNumbers>
                          <TelephoneNumber>+19199998830</TelephoneNumber>
                      </TelephoneNumbers>
                      <SubscriberInformation>Joes Garage</SubscriberInformation>
                      <UseType>RESIDENTIAL</UseType>
                  </LidbTnGroup>
              </LidbTnGroups>
            </LidbOrder>
        </LidbOrderResponse>
    dldaOrderGetXmlExampleResponse:
      description: example
      value: |-
        <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
        <ResponseSelectWrapper>
           <ListOrderIdUserIdDate>
              <TotalCount>3</TotalCount>
              <OrderIdUserIdDate>
                 <accountId>14</accountId>
                 <CountOfTNs>2</CountOfTNs>
                 <userId>team_ua</userId>
                 <lastModifiedDate>2014-07-07T10:06:43.427Z</lastModifiedDate>
                 <OrderType>dlda</OrderType>
                 <OrderDate>2014-07-07T10:06:43.427Z</OrderDate>
                 <orderId>37a6447c-1a0b-4be9-ba89-3f5cb0aea142</orderId>
                 <OrderStatus>FAILED</OrderStatus>
              </OrderIdUserIdDate>
              <OrderIdUserIdDate>
                 <accountId>14</accountId>
                 <CountOfTNs>2</CountOfTNs>
                 <userId>team_ua</userId>
                 <lastModifiedDate>2014-07-07T10:05:56.595Z</lastModifiedDate>
                 <OrderType>dlda</OrderType>
                 <OrderDate>2014-07-07T10:05:56.595Z</OrderDate>
                 <orderId>743b0e64-3350-42e4-baa6-406dac7f4a85</orderId>
                 <OrderStatus>RECEIVED</OrderStatus>
              </OrderIdUserIdDate>
              <OrderIdUserIdDate>
                 <accountId>14</accountId>
                 <CountOfTNs>2</CountOfTNs>
                 <userId>team_ua</userId>
                 <lastModifiedDate>2014-07-07T09:32:17.234Z</lastModifiedDate>
                 <OrderType>dlda</OrderType>
                 <OrderDate>2014-07-07T09:32:17.234Z</OrderDate>
                 <orderId>f71eb4d2-bfef-4384-957f-45cd6321185e</orderId>
                 <OrderStatus>RECEIVED</OrderStatus>
              </OrderIdUserIdDate>
           </ListOrderIdUserIdDate>
        </ResponseSelectWrapper>
    dldaOrderGetJsonExampleResponse:
      value:
        totalCount: 3
        orders:
          - accountId: 14
            phoneNumberCount: 2
            userId: team_ua
            lastModifiedDate: '2014-07-07T10:06:43.427Z'
            orderType: dlda
            orderDate: '2014-07-07T10:06:43.427Z'
            orderId: 37a6447c-1a0b-4be9-ba89-3f5cb0aea142
            orderStatus: FAILED
          - accountId: 14
            phoneNumberCount: 2
            userId: team_ua
            lastModifiedDate: '2014-07-07T10:05:56.595Z'
            orderType: dlda
            orderDate: '2014-07-07T10:05:56.595Z'
            orderId: 743b0e64-3350-42e4-baa6-406dac7f4a85
            orderStatus: RECEIVED
          - accountId: 14
            phoneNumberCount: 2
            userId: team_ua
            lastModifiedDate: '2014-07-07T09:32:17.234Z'
            orderType: dlda
            orderDate: '2014-07-07T09:32:17.234Z'
            orderId: f71eb4d2-bfef-4384-957f-45cd6321185e
            orderStatus: RECEIVED
    dldaOrderIdGetXmlExampleResponse:
      description: example
      value: |-
        <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
        <DldaOrderResponse>
           <DldaOrder>
              <CustomerOrderId>testCustomerOrderId</CustomerOrderId>
              <OrderCreateDate>2014-07-10T12:38:11.833Z</OrderCreateDate>
              <AccountId>14</AccountId>
              <CreatedByUser>jbm</CreatedByUser>
              <OrderId>ea9e90c2-77a4-4f82-ac47-e1c5bb1311f4</OrderId>
              <LastModifiedDate>2014-07-10T12:38:11.833Z</LastModifiedDate>
              <ErrorList>
                 <Error>
                    <Code>16103</Code>
                    <Description>DL/DA information cannot be changed because the number is already being processed</Description>
                    <TelephoneNumber>+12053778335</TelephoneNumber>
                 </Error>
              </ErrorList>
              <ProcessingStatus>RECEIVED</ProcessingStatus>
              <DldaTnGroups>
                 <DldaTnGroup>
                    <TelephoneNumbers>
                       <TelephoneNumber>+12053778335</TelephoneNumber>
                       <TelephoneNumber>+12053865784</TelephoneNumber>
                    </TelephoneNumbers>
                    <SubscriberType>BUSINESS</SubscriberType>
                    <ListingType>LISTED</ListingType>
                    <ListingName>
                       <FirstName>Joe</FirstName>ś
                       <LastName>Smith</LastName>
                    </ListingName>
                    <ListAddress>true</ListAddress>
                    <Address>
                       <HouseNumber>12</HouseNumber>
                       <StreetName>ELM</StreetName>
                       <City>New York</City>
                       <StateCode>NY</StateCode>
                       <Zip>10007</Zip>
                       <Country>United States</Country>
                       <AddressType>Dlda</AddressType>
                    </Address>
                 </DldaTnGroup>
              </DldaTnGroups>
           </DldaOrder>
        </DldaOrderResponse>
    dldaOrderUpdateXmlPayloadExample:
      description: example
      value: |-
        <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
         <DldaOrder>
            <CustomerOrderId>testCustomerOrderId</CustomerOrderId>
             <DldaTnGroups>
                 <DldaTnGroup>
                     <TelephoneNumbers>
                         <TelephoneNumber>+15202217754</TelephoneNumber>
                     </TelephoneNumbers>
                     <SubscriberType>RESIDENTIAL</SubscriberType>
                     <ListingType>LISTED</ListingType>
                     <ListingName>
                         <FirstName>John</FirstName>
                         <FirstName2/>
                         <LastName>Smith</LastName>
                         <Designation/>
                         <TitleOfLineage/>
                         <TitleOfAddress/>
                         <TitleOfAddress2/>
                         <TitleOfLineageName2/>
                         <TitleOfAddressName2/>
                         <TitleOfAddress2Name2/>
                         <PlaceListingAs/>
                     </ListingName>
                     <ListAddress>true</ListAddress>
                     <Address>
                         <HousePrefix/>
                         <HouseNumber>915</HouseNumber>
                         <HouseSuffix/>
                         <PreDirectional/>
                         <StreetName>Elm</StreetName>
                         <StreetSuffix>Ave</StreetSuffix>
                         <PostDirectional/>
                         <AddressLine2/>
                         <City>Carpinteria</City>
                         <StateCode>CA</StateCode>
                         <Zip>93013</Zip>
                         <PlusFour/>
                         <County/>
                         <AddressType>DLDA</AddressType>
                     </Address>
                 </DldaTnGroup>
             </DldaTnGroups>
         </DldaOrder>
    dldaOrderUpdateJsonPayloadExample:
      value:
        customerOrderId: testCustomerOrderId
        dldaPhoneNumberGroups:
          - phoneNumbers:
              - '+12032081050'
            subscriberType: RESIDENTIAL
            listingType: LISTED
            listingName:
              firstName: John
              firstName2: ''
              lastName: Smith
              designation: ''
              titleOfLineage: ''
              titleOfAddress: ''
              titleOfAddress2: ''
              titleOfLineageName2: ''
              titleOfAddressName2: ''
              titleOfAddress2Name2: ''
              placeListingAs: ''
            listAddress: true
            address:
              housePrefix: ''
              houseNumber: '915'
              houseSuffix: ''
              preDirectional: ''
              streetName: Elm
              streetSuffix: Ave
              postDirectional: ''
              addressLine2: ''
              city: Carpinteria
              stateCode: CA
              zip: '93013'
              plusFour: ''
              county: ''
              addressType: DLDA
    dldaOrderIdGetJsonExampleResponse:
      value:
        customerOrderId: testCustomerOrderId
        orderCreateDate: '2014-07-10T12:38:11.833Z'
        accountId: 14
        createdByUser: jbm
        orderId: ea9e90c2-77a4-4f82-ac47-e1c5bb1311f4
        lastModifiedDate: '2014-07-10T12:38:11.833Z'
        errors:
          - code: 16103
            description: >-
              DL/DA information cannot be changed because the number is already
              being processed
            phoneNumber: '+12053778335'
        processingStatus: RECEIVED
        dldaPhoneNumberGroups:
          - phoneNumbers:
              - '+12053778335'
              - '+12053865784'
            subscriberType: BUSINESS
            listingType: LISTED
            listingName:
              firstName: Joe
              lastName: Smith
            listAddress: true
            address:
              houseNumber: '12'
              streetName: ELM
              city: New York
              stateCode: NY
              zip: '10007'
              country: United State
    dldaOrderIdGetHistoryXmlExampleResponse:
      description: |-
        The history payload is a set of history records, each of which contains:
            <table style="text-align: left; width: 80%;" border="1" cellpadding="2" cellspacing="2">
                <tbody>
                    <tr>
                        <td>OrderDate</td>
                        <td>The date that the order history event happened</td>
                    </tr>
                    <tr>
                        <td>Status</td>
                        <td>The new state of the DLDA order - RECEIVED, PROCESSING, COMPLETE, PARTIAL, FAILED</td>
                    </tr>
                    <tr>
                        <td>Note</td>
                        <td>A Note or additional information included with the state change </td>
                   </tr>
                   <tr>
                        <td>Author</td>
                        <td>The user id that implemented the state change</td>
                    </tr>
                </tbody>
            </table>
      value: |-
        <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
        <OrderHistoryWrapper>
           <OrderHistory>
              <OrderDate>2014-09-04T16:28:11.320Z</OrderDate>
              <Note>The DL/DA request has been received</Note>
              <Author>jbm</Author>
              <Status>RECEIVED</Status>
           </OrderHistory>
           <OrderHistory>
              <OrderDate>2014-09-04T16:28:18.742Z</OrderDate>
              <Note>The DL/DA request is being processed by our 3rd party supplier</Note>
              <Author>jbm</Author>
              <Status>PROCESSING</Status>
           </OrderHistory>
           <OrderHistory>
              <OrderDate>2014-09-05T19:00:17.968Z</OrderDate>
              <Note>The DL/DA request is complete for all TNs</Note>
              <Author>jbm</Author>
              <Status>COMPLETE</Status>
           </OrderHistory>
        </OrderHistoryWrapper>
    dldaOrderIdGetHistoryJsonExampleResponse:
      value:
        orderHistory:
          - orderDate: '2014-09-04T16:28:11.320Z'
            note: The DL/DA request has been received
            author: jbm
            status: RECEIVED
          - orderDate: '2014-09-04T16:28:18.742Z'
            note: The DL/DA request is being processed by our 3rd party supplier
            author: jbm
            status: PROCESSING
          - orderDate: '2014-09-05T19:00:17.968Z'
            note: The DL/DA request is complete for all TNs
            author: jbm
            status: COMPLETE
    dldaOrderUpdateXmlExampleResponse:
      value: |-
        <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
        <DldaOrderResponse>
           <DldaOrder>
              <CustomerOrderId>testCustomerOrderId</CustomerOrderId>
              <OrderCreateDate>2014-07-10T12:38:11.833Z</OrderCreateDate>
              <AccountId>14</AccountId>
              <CreatedByUser>team_ua</CreatedByUser>
              <OrderId>f179237b-c1cb-449d-9590-aaa9d0bf3ca4</OrderId>
              <LastModifiedDate>2014-07-17T12:21:02.644Z</LastModifiedDate>
              <ErrorList/>
              <ProcessingStatus>RECEIVED</ProcessingStatus>
              <DldaTnGroups>
                 <DldaTnGroup>
                    <TelephoneNumbers>
                       <TelephoneNumber>+12199347436</TelephoneNumber>
                    </TelephoneNumbers>
                    <SubscriberType>RESIDENTIAL/SubscriberType>
                    <ListingType>NON_LISTED</ListingType>
                    <ListingName>
                       <FirstName>John</FirstName>
                       <FirstName2/>
                       <LastName>Smith</LastName>
                       <Designation/>
                       <TitleOfLineage/>
                       <TitleOfAddress/>
                       <TitleOfAddress2/>
                       <TitleOfLineageName2/>
                       <TitleOfAddressName2/>
                       <TitleOfAddress2Name2/>
                       <PlaceListingAs/>
                    </ListingName>
                    <ListAddress>true</ListAddress>
                    <Address>
                       <HousePrefix/>
                       <HouseNumber>915</HouseNumber>
                       <HouseSuffix/>
                       <PreDirectional/>
                       <StreetName>Elm</StreetName>
                       <StreetSuffix>Ave</StreetSuffix>
                       <PostDirectional/>
                       <AddressLine2/>
                       <City>Carpinteria</City>
                       <StateCode>CA</StateCode>
                       <Zip>93013</Zip>
                       <PlusFour/>
                       <County/>
                       <Country>United States</Country>
                       <AddressType>Dlda</AddressType>
                    </Address>
                 </DldaTnGroup>
              </DldaTnGroups>
           </DldaOrder>
        </DldaOrderResponse>
    dldaOrderUpdateJsonExampleResponse:
      value:
        customerOrderId: testCustomerOrderId
        orderCreateDate: '2014-07-10T12:38:11.833Z'
        accountId: 14
        createdByUser: team_ua
        orderId: f179237b-c1cb-449d-9590-aaa9d0bf3ca4
        lastModifiedDate: '2014-07-17T12:21:02.644Z'
        errors: []
        processingStatus: RECEIVED
        dldaPhoneNumberGroups:
          - phoneNumbers:
              - '+12199347436'
            subscriberType: RESIDENTIAL
            listingType: NON_LISTED
            listingName:
              firstName: John
              firstName2: ''
              lastName: Smith
              designation: ''
              titleOfLineage: ''
              titleOfAddress: ''
              titleOfAddress2: ''
              titleOfLineageName2: ''
              titleOfAddressName2: ''
              titleOfAddress2Name2: ''
              placeListingAs: ''
            listAddress: true
            address:
              housePrefix: ''
              houseNumber: 915
              houseSuffix: ''
              preDirectional: ''
              streetName: Elm
              streetSuffix: Ave
              postDirectional: ''
              addressLine2: ''
              city: Carpinteria
              stateCode: CA
              zip: 93013
              plusFour: ''
              county: ''
              country: United States
              addressType: Dlda
    dldaOrderPostXmlPayloadExample:
      description: example
      value: |-
        <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
        <DldaOrder>
            <CustomerOrderId>testCustomerOrderId</CustomerOrderId>
            <DldaTnGroups>
                <DldaTnGroup>
                    <TelephoneNumbers>
                        <TelephoneNumber>+15202217754</TelephoneNumber>
                    </TelephoneNumbers>
                    <SubscriberType>RESIDENTIAL</SubscriberType>
                    <ListingType>LISTED</ListingType>
                    <ListingName>
                        <FirstName>John</FirstName>
                        <FirstName2/>
                        <LastName>Smith</LastName>
                        <Designation/>
                        <TitleOfLineage/>
                        <TitleOfAddress/>
                        <TitleOfAddress2/>
                        <TitleOfLineageName2/>
                        <TitleOfAddressName2/>
                        <TitleOfAddress2Name2/>
                        <PlaceListingAs/>
                    </ListingName>
                    <ListAddress>true</ListAddress>
                    <Address>
                        <HousePrefix/>
                        <HouseNumber>915</HouseNumber>
                        <HouseSuffix/>
                        <PreDirectional/>
                        <StreetName>Elm</StreetName>
                        <StreetSuffix>Ave</StreetSuffix>
                        <PostDirectional/>
                        <AddressLine2/>
                        <City>Carpinteria</City>
                        <StateCode>CA</StateCode>
                        <Zip>93013</Zip>
                        <PlusFour/>
                        <County/>
                        <AddressType>DLDA</AddressType>
                    </Address>
                </DldaTnGroup>
            </DldaTnGroups>
        </DldaOrder>
    dldaOrderPostJsonPayloadExample:
      description: Json request
      value:
        customerOrderId: testCustomerOrderId
        dldaPhoneNumberGroups:
          - phoneNumbers:
              - '+15202217754'
            subscriberType: RESIDENTIAL
            listingType: LISTED
            listingName:
              firstName: John
              firstName2: ''
              lastName: Smith
              designation: ''
              titleOfLineage: ''
              titleOfAddress: ''
              titleOfAddress2: ''
              titleOfLineageName2: ''
              titleOfAddressName2: ''
              titleOfAddress2Name2: ''
              placeListingAs: ''
            listAddress: true
            address:
              housePrefix: ''
              houseNumber: '915'
              houseSuffix: ''
              preDirectional: ''
              streetName: Elm
              streetSuffix: Ave
              postDirectional: ''
              addressLine2: ''
              city: Carpinteria
              stateCode: CA
              zip: '93013'
              plusFour: ''
              county: ''
              addressType: DLDA
    dldaOrderPostXmlExampleResponse:
      description: example
      value: |-
        <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
        <DldaOrderResponse>
           <DldaOrder>
              <CustomerOrderId>testCustomerOrderId</CustomerOrderId>
              <OrderCreateDate>2014-07-16T07:59:08.065Z</OrderCreateDate>
              <AccountId>14</AccountId>
              <CreatedByUser>team_ua</CreatedByUser>
              <OrderId>f2ac3343-5bff-424a-b8ca-975f5e7b159e</OrderId>
              <LastModifiedDate>2014-07-16T07:59:08.065Z</LastModifiedDate>
              <ErrorList/>
              <ProcessingStatus>RECEIVED</ProcessingStatus>
              <DldaTnGroups>
                 <DldaTnGroup>
                    <TelephoneNumbers>
                       <TelephoneNumber>+15202217754</TelephoneNumber>
                    </TelephoneNumbers>
                    <SubscriberType>RESIDENTIAL</SubscriberType>
                    <ListingType>LISTED</ListingType>
                    <ListingName>
                       <FirstName>John</FirstName>
                       <FirstName2/>
                       <LastName>Smith</LastName>
                       <Designation/>
                       <TitleOfLineage/>
                       <TitleOfAddress/>
                       <TitleOfAddress2/>
                       <TitleOfLineageName2/>
                       <TitleOfAddressName2/>
                       <TitleOfAddress2Name2/>
                       <PlaceListingAs/>
                    </ListingName>
                    <ListAddress>true</ListAddress>
                    <Address>
                       <HousePrefix/>
                       <HouseNumber>915</HouseNumber>
                       <HouseSuffix/>
                       <PreDirectional/>
                       <StreetName>Elm</StreetName>
                       <StreetSuffix>Ave</StreetSuffix>
                       <PostDirectional/>
                       <AddressLine2/>
                       <City>Carpinteria</City>
                       <StateCode>CA</StateCode>
                       <Zip>93013</Zip>
                       <PlusFour/>
                       <County/>
                       <Country>United States</Country>
                       <AddressType>Dlda</AddressType>
                    </Address>
                 </DldaTnGroup>
              </DldaTnGroups>
           </DldaOrder>
        </DldaOrderResponse>
    dldaOrderPostJsonExampleResponse:
      value:
        customerOrderId: testCustomerOrderId
        orderCreateDate: '2014-07-16T07:59:08.065Z'
        accountId: 14
        createdByUser: team_ua
        orderId: f2ac3343-5bff-424a-b8ca-975f5e7b159e
        lastModifiedDate: '2014-07-16T07:59:08.065Z'
        errors: []
        processingStatus: RECEIVED
        dldaPhoneNumberGroups:
          - phoneNumbers:
              - '+15202217754'
            subscriberType: RESIDENTIAL
            listingType: LISTED
            listingName:
              firstName: John
              firstName2: ''
              lastName: Smith
              designation: ''
              titleOfLineage: ''
              titleOfAddress: ''
              titleOfAddress2: ''
              titleOfLineageName2: ''
              titleOfAddressName2: ''
              titleOfAddress2Name2: ''
              placeListingAs: ''
            listAddress: true
            address:
              housePrefix: ''
              houseNumber: 915
              houseSuffix: ''
              preDirectional: ''
              streetName: Elm
              streetSuffix: Ave
              postDirectional: ''
              addressLine2: ''
              city: Carpinteria
              stateCode: CA
              zip: 93013
              plusFour: ''
              county: ''
              country: United States
              addressType: Dlda
    dldaOrderPost400XmlExampleResponse:
      value: |-
        <?xml version="1.0" encoding="UTF-8"?>
        <DldaOrderResponse>
           <ResponseStatus>
              <ErrorCode>16104</ErrorCode>
              <Description>No numbers for processing</Description>
           </ResponseStatus>
           <DldaOrder>
              <CustomerOrderId>REST Site</CustomerOrderId>
              <OrderCreateDate>2014-07-17T10:06:55.204Z</OrderCreateDate>
              <AccountId>14</AccountId>
              <CreatedByUser>team_ua</CreatedByUser>
              <LastModifiedDate>2014-07-17T10:06:55.204Z</LastModifiedDate>
              <ErrorList>
                 <Error>
                    <Code>5070</Code>
                    <Description>Telephone number is invalid.</Description>
                    <TelephoneNumber />
                 </Error>
              </ErrorList>
              <ProcessingStatus>FAILED</ProcessingStatus>
              <DldaTnGroups>
                 <DldaTnGroup>
                    <TelephoneNumbers>
                       <TelephoneNumber />
                    </TelephoneNumbers>
                    <SubscriberType>RESIDENTIAL</SubscriberType>
                    <ListingType>LISTED</ListingType>
                    <ListingName>
                       <FirstName>John</FirstName>
                       <FirstName2 />
                       <LastName>Smith</LastName>
                       <Designation />
                       <TitleOfLineage />
                       <TitleOfAddress />
                       <TitleOfAddress2 />
                       <TitleOfLineageName2 />
                       <TitleOfAddressName2 />
                       <TitleOfAddress2Name2 />
                       <PlaceListingAs />
                    </ListingName>
                    <ListAddress>true</ListAddress>
                    <Address>
                       <HousePrefix />
                       <HouseNumber>915</HouseNumber>
                       <HouseSuffix />
                       <PreDirectional />
                       <StreetName>Elm</StreetName>
                       <StreetSuffix>Ave</StreetSuffix>
                       <PostDirectional />
                       <AddressLine2 />
                       <City>Carpinteria</City>
                       <StateCode>CA</StateCode>
                       <Zip>93013</Zip>
                       <PlusFour />
                       <County />
                       <Country>United States</Country>
                       <AddressType>DLDA</AddressType>
                    </Address>
                 </DldaTnGroup>
              </DldaTnGroups>
           </DldaOrder>
        </DldaOrderResponse>
    dldaOrderPost400JsonExampleResponse:
      value:
        errorCode: 16104
        description: No numbers for processing
        dldaOrder:
          customerOrderId: testCustomerOrderId
          orderCreateDate: '2014-07-17T10:06:55.204Z'
          accountId: 14
          createdByUser: team_ua
          lastModifiedDate: '2014-07-17T10:06:55.204Z'
          errors:
            - code: 5070
              description: Phone number is invalid.
              telephoneNumber: ''
          processingStatus: FAILED
          dldaPhoneNumberGroups:
            - phoneNumbers:
                - ''
              subscriberType: RESIDENTIAL
              listingType: LISTED
              listingName:
                firstName: John
                firstName2: ''
                lastName: Smith
                designation: ''
                titleOfLineage: ''
                titleOfAddress: ''
                titleOfAddress2: ''
                titleOfLineageName2: ''
                titleOfAddressName2: ''
                titleOfAddress2Name2: ''
                placeListingAs: ''
              listAddress: true
              address:
                housePrefix: ''
                houseNumber: 915
                houseSuffix: ''
                preDirectional: ''
                streetName: Elm
                streetSuffix: Ave
                postDirectional: ''
                addressLine2: ''
                city: Carpinteria
                stateCode: CA
                zip: 93013
                plusFour: ''
                county: ''
                country: United States
                addressType: DLDA
tags:
  - name: TN Options
    description: Manage options for telephone numbers
  - name: LIDB Orders
    description: >-
      The LIDB Orders API enables usres to add or otherwise manage a request to
      add Calling Line Information to a phone number. The creation of a "Line
      Information Data Base (LIDB)" work order causes an update of a person's
      calling name identification in a network database. This is used to change
      the display of their name on the phone of the people that they call. Use a
      GET request on /accounts/{accountId}/lidbs to retrieve information about
      outstanding LIDBs orders and a POST to create those orders. A maximum of
      1,000 orders can be retrieved per request. If no date range or specific
      query parameter (marked by <b class="required">*</b> below) is provided,
      the order results will be limited to the last two years.
  - name: DLDA Orders
    description: >-
      The DLDA API enables users to create, update, retrieve, and list Directory
      Listing/Directory Assistance (DLDA) orders to update street addresses for
      telephone numbers. Use GET requests on /accounts/{accountId}/dldas to
      retrieve information about outstanding DLDA orders and POST to create new
      orders. A 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.
