Top

Users

List Users
GET /projects/:project_id/users
Get list of user associated with a project.
Get a user
GET /projects/:project_id/users/:user_id
Get details of a user in a project.
Assign users
POST /projects/:project_id/users
Assign users to a project
Invite user
POST /projects/:project_id/users/invite
Invite and add user to the project.
Update user
PUT /projects/:project_id/users/:user_id
Update details of a user
Delete user
DELETE /projects/:project_id/users/:user_id
Remove user from the project.

List Users

GET  /projects/:project_id/users

Get list of user associated with a project.

Sample Response

Status: 200 OK
Content Type: application/json;charset=UTF-8
{
      "code": 0,
      "message": "success",
      "users": [
        {
          "user_id": "460000000024003",
          "is_current_user": true,
          "user_name": "John David",
          "email": "johndavid@zilliuminc.com",
          "user_role": "admin",
          "status": "active",
          "rate": 0.00,
          "budget_hours": 0
        }
      ]
    }

Get a user

GET  /projects/:project_id/users/:user_id

Get details of a user in a project.

Sample Response

Status: 200 OK
Content Type: application/json;charset=UTF-8
{
      "code": 0,
      "message": "success",
      "user": {
        "project_id": "460000000044007",
        "user_id": "460000000024003",
        "is_current_user": true,
        "user_name": "John David",
        "email": "johndavid@zilliuminc.com",
        "user_role": "admin"
      }
    }

Assign users

POST  /projects/:project_id/users

Assign users to a project

Request attributes

user_id* string ID of the user to be added to the project.
rate double Hourly rate of the user.
budget_hours int Budgeting a staff.

Sample Request

{
      "users": [
        {
          "user_id": "460000000024003",
          "rate": "",
          "budget_hours": ""
        }
      ]
    }

Sample Response

Status: 200 OK
Content Type: application/json;charset=UTF-8
{
      "code": 0,
      "message": "Users added",
      "users": [
        {
          "user_id": "460000000024003",
          "is_current_user": true,
          "user_name": "John David",
          "email": "johndavid@zilliuminc.com",
          "user_role": "admin",
          "status": "active",
          "rate": 0,
          "budget_hours": 0
        }
      ]
    }

Invite user

POST  /projects/:project_id/users/invite

Invite and add user to the project.

Request attributes

user_name* string
[200]
Name of the user.
email* string
[100]
Email of the user.
user_role string Role to be assigned.
Allowed Values: staff, admin and timesheetstaff
rate double Hourly rate for a task
budget_hours int Task budget hours

Sample Request

{
      "user_name": "John David",
      "email": "johndavid@zilliuminc.com",
      "user_role": "admin",
      "rate": "",
      "budget_hours": ""
    }

Sample Response

Status: 200 OK
Content Type: application/json;charset=UTF-8
{
      "code": 0,
      "message": "The staff has been added.",
      "user": {
        "project_id": "460000000044007",
        "user_id": "460000000024003",
        "is_current_user": true,
        "user_name": "John David",
        "email": "johndavid@zilliuminc.com",
        "user_role": "admin"
      }
    }

Update user

PUT  /projects/:project_id/users/:user_id

Update details of a user

Request attributes

user_name string
[200]
Name of the user.
user_role string Role to be assigned.
Allowed Values: staff, admin and timesheetstaff
rate double Hourly rate for a task
budget_hours int Task budget hours

Sample Request

{
      "user_name": "John David",
      "user_role": "admin",
      "rate": "",
      "budget_hours": ""
    }

Sample Response

Status: 200 OK
Content Type: application/json;charset=UTF-8
{
      "code": 0,
      "message": "The staff information has been updated",
      "user": {
        "project_id": "460000000044007",
        "user_id": "460000000024003",
        "is_current_user": true,
        "user_name": "John David",
        "email": "johndavid@zilliuminc.com",
        "user_role": "admin"
      }
    }

Delete user

DELETE  /projects/:project_id/users/:user_id

Remove user from the project.

Sample Response

Status: 200 OK
Content Type: application/json;charset=UTF-8
{"code": 0,"message":"The staff has been removed"}