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

Commit d3492a8

Browse files
aharin90akharin
aharin90
and
akharin
authored
csr and bulkportin updates (#742)
Co-authored-by: akharin <[email protected]>
1 parent 0424b2d commit d3492a8

File tree

1 file changed

+32
-2
lines changed

1 file changed

+32
-2
lines changed

‎site/specs-temp/numbers.json

Lines changed: 32 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20728,15 +20728,19 @@
2072820728
"type": "object",
2072920729
"properties": {
2073020730
"first": {
20731+
"description": "The first (or only) page of results matching the query.",
2073120732
"type": "string"
2073220733
},
2073320734
"next": {
20735+
"description": "If more results exist than specified by 'size', this link returns the next page of 'size' results.",
2073420736
"type": "string"
2073520737
},
2073620738
"previous": {
20739+
"description": "If the results are more than one page, this link returns the previous page of 'size' results.",
2073720740
"type": "string"
2073820741
},
2073920742
"last": {
20743+
"description": "If more results exist than specified by 'size', this link return the last page of result.",
2074020744
"type": "string"
2074120745
}
2074220746
}
@@ -20825,6 +20829,7 @@
2082520829
"EmergencyNotificationRecipientWithTts": {
2082620830
"description": "Emergency Notification Recipient with tts.",
2082720831
"type": "object",
20832+
"description": "The list of child, or subtending, orders associated with a bulk port-in. The bulk port-in will have an empty PortinList until telephone numbers are added using the /tnList endpoint.",
2082820833
"properties": {
2082920834
"Identifier": {
2083020835
"$ref": "#/components/schemas/RecipientIdentifier"
@@ -21625,7 +21630,8 @@
2162521630
}
2162621631
},
2162721632
"RetryValidation": {
21628-
"type": "boolean"
21633+
"type": "boolean",
21634+
"description": "This element is only applicable in the PUT and PATCH payloads for a bulk port-in that is in the INVALID_DRAFT_TNS state due to a failure to retrieve carrier or RespOrg ownership for telephone numbers in the tnList. If these conditions are met, including RetryValidation with a value of true will cause a fresh attempt to retrieve this information without requiring a change to the tnList."
2162921635
}
2163021636
}
2163121637
},
@@ -21858,6 +21864,7 @@
2185821864
},
2185921865
"PortinList": {
2186021866
"type": "object",
21867+
"description": "The list of child, or subtending, orders associated with a bulk port-in. The bulk port-in will have an empty PortinList until telephone numbers are added using the /tnList endpoint.",
2186121868
"properties": {
2186221869
"PortinList": {
2186321870
"type": "array",
@@ -21871,6 +21878,7 @@
2187121878
"type": "object",
2187221879
"properties": {
2187321880
"PortinOrderId": {
21881+
"description": "The OrderId associated with a child, or subtending, order associated with the bulk port-in.",
2187421882
"type": "string"
2187521883
}
2187621884
}
@@ -26119,6 +26127,7 @@
2611926127
"type": "string"
2612026128
},
2612126129
"OrderCreateDate": {
26130+
"description": "The date and time when the order was created.",
2612226131
"type": "string"
2612326132
},
2612426133
"OrderId": {
@@ -29148,18 +29157,23 @@
2914829157
"items": {
2914929158
"properties": {
2915029159
"OrderId": {
29160+
"description": "The unique identifier string created by Bandwidth to refer to the order. This value is returned in the synchronous response to the POST.",
2915129161
"type": "string"
2915229162
},
2915329163
"CompanyName": {
29164+
"description": "The name associated with the Bandwidth account that created this order.",
2915429165
"type": "string"
2915529166
},
2915629167
"LastModifiedBy": {
29168+
"description": "The username that last modified the order. This may show as \"System\" if the order was last modified by Bandwidth automated software.",
2915729169
"type": "string"
2915829170
},
2915929171
"LastModifiedDate": {
29172+
"description": "The date and time on which the order was last modified, including status updates.",
2916029173
"type": "string"
2916129174
},
2916229175
"OrderCreateDate": {
29176+
"description": "The date and time when the order was created.",
2916329177
"type": "string"
2916429178
},
2916529179
"PortinList": {
@@ -29180,6 +29194,7 @@
2918029194
]
2918129195
},
2918229196
"RequestedFocDate": {
29197+
"description": "This is the FOC (Final Order Commit) date requested by the person (or machine) creating the order.",
2918329198
"type": "string"
2918429199
}
2918529200
}
@@ -29274,10 +29289,11 @@
2927429289
]
2927529290
},
2927629291
"OrderId": {
29277-
"description": "This is Bandwidth Oder ID.",
29292+
"description": "The unique identifier string created by Bandwidth to refer to the order. This value is returned in the synchronous response to the POST.",
2927829293
"type": "string"
2927929294
},
2928029295
"PortableTnList": {
29296+
"description": "This is a list of all of the telephone numbers from the tnList that were validated and are known to be portable.",
2928129297
"type": "array",
2928229298
"items": {
2928329299
"properties": {
@@ -29288,6 +29304,7 @@
2928829304
}
2928929305
},
2929029306
"NotValidatedTnList": {
29307+
"description": "This is a list of any telephone numbers from the tnList that have not yet been validated.",
2929129308
"type": "array",
2929229309
"items": {
2929329310
"properties": {
@@ -29298,12 +29315,15 @@
2929829315
}
2929929316
},
2930029317
"ChildPortinOrderList": {
29318+
"description": "This is a list of any telephone numbers from the tnList that have not yet been validated.",
2930129319
"type": "object",
2930229320
"properties": {
2930329321
"ChildPortinOrder": {
29322+
"description": "The list of child, or subtending, orders associated with a bulk port-in. The bulk port-in will have an empty ChildPortinOrderList if none of the telephone numbers included in the /tnList are portable.",
2930429323
"type": "object",
2930529324
"properties": {
2930629325
"OrderId": {
29326+
"description": "The unique identifier string created by Bandwidth to refer to the order. This value is returned in the synchronous response to the POST.",
2930729327
"type": "string"
2930829328
},
2930929329
"TnList": {
@@ -29322,6 +29342,7 @@
2932229342
},
2932329343
"ChildPortinOrder": {
2932429344
"type": "object",
29345+
"description": "The OrderId and TnList of a child order associated with a bulk port-in. A child order is created for each set of telephone numbers that can be ported together. This element shows which telephone numbers are associated with each child order.",
2932529346
"properties": {
2932629347
"OrderId": {
2932729348
"type": "string"
@@ -29340,6 +29361,7 @@
2934029361
},
2934129362
"ErrorList": {
2934229363
"type": "array",
29364+
"description": "The list of errors (if any) associated with the telephone numbers in the tnList.",
2934329365
"items": {
2934429366
"properties": {
2934529367
"Error": {
@@ -31072,6 +31094,7 @@
3107231094
"type": "string"
3107331095
},
3107431096
"OrderCreateDate": {
31097+
"description": "The date and time on which the CSRS order was created.",
3107531098
"type": "string"
3107631099
},
3107731100
"AccountId": {
@@ -31087,9 +31110,11 @@
3108731110
"type": "string"
3108831111
},
3108931112
"Status": {
31113+
"description": "The state of the CSRS order. Possible values are: COMPLETE, FAILED.",
3109031114
"type": "string"
3109131115
},
3109231116
"AccountNumber": {
31117+
"description": "The account number that the telephone number being queried is associated with on the carrier that currently hosts that number.",
3109331118
"type": "string"
3109431119
},
3109531120
"AccountTelephoneNumber": {
@@ -31140,12 +31165,15 @@
3114031165
"type": "string"
3114131166
},
3114231167
"CustomerName": {
31168+
"description": "The subscriber name associated with the telephone number being queried.",
3114331169
"type": "string"
3114431170
},
3114531171
"ServiceAddress": {
3114631172
"type": "object",
31173+
"description": "The service address associated with the telephone number being queried.",
3114731174
"properties": {
3114831175
"UnparsedAddress": {
31176+
"description": "The service address other than the City, State, and ZIP.",
3114931177
"type": "string"
3115031178
},
3115131179
"City": {
@@ -31163,10 +31191,12 @@
3116331191
}
3116431192
},
3116531193
"WorkingTelephoneNumber": {
31194+
"description": "The telephone number for which the CSR was retrieved.",
3116631195
"type": "string"
3116731196
},
3116831197
"WorkingTelephoneNumbersOnAccount": {
3116931198
"type": "array",
31199+
"description": "The list of all telephone numbers on the account, associate with the billing telephone number.",
3117031200
"items": {
3117131201
"$ref": "#/components/schemas/TelephoneNumber"
3117231202
}

0 commit comments

Comments
 (0)