api:iptv:servicecases:list
Table of Contents
API : IPTV : Service cases : List
Introduction
This will list all Service cases. They are global, and admin/resellerAdmin only
Request
| URL | https://api.telecomx.dk/iptv/servicecase | |
|---|---|---|
| Method | GET | |
| Access level | RESELLER ADMIN, ADMIN | |
| Query | offset | [optional] Index of the first Service cases to return, default is 0. |
| limit | [optional] The number of Service cases to return, default is 100. |
|
| filter | [optional] Used to filter Service cases, name is searched. |
|
| reseller | [optional] id of a reseller (24 hex-char string). Limits Service cases to a reseller. |
|
| device | [optional] mac address of device, to filter service cases for a single device |
|
Query examples
https://api.telecomx.dk/iptv/servicecase https://api.telecomx.dk/iptv/serviceagreement?offset=25&limit=50&filter=servicename&reseller=12345678901234567890ABCD
Response
| JSON object | ||
|---|---|---|
| offset | Number | Index of first Service case to return Default: 0, Min: 0, Max: 1000000 |
| limit | Number | Number of service cases to return Default: 100, Min: 1, Max: 500 |
| serviceCases | Array | List of <ServiceCase> objects (See further down) |
| total | Number | Total number of service cases found qith given query |
| ServiceCase object | ||
|---|---|---|
| _id | ObjecId | Unique id of the Service case |
| location | String | Location of where device is placed |
| ean | String | Ean number of Service case |
| incident | String | What is the issue |
| orderer | String | Name of orderer |
| powernetRef | String | Reference to PowerNet, Name / device |
| description | String | Description of what was done to fix the issue |
| device | String | DeviceId of device issue is related to |
| reseller | ObjectId | Unique id of reseller of the device |
| serviceDate | Date(ISO) | Date of when service case was resolved |
| ObjectId | Unique id of pdf file if pdf file is generated | |
| products | Array | List of products used in service case |
| products[].name | String | Name of product |
| products[].productCode | String | ProductCode of product |
| products[].price | Number | Price of product |
| products[].amount | Number | Amount of this product |
Errors
| Error code | Message | Description |
|---|---|---|
| 403 | access_denied | Insufficient access level |
| 404 | id | Service case not found |
| 500 | internal_error | <Unspecified> |
api/iptv/servicecases/list.txt · Last modified: 2023/11/29 10:12 by Mikkel Frederiksen