Delete user
Purpose:
This function is used to delete users in Jodo.
Whenever user is deleted in external business application, the application must invoke this API to execute same action in Jodo platform.
Use Case:
When users are deleted in business applications – they will be automatically deleted in Jodo Platform as well.
User Input Parameters:
| Node | M/O | Data type size | Value | Description |
|---|---|---|---|---|
| method | M | Text | deleteUser | Unique Command for JSON Request. (This method value cannot be changed) |
| apikey | M | Text | test_org | Unique key map to an organisation. (This API key will change per client organisation) |
| loginid | M | Text | user12@avhan.com | Email id of user. (needs valid email ID) |
| reqdatetime | M | Text | 2018-11-12 14:00:05 | Date and Time of the request. (Date format: YYYY-MM-DD hh:mm:ss) |
Output Parameters:
| Node | Value | Description |
|---|---|---|
| method | deleteUser | Unique Command for JSON Response |
| resdatetime | 2018-11-12 14:00:05 | Date and Time of the response. (Date format: YYYY-MM-DD hh:mm:ss) |
| status | 3 | Refer the status parameter table |
| statusdesc | success | status parameter description |
| revisionno | 1 | Functionality revision number |
Return Value:
This API returns in one format I.e. JSON format.
Delete user JSON Request
"method":"deleteUser",
"apikey":"test_org",
"loginid":"Batman12@avhan.com",
"reqdatetime": "2018-11-12 14:00:05"
}
Delete User JSON Response
{
"method":"deleteUser",
"revisionno":"1",
"status":1,
"statusdesc":"success",
"resdatetime":"2018-11-12 14:00:05"
}
Delete User JSON Fail Response
{
"method":”deleteUser”,
"revisionno":"1",
"status":5,
"statusdesc":"fail",
"resdatetime":"2018-11-12 14:00:05"
}
Status Code Information
| Status | Status Description |
|---|---|
| 406 | loginID not found |
| 407 | loginID is blank |
| 408 | loginID is invalid |
| 418 | loginid not exists |
| 461 | Client login ID does not exists |