User Management

getUserListByAccountId

Description: Get existing users by providing the account ID

Implementation: URL/pub/usr/acc/[accountId]

Method: GET

Json example

Method: 
    GET http://api.example.com/usr/acc/2

getUser

Description: Get existing user

Implementation: URL/usr/[userId]

Method: GET

Json example

Method: 
    GET http://api.example.com/usr/4

addUser

Description: Add new user

Implementation: URL/usr/new

Method: POST/PUT

Requested parameters

Json example

Method: 
    POST http://api.example.com/usr/new
Request Header:
    Content-Type:text/javascript
Request Body:
    {
        "contactName":"John Doe",
        "emailAddress":"jhn.doe@example.com",
        "defaultAccountId":1,
        "username":"test",
        "password":"test"
    }

modifyUser

Description: Modify existing user

Implementation: URL/usr/[userId]

Method: POST/PUT

Requested parameters

Json example

Method: 
    POST http://api.example.com/usr/2
Request Header:
    Content-Type:text/javascript
Request Body:
    {
        "contactName":"John Doe modified",
        "emailAddress":"john.doe@example.com",
        "defaultAccountId":1,
        "username":"test",
        "password":"test",
        "active":"0"
    }

deleteUser

Description: Delete existing user

Implementation: URL/usr/[userId]

Method: DELETE

Json example

Method: 
    DELETE http://api.example.com/usr/2