Wiki
Clone wikiNumera.LibrisAPI / configuration.save
Home > API Reference Documentation > configuration.save
configuration.save
The configuration.save action is used to save configuration settings for a device or a realm. Through the input parameters you can control whether you are simply updating certain settings or if you are doing a complete replacement, in which any options you do not send in will be deleted from the device. If updating a device, you can also control whether the change in settings triggers an update message being sent to the device (it does by default).
Input Parameters
| Property | Required | Description |
|---|---|---|
realm | no | If you want to update a realm, which only users with AGENT_SUPERVISOR or above can do. |
imei | no | If you want to return the configuration for a device |
update_only | no | Set to true if you are only updating settings, OTHERWISE whatever you send in as the settings will replace the current configuration for the device. |
skip_mailbox | no | Set to true if you are updating a device's settings and you do not want the device to receive a mailbox message (by default, this automatically happens) |
settings | yes | An array of setting objects you want to update, each setting needs the following structure: * name - Setting name* value - Setting value as a string, all values are strings |
Output
A result object with the current settings so you can see your changes reflected:
| Property | Description |
|---|---|
settings | An array of setting objects: * name - Setting name* value - Setting value* source - Will tell you where the setting comes from, SYSTEM, DEVICE, or the name of the realm |
Possible Status Codes
| Status Code | Reason | Description |
|---|---|---|
1000 | NO_REALM_OR_IMEI | Missing information on request |
1001 | NO_SETTINGS_SENT | Nothing to save |
1002 | MISSING_NAME_OR_VALUE | one of the settings is missing a name or value (don't include something to make it null) |
1003 | DEVICE_DOES_NOT_EXIST | Bad realm or device |
Updated