Wiki
Clone wikiNumera.LibrisAPI / device.activate
Home > API Reference Documentation > device.activate
device.activate
The device.activate action is used to activate a device (remove all of its device settings) and create a new event collector so the device has a fresh event history and can be distributed to a libris user. By default, an OTA message using the configured OTA for the partner realm will be placed in the device's mailbox. Users must be AGENT_SUPERVISOR or above to execute this command.
In some cases you may be activating a device from an inventory location into your realm (applies to dealers part of a network), in which case it is important to include the realm parameter or else the device may not be found properly.
Once you make this call, if appropriate for your network carrier, you may have to wait on your event receiver to receive an Activation or FailActivation event for the ultimate status of this call.
Input Parameters
| Property | Required | Description |
|---|---|---|
imei | yes, or name | The imei of the device you want to activate |
name | yes, or imei | The name of the device you want to activate |
realm | no | If you want to change the realm on the device, include a realm |
keep_existing_collector | no | Set to true if you do not want the event history to be cleared for the device (only the configuration) |
skip_ota | no | Set to true if you do not want an OTA mailbox message to be created for the device |
software_variant | no | Used to specify a variant of an OTA package (such as Spanish) |
name_on_activation | no | If you want to update the device name upon activation (must be unique in your realm) |
network_operator | no | Only set this value if it has not already been properly configured on the device, record |
network_settings | sometimes | For different network operators, you can supply an additional JSON object with a set of properties that can customize the activation: |
address1- For EOD, you can override the default address for the realm, by specifying address fieldscity- For EOD, you can override the default address for the realm, by specifying address fieldsstate- For EOD, you can override the default address for the realm, by specifying address fieldszip_code- For EOD, you can override the default address for the realm, by specifying address fieldsmsisdn- For RETAIL, you must specify the msisdn assigned to the device
settings | no | An array of setting objects you want to keep as part of the activation reset (otherwise everything is deleted), each setting needs the following structure: |
name- Setting namevalue- Setting value as a string, all values are strings
Output
There is no result object as long as the activation request was successful. You have to periodically poll the status of the device to watch for the completion of the activation.
Possible Status Codes
| Status Code | Reason | Description |
|---|---|---|
1000 | NO_IMEI | You have to send in the imei |
1001 | DEVICE_DOES_NOT_EXIST | The imei you supplied either does not exist or the user does not have permissions to use it |
1002 | REALM_CHANGE_NOT_ALLOWED | You are trying to change the realm, and the user does not have permissions to do that for this realm |
1003 | INVALID_NETWORK_OPERATOR | Needs to be either ATT_EOD or ATT_RETAIL |
1004 | INVALID_MSISDN | The msisdn you supplied is missing or invalid |
1005 | SUBMISSION_ERROR | Something unexpected happened with the data you submitted and the device was not submitted for activation, check the details property on the result object for more details |
1006 | DUPLICATE_NAME | The name you are using to update the device is a duplicate within your realm |
Updated