Get Tests by Product ID
|
Description |
Request all test results for a given Product ID |
|
Production URL |
https://api.chorus.co.nz/linetest/v1/tests?productId={productId}&count={count}&offset={offset} |
|
Sandbox URL |
|
|
Protocol |
HTTPS |
|
Request Method |
GET |
|
Response Format |
JSON |
|
Sample request |
https://api.chorus.co.nz/linetest/v1/tests?productId=1636028560&count=20&offset=5 |
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 |
Query parameters
|
Name |
Mandatory |
Description |
Example |
|
productId |
Y |
Unique ID of the Product (i.e. ASID, Phone Number, Product ID). |
1636028560 |
|
count |
N |
Number of tests to return in the response. Maximum 20. Default of 20 |
20 |
|
offset |
N |
Offset provides pagination by skipping N records. An offset of 5 and count of 5 would return tests 6 to 10 (test 1 would be the most recently run test). |
5 |
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.