Lock Customer Devices
Lock Customer Devices API is used to enable and disable locking SIM to device feature for its own account’s subscribers (not his sub-accounts’ subscribers). Turning on or off this feature is done on the account level.
| HTTP URL | |
|---|---|
| POST | api/v2/customer/{id}/device-sim-lock |
Eligibility
The Requestor can enable or disable this feature for its own account (customer’s subscribers only).
API Request
Request Structure
| Element | Type | M/O/CM | Description |
|---|---|---|---|
| lockSimToDevice | boolean | M |
Enable or disable lock SIM to device feature for the customer itself.
|
API Response
Response Structure
| Parameter | Type | M/O/CM | Description |
|---|---|---|---|
| errorCode | String | O | Failure code. See list in ‘Error Codes’ section |
| errorMessage | String | O | Failure detailed description. See list in ‘Error Codes’ section |
| content | Object | O | Array of main response body object. Displayed when an API call was successful. For a failure it will be empty. |
| pageable | Object | O | Paging information object. Displayed when an API call was successful. For a failure it will be empty. |
Content data objects
| Element | Type | M/O/CM | Description |
|---|---|---|---|
| requestId | UUID | M | Request instance ID. To be used by external systems to query the call (operation) status, whether in progress, successful or failed. |
Pageable data objects
| Element | Type | M/O/CM | Description |
|---|---|---|---|
| page | Numeric | M | Page number |
| size | Numeric | M | Page size. Number of requested elements per page |
| totalPages | Numeric | M | Total amount of available pages per requested page size |
| totalElements | Numeric | M | Total amount of retrieved elements |
Error Codes
In addition to the general success and failure codes, the following error codes are possible.
| Code | Message |
|---|---|
| GLOBAL_1001 | Service unavailable. Please try again |
Examples
Request Body
Copy
{
"lockSimToDevice": true,
}
Response Body: Success ACK
Copy
{
"errorCode": "",
"errorMessage": "",
"content": [
{
"requestId": "ff74dca6-8e7f-4b85-a42b-13860913b370"
}
],
"pageable": {
"page": 0,
"size": 10,
"totalPages": 1,
"totalElements": 1
}
}
Response Body: Failure NAK
Copy
{
"errorCode": "GLOBAL_1001",
"errorMessage": "Service unavailable. Please try again",
"content": "",
"pageable": ""
}