check_unique

To check whether a value is already used, use the core/check_unique method. You can check user names, resource names, phone numbers of units and drivers, and unique IDs of unit devices.

To check one user name, resource name, or phone number, use the following request:

svc=core/check_unique&params={
  "type": "<text>",
  "value": "<text>"
}

To check several values at once or the unique ID of a unit device, use the following request:

svc=core/check_unique&params={
  "items": [
    {
      "type": "<text>",
      "value": "<text>"
    },
    {
      "hwType": <long>,
      "uniqueId": "<text>"
    },
    ...
  ]
}

The request must contain either the type and value parameters or the items parameter. If the request contains both, the type and value parameters are used, and the items parameter is ignored.

If the value is unique, the following response is returned:

{
  "result": 0
}

If the value is already used, the following response is returned:

{
  "result": 1
}

If the type parameter has a value not listed in the table above, 0 is returned. The same applies to a device type ID that doesn’t exist.

If you check several values, an array is returned. Each element of the array contains the result for the corresponding element of the items array: 0 or 1. For example:

[0, 1, 0]

If the request fails, an error code is returned.

Below are examples of the core/check_unique request.

To check whether the john_smith user name is already used, specify user in the type parameter and the user name in the value parameter. Both parameters are required.

svc=core/check_unique&params={"type":"user","value":"john_smith"}

Response: {"result":1}. The user name is already used.

The request checks whether the 123456789012345 unique ID with the 96266 device type ID is already used. A unique ID can be checked only in the items array, so the array contains one element with the required hwType and uniqueId parameters.

svc=core/check_unique&params={"items":[{"hwType":96266,"uniqueId":"123456789012345"}]}

Don’t add the type and value parameters to this element, even with empty values. Otherwise, 0 is returned.

Response: [0]. The unique ID isn’t used.

The request checks the john_smith user name, the Delivery Service resource name, and the 123456789012345 unique ID with the 96266 device type ID.

svc=core/check_unique&params={"items":[{"type":"user","value":"john_smith"},{"type":"avl_resource","value":"Delivery Service"},{"hwType":96266,"uniqueId":"123456789012345"}]}

Response: [1,0,0]. The results are in the same order as the elements of the items array: the user name is already used, the resource name and the unique ID aren’t used.