bwdb-14511 (#892)

* Add Code Snippets to Spec Files * Add Code Snippets to Spec Files * Add Code Snippets to Spec Files * Add Code Snippets to Spec Files * Add Code Snippets to Spec Files * Add Code Snippets to Spec Files * Add Code Snippets to Spec Files Co-authored-by: AJ Rice <[email protected]>
Bandwidth · Jan 17, 2023 · bde5b80 · bde5b80
1 parent 3755c71
commit bde5b80
Showing 1 changed file with 86 additions and 4 deletions.
diff --git a/site/specs/numbers.yml b/site/specs/numbers.yml
@@ -14148,6 +14148,39 @@ paths:
         ----WebKitFormBoundaryE19zNvXGzXaLvS5C <br>
 
         </code></p>
+
+        <p><b>Information for toll free port-in customers:</b></p>
+
+        <p>If you are porting toll free numbers and either of the following are
+        true, the port-in order requires a LOA document.</p>
+
+        <ul>
+
+        <li>The controlling and target RespOrg IDs have different entity values
+        (i.e. the first two characters are different).</li>
+
+        <li>The toll free port-in will cause toll free telephone numbers to move
+        from one Bandwidth account to another Bandwidth account.</li>
+
+        </ul>
+
+        <p>If a LOA is required, the LOA document must adhere to these
+        rules:</p>
+
+        <ul>
+
+        <li>The LOA document must be uploaded using MIME type "application/pdf",
+        or "image/tiff", as these are the only formats supported by our toll
+        free porting vendor.</li>
+
+        <li>The LOA document must be annotated as a LOA document using the
+        documentType query parameter or header value.</li>
+
+        </ul>
+
+        <p>If a LOA is required but a compliant LOA document has not been
+        uploaded, the toll free port-in order will remain in the Pending
+        Documents state until a valid LOA is provided.</p>
       operationId: UploadBulkLoa
       parameters:
         - $ref: '#/components/parameters/AccountIdPathParam'
@@ -14196,7 +14229,11 @@ paths:
             The response header will include a link to the created file as a GET
             on the identified resource.
         '400':
-          description: A 400 indicates that the requested upload failed.
+          description: 'Supported values for documentType are: LOA, INVOICE, CSR, or OTHER.'
+        '409':
+          description: >-
+            Conflicting values specified for documentType query parameter and
+            documentType header.
       summary: Upload bulk port-in order loa file
       tags:
         - Bulk Port-In
@@ -26879,8 +26916,9 @@ paths:
         key attribute to the POST is ensuring that the headers are correctly set
         to support the file upload.<br>
 
-        Query parameter or header documentType can be used to specify type of
-        document on upload. Possible values are: LOA, INVOICE, CSR, OTHER.
+        You may use either the documentType query parameter or the documentType
+        header parameter to specify the type of document you are uploading.
+        Possible values for documentType are: LOA, INVOICE, CSR, OTHER.
             <br>
         Header settings typical of a valid upload are...<br>
             <br>
@@ -26913,6 +26951,39 @@ paths:
         ----WebKitFormBoundaryE19zNvXGzXaLvS5C <br>
 
         </code>
+
+        <p><b>Information for toll free port-in customers:</b></p>
+
+        <p>If you are porting toll free numbers and either of the following are
+        true, the port-in order requires a LOA document.</p>
+
+        <ul>
+
+        <li>The controlling and target RespOrg IDs have different entity values
+        (i.e. the first two characters are different).</li>
+
+        <li>The toll free port-in will cause toll free telephone numbers to move
+        from one Bandwidth account to another Bandwidth account.</li>
+
+        </ul>
+
+        <p>If a LOA is required, the LOA document must adhere to these
+        rules:</p>
+
+        <ul>
+
+        <li>The LOA document must be uploaded using MIME type "application/pdf",
+        or "image/tiff", as these are the only formats supported by our toll
+        free porting vendor.</li>
+
+        <li>The LOA document must be annotated as a LOA document using the
+        documentType query parameter or header value.</li>
+
+        </ul>
+
+        <p>If a LOA is required but a compliant LOA document has not been
+        uploaded, the toll free port-in order will remain in the Pending
+        Documents state until a valid LOA is provided.</p>
       operationId: UploadPortinLoaFile
       parameters:
         - $ref: '#/components/parameters/AccountIdPathParam'
@@ -26963,7 +27034,18 @@ paths:
             The response header will include a link to the created file as a GET
             on the identified resource.
         '400':
-          description: A 400 indicates that the requested upload failed.
+          description: |
+            Supported values for documentType are: LOA, INVOICE, CSR, or OTHER.
+        '409':
+          description: >
+            <p>Conflicting values specified for documentType query parameter and
+            documentType header.</p>
+
+            <p>This order requires specification of the documentType using
+            either the query parameter or the header.</p>
+
+            <p>Document uploads for toll free port-ins must use the
+            application/pdf or image/tiff formats.</p>
       summary: Upload port-in loa file
       tags:
         - Porting