api:iptv:flexcareorders:swap
Table of Contents
API : IPTV : FlexCare orders : Swap device
Introduction
This will swap out one device on a FlexCare license with another
Request
| URL | https://api.telecomx.dk/iptv/flexcareorder/swapdevice | |
|---|---|---|
| Method | POST | |
| Access level | RESELLER_ADMIN ADMIN |
|
| body | replaceDevice | deviceI d of device to swap out |
| toDevice | deviceId of device to replace “replaceDevice” | |
| reason | Enum(string) reason for swap, Possible values: 'NEW', 'WARRANTY' | |
| technicalRoomNumber | optional If wanted it is possible to edit/add technicalRoomNumber to 'toDevice' while swapping |
|
| usedRoomNumber | optional If wanted it is possible to edit/add usedRoomNumber to 'toDevice' while swapping |
|
| notes | optional If wanted it is possible to edit/add notes to 'toDevice' while swapping |
|
Query example
https://api.telecomx,dk/iptv/flexcareorder/swapdevice
Response
| JSON object | ||
|---|---|---|
| success | Boolean | True if device was swapped |
| newDevice | ObjectId | Unique id of the new device |
Errors
| Error code | Message | Description |
|---|---|---|
| 404 | id | Not found |
| 404 | licenseId | Not found |
| 404 | mac | replaceDevice missing |
| 404 | mac | New device mac missing |
| 500 | internal_error | Internal server error |
| 403 | access_denied | User doesn't have access to swap |
| 403 | access_denied | Only FlexCare customers have access to swap |
| 403 | Whitelist | Device not in whitelist |
| 400 | same_deviceid | Cant swap device with itself |
| 404 | reason | Reason was invalid or missing |
| 400 | type | Type on device: <replaceDevice> does not match type of <toDevice> |
| 400 | already_active | Device: <toDevice> is already active on another order |
api/iptv/flexcareorders/swap.txt · Last modified: 2024/03/27 09:02 by Mikkel Frederiksen