api:sim:assign
Table of Contents
API : SIM Assign
Introduction
This request will register the SIM card as being in storage at the customer or reseller specified.
Request
| URL | https://api.telecomx.dk/sim/SIM_ID/assign | |
|---|---|---|
| Method | GET | |
| Access level | RESELLER if the SIM is in storage at the reseller and the target customer belongs to the reseller. RESELLER_ADMIN. ADMIN. |
|
| Param | SIM_ID | SIM card number (ICC) |
| Query | customer | Id of the customer the SIM card should be registered as being in storage at |
| autoAssign | True to mark as auto-assign SIM, false to not. Defaults to false. Auto-assign SIMs must have form factor MINI_MICRO_NANO. | |
Query example
GET https://api.telecomx.dk/sim/1234567890123456789/assign?customer=1234567890ABCDEF12345678 GET https://api.telecomx.dk/sim/1234567890123456789/assign?customer=1234567890ABCDEF12345678&autoAssign=true
Response
| Json object | ||
|---|---|---|
| success | Boolean | True on success |
Example
{ "success": true }
Errors
| Error code | Message | Description |
|---|---|---|
| 422 | id | SIM id is invalid |
| 404 | customer | Customer id is missing |
| 422 | customer | Customer id is invalid |
| 404 | not_found | SIM not found (or, for resellers, not in storage at the reseller) |
| 409 | autoAssign | Auto-assign SIMs must use MINI_MICRO_NANO as formFactor |
| 403 | access_denied | Insufficient access level |
| 500 | internal_error | <Unspecified> |
api/sim/assign.txt · Last modified: by Mikkel Meerwaldt Jørgensen