Post Test
|
Description |
Request that a new test is performed |
|
Production URL |
|
|
Sandbox URL |
|
|
Protocol |
HTTPS |
|
Request Method |
POST |
|
Response Format |
JSON |
|
Sample request |
https://api.chorus.co.nz/linetest/v1/tests/ Body: Content Type: Application/JSON { "productId": "1636028560", "test": { "testType": "ontStatus" } } |
Request Headers
|
Name |
Mandatory |
Description |
|
X-Chorus-Client-ID |
Y |
Client Id |
|
X-Chorus-Client-Secret |
Y |
Client Secret |
|
X-Transaction-ID |
Y |
Transaction ID |
JSON request payload
|
Name |
Mandatory |
Description |
Example |
|
productId |
Y |
Unique ID of the Product (i.e. ASID, Phone Number, Product ID). |
1636005484 |
|
test |
Y |
Test object |
- |
|
testType |
Y |
The type of test to execute for the product. |
One of: ontStatus, rgwBandwidth, statusOverTime, lineStateDiagnosis, nbltSingleLineTest; nbltElectricalLoopTest |
Response Header
|
Name |
Value |
|
Content-Type |
application/json; charset=UTF-8 |
|
X-Transaction-ID |
same value as the Request Header X-Transaction-ID |
|
Date |
response timestamp |
|
Content-Length |
response length |
|
X-Chorus-API-Version |
current version |
|
X-RateLimit-Limit |
refer to Rate Limiting |
|
X-RateLimit-Remaining |
refer to Rate Limiting |
|
X-RateLimit-Reset |
refer to Rate Limiting |
Response Body
For more information, refer to the RAML in Anypoint or the Line Test API workbook. While we have taken great care with the information in the Line Test API workbook if you find any differences between the Line Test API workbook and the RAML, then refer to the RAML as the correct reference.