Top

Projects

List projects
GET /projects
List all projects with pagination.
Get a project
GET /projects/:project_id
Get the details of a project.
Create a project
POST /projects
Create a project for your customer.
Update project
PUT /projects/:project_id
Update details of a project.
Delete project
DELETE /projects/:project_id
Deleting a existing project.
Activate project
POST /projects/:project_id/active
Mark project as active
Inactivate a project
POST /projects/:project_id/inactive
Marking a project as inactive.
Clone project
POST /projects/:project_id/clone
Cloning a project

List projects

GET  /projects

List all projects with pagination.

Parameters

filter_by string Filter projects by any status
Allowed Values: Status.All, Status.Active and Status.Inactive
customer_id string Search projects by customer id.
sort_column string Sort projects
Allowed Values: project_name, customer_name, rate and created_time

Sample Response

Status: 200 OK
Content Type: application/json;charset=UTF-8
{
      "code": 0,
      "message": "success",
      "projects": [
        {
          "project_id": "460000000044019",
          "project_name": "REAL TIME TRAFFIC FLUX",
          "customer_id": "460000000044011",
          "customer_name": "SAF Instruments Inc",
          "description": "A simple algorithm is to be tested with vehicle detection application.  ",
          "status": "active",
          "billing_type": "fixed_cost_for_project",
          "rate": 5000.00,
          "created_time": "2013-09-18T18:05:27+0530"
        },
        {
          "project_id": "460000000044007",
          "project_name": "Network Distribution",
          "customer_id": "460000000044001",
          "customer_name": "Richards Electric Company",
          "description": "Distribution for the system of intermediaries between the producer of goods and/or services and the final user",
          "status": "active",
          "billing_type": "based_on_task_hours",
          "created_time": "2013-09-18T17:41:53+0530"
        }
      ],
      "page_context": {
        "page": 1,
        "per_page": 200,
        "has_more_page": false,
        "report_name": "Projects",
        "sort_column": "created_time",
        "sort_order": "D"
      }
    }

Get a project

GET  /projects/:project_id

Get the details of a project.

Sample Response

Status: 200 OK
Content Type: application/json;charset=UTF-8
{
      "code": 0,
      "message": "success",
      "project": {
        "project_id": "460000000044007",
        "project_name": "Network Distribution",
        "customer_id": "460000000044001",
        "customer_name": "Richards Electric Company",
        "currency_code": "USD",
        "description": "Distribution for the system of intermediaries between the producer of goods and/or services and the final user",
        "status": "active",
        "billing_type": "based_on_task_hours",
        "budget_type": "",
        "total_hours": "12:26",
        "billed_hours": "12:26",
        "un_billed_hours": "00:00",
        "created_time": "2013-09-18T17:41:53+0530",
        "tasks": [
          {
            "task_id": "460000000044009",
            "task_name": "Distribution Analysis",
            "description": "",
            "rate": 25.00,
            "budget_hours": 0,
            "total_hours": "12:26",
            "billed_hours": "12:26",
            "un_billed_hours": "00:00"
          }    ],
        "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,
            "total_hours": "12:26",
            "billed_hours": "12:26",
            "un_billed_hours": "00:00"
          }
        ]
      }
    }

Create a project

POST  /projects

Create a project for your customer.

Request attributes

project_name* string
[100]
Name of the project
customer_id* string ID of the customer.
description string
[500]
Project description
billing_type* string The way you bill your customer.
Allowed Values: fixed_cost_for_project, based_on_project_hours, based_on_staff_hours and based_on_task_hours
rate double Hourly rate for a task
budget_type string The way you budget.
Allowed Values: total_project_cost, total_project_hours, hours_per_task and hours_per_staff
budget_hours int Task budget hours
budget_amount double Give value, if you are estimating total project cost.
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.
task_name* string
[100]
Name of the task.
description string
[500]
Task description.
rate double Hourly rate of a task.
budget_hours int Task budgeting.

Sample Request

{
      "project_name": "Network Distribution",
      "customer_id": "460000000044001",
      "description": "Distribution for the system of intermediaries between the producer of goods and/or services and the final user",
      "billing_type": "based_on_task_hours",
      "rate": "",
      "budget_type": "",
      "budget_hours": "",
      "budget_amount": "",
      "users": [
        {
          "user_id": "460000000024003",
          "rate": 0.00,
          "budget_hours": 0
        }
      ],
      "tasks": [
        {
          "task_name": "Distribution Analysis",
          "description": "",
          "rate": 25.00,
          "budget_hours": 0
        }
      ]
    }

Sample Response

Status: 201 Created
Content Type: application/json;charset=UTF-8
{
      "code": 0,
      "message": "The project has been created.",
      "project": {
        "project_id": "460000000044007",
        "project_name": "Network Distribution",
        "customer_id": "460000000044001",
        "customer_name": "Richards Electric Company",
        "currency_code": "USD",
        "description": "Distribution for the system of intermediaries between the producer of goods and/or services and the final user",
        "status": "active",
        "billing_type": "based_on_task_hours",
        "budget_type": "",
        "total_hours": "12:26",
        "billed_hours": "12:26",
        "un_billed_hours": "00:00",
        "created_time": "2013-09-18T17:41:53+0530",
        "tasks": [
          {
            "task_id": "460000000044009",
            "task_name": "Distribution Analysis",
            "description": "",
            "rate": 25.00,
            "budget_hours": 0,
            "total_hours": "12:26",
            "billed_hours": "12:26",
            "un_billed_hours": "00:00"
          }
        ],
        "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,
            "total_hours": "12:26",
            "billed_hours": "12:26",
            "un_billed_hours": "00:00"
          }
        ]
      }
    }

Update project

PUT  /projects/:project_id

Update details of a project.

Request attributes

project_name* string
[100]
Name of the project
customer_id* string ID of the customer.
description string
[500]
Project description
billing_type* string
[100]
The way you bill your customer.
Allowed Values: fixed_cost_for_project, based_on_project_hours, based_on_staff_hours and based_on_task_hours
rate double Hourly rate for a task
budget_type string
[100]
The way you budget.
Allowed Values: total_project_cost, total_project_hours, hours_per_task and hours_per_staff
budget_hours int Task budget hours
budget_amount double Give value, if you are estimating total project cost.
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.
task_name* string
[100]
Name of the task.
description string
[500]
Task description.
rate double Hourly rate of a task.
budget_hours int Task budgeting.

Sample Request

{
      "project_name": "Network Distribution",
      "customer_id": "460000000044001",
      "description": "Distribution for the system of intermediaries between the producer of goods and/or services and the final user",
      "billing_type": "based_on_task_hours",
      "rate": "",
      "budget_type": "",
      "budget_hours": "",
      "budget_amount": "",
      "users": [
        {
          "user_id": "460000000024003",
          "rate": 0,
          "budget_hours": 0
        }
      ],
      "tasks": [
        {
          "task_id": "460000000044009",
          "task_name": "Distribution Analysis",
          "description": "",
          "rate": 25,
          "budget_hours": 0
        }
      ]
    }

Sample Response

Status: 200 OK
Content Type: application/json;charset=UTF-8
{
      "code": 0,
      "message": "The project information has been updated.",
      "project": {
        "project_id": "460000000044007",
        "project_name": "Network Distribution",
        "customer_id": "460000000044001",
        "customer_name": "Richards Electric Company",
        "currency_code": "USD",
        "description": "Distribution for the system of intermediaries between the producer of goods and/or services and the final user",
        "status": "active",
        "billing_type": "based_on_task_hours",
        "rate": 0.00,
        "budget_type": "",
        "budget_hours": 0,
        "budget_amount": 0.00,
        "total_hours": "12:26",
        "billed_hours": "12:26",
        "un_billed_hours": "00:00",
        "created_time": "2013-09-18T17:41:53+0530",
        "tasks": [
          {
            "task_id": "460000000044009",
            "task_name": "Distribution Analysis",
            "description": "",
            "rate": 25.00,
            "budget_hours": 0,
            "total_hours": "12:26",
            "billed_hours": "12:26",
            "un_billed_hours": "00:00"
          }
        ],
        "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,
            "total_hours": "12:26",
            "billed_hours": "12:26",
            "un_billed_hours": "00:00"
          }
        ]
      }
    }

Delete project

DELETE  /projects/:project_id

Deleting a existing project.

Sample Response

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

Activate project

POST  /projects/:project_id/active

Mark project as active

Sample Response

Status: 200 OK
Content Type: application/json;charset=UTF-8
{
      "code": 0,
      "message": "The selected Projects have been marked as active."
    }

Inactivate a project

POST  /projects/:project_id/inactive

Marking a project as inactive.

Sample Response

Status: 200 OK
Content Type: application/json;charset=UTF-8
{
      "code": 0,
      "message": "The selected projects have been marked as inactive."
    }

Clone project

POST  /projects/:project_id/clone

Cloning a project

Request attributes

project_name* string
[100]
Name of the project
description string
[500]
Project description

Sample Request

{
      "project_name": "Network distribution version 1.1",
      "description": ""
    }

Sample Response

Status: 201 Created
Content Type: application/json;charset=UTF-8
{
      "code": 0,
      "message": "Project has been cloned successfully.",
     "project": {
        "project_id": "460000000044007",
        "project_name": "Network Distribution version 1.1",
        "customer_id": "460000000044001",
        "customer_name": "Richards Electric Company",
        "currency_code": "USD",
        "description": "Distribution for the system of intermediaries between the producer of goods and/or services and the final user",
        "status": "active",
        "billing_type": "based_on_task_hours",
        "budget_type": "",
        "total_hours": "12:26",
        "billed_hours": "12:26",
        "un_billed_hours": "00:00",
        "created_time": "2013-09-18T17:41:53+0530",
        "tasks": [
          {
            "task_id": "460000000044009",
            "task_name": "Distribution Analysis",
            "description": "",
            "rate": 25.00,
            "budget_hours": 0,
            "total_hours": "12:26",
            "billed_hours": "12:26",
            "un_billed_hours": "00:00"
          }
        ],
        "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,
            "total_hours": "12:26",
            "billed_hours": "12:26",
            "un_billed_hours": "00:00"
          }
        ]
      }
    }