3.04 List of Users
Connection URL
TEST URL | http://nap.dev.icash.bg/clientapi/v1/get-users |
( AL ) PRODUCTION URL | https://v1.icash.al/clientapi/v1/get-users |
( BG ) PRODUCTION URL | https://v5.icash.bg/clientapi/v1/get-users |
POST REQUEST
Param | Description | Field type | Required |
api_key | API Key | String | YES |
nonce | Nonce | Integer | YES |
signature | Signature | String | YES |
ses | Session indentificator | String | YES |
JSON response on success
Param | Description | Field type | Required |
nonce | Nonce from request | Integer | YES |
status | Request status | Integer
1 – successful |
YES |
data | User list | Array of Item |
Structure of type “Item”
Param | Description | Field type | Required |
UserID | Indentificator | Integer | YES |
UserActive | Active(0-No, 1-YES) | Integer | YES |
UserRole | Role | enum(‘user’, ‘admin’, ‘odit’) | YES |
UserRealName | Name | String | YES |
Example:
{ „nonce“: „1552998320“, „status“: 1, „data“: [ { „UserID“: 1, „UserActive“: 1, „UserRole“: „admin“, „UserRealName“: „John Smith“ }, { „UserID“: 2, „UserActive“: 1, „UserRole“: „user“, „UserRealName“: „John Smith 2“ } ] } |
JSON response on unsuccess
Param | Description | Field type | Required |
nonce | Nonce from request | Integer | YES |
status | Request status | Integer
0 – unsuccess request |
YES |
error_message | Error Description | String | YES |
Example on unsuccess:
{ „nonce“: „1552990901“, „status“: 0, „error_message“: „Session expired“ } |