Projects API

List projects

GET /pr_project
Accept: application/json
Authorization: Bearer 677a1598d208d6c303fa5ca1c774709250e21749
Name Required Type Description
order_by optional string Sorting
limit optional integer Limit
offset optional integer Offset
callback optional string Javascript callback

The following sort parameters may be applied:

  • id
  • name

The following scopes are needed:

  • project_show
Status: 200 OK
X-Authenticated-User: apiextract_1
Content-Length: 544
Content-Type: application/json
[
  {
    "id": 2,
    "nr": "00002",
    "name": "Villa Kunterbunt",
    "start_date": null,
    "end_date": null,
    "comment": "",
    "pr_state_id": 1,
    "pr_project_type_id": 1,
    "contact_id": 1,
    "contact_sub_id": null,
    "pr_invoice_type_id": null,
    "pr_invoice_type_amount": 0,
    "pr_budget_type_id": null,
    "pr_budget_type_amount": 0
  },
  {
    "id": 1,
    "nr": "00001",
    "name": "Projekt",
    "start_date": null,
    "end_date": null,
    "comment": null,
    "pr_state_id": 1,
    "pr_project_type_id": 1,
    "contact_id": 1,
    "contact_sub_id": null,
    "pr_invoice_type_id": null,
    "pr_invoice_type_amount": 0,
    "pr_budget_type_id": null,
    "pr_budget_type_amount": 0
  }
]

Search projects

POST /pr_project/search
Accept: application/json
Authorization: Bearer 677a1598d208d6c303fa5ca1c774709250e21749
[
  {
    "field": "name",
    "value": "Projekt"
  }
]
Name Required Type Description
order_by optional string Sorting
limit optional integer Limit
offset optional integer Offset
callback optional string Javascript callback

The following sort parameters may be applied:

  • id
  • name
Name Required Type Description
name optional string
contact_id optional string
pr_state_id optional string

The following scopes are needed:

  • project_show
Status: 200 OK
X-Authenticated-User: apiextract_1
Content-Length: 269
Content-Type: application/json
[
  {
    "id": 1,
    "nr": "00001",
    "name": "Projekt",
    "start_date": null,
    "end_date": null,
    "comment": null,
    "pr_state_id": 1,
    "pr_project_type_id": 1,
    "contact_id": 1,
    "contact_sub_id": null,
    "pr_invoice_type_id": null,
    "pr_invoice_type_amount": 0,
    "pr_budget_type_id": null,
    "pr_budget_type_amount": 0
  }
]

Show project

GET /pr_project/2
Accept: application/json
Authorization: Bearer 677a1598d208d6c303fa5ca1c774709250e21749
Name Required Type Description
callback optional string Javascript callback

The following scopes are needed:

  • project_show
Status: 200 OK
X-Authenticated-User: apiextract_1
Etag: f3f58019579aacacca6726f67fa81b48
Content-Length: 274
Content-Type: application/json
{
  "id": 2,
  "nr": "00002",
  "name": "Villa Kunterbunt",
  "start_date": null,
  "end_date": null,
  "comment": "",
  "pr_state_id": 1,
  "pr_project_type_id": 1,
  "contact_id": 1,
  "contact_sub_id": null,
  "pr_invoice_type_id": null,
  "pr_invoice_type_amount": 0,
  "pr_budget_type_id": null,
  "pr_budget_type_amount": 0
}

Create project

POST /pr_project
Accept: application/json
Authorization: Bearer 677a1598d208d6c303fa5ca1c774709250e21749
{
  "name": "Villa Kunterbunt",
  "contact_id": 1,
  "user_id": 1,
  "pr_state_id": 1,
  "pr_project_type_id": 1
}
Name Required Type Description
callback optional string Javascript callback
Name Required Type Description
contact_id required Resource contact
name required string (255)
pr_project_type_id required Resource pr_project_type
pr_state_id required Resource pr_state
user_id required Resource user
comment optional string (10000)
contact_sub_id optional Resource contact
end_date optional datetime (Format yyyy-mm-dd hh:ii:ss)
pr_budget_type_amount optional decimal This field can only be edited if the pr_budget_type is set. (Only supported for budget types: type_budgeted_costs and type_budgeted_hours)
pr_budget_type_id optional Resource pr_budget_type
pr_invoice_type_amount optional decimal This field can only be edited if the pr_invoice_type is set. (Only supported for invoice types: type_hourly_rate_project and type_fix)
pr_invoice_type_id optional Resource pr_invoice_type
pr_sub_state_id optional Resource pr_sub_state
start_date optional datetime (Format yyyy-mm-dd hh:ii:ss)

The following scopes are needed:

  • project_edit
Status: 201 Created
X-Authenticated-User: apiextract_1
Etag: f3f58019579aacacca6726f67fa81b48
Content-Length: 274
Content-Type: application/json
{
  "id": 2,
  "nr": "00002",
  "name": "Villa Kunterbunt",
  "start_date": null,
  "end_date": null,
  "comment": "",
  "pr_state_id": 1,
  "pr_project_type_id": 1,
  "contact_id": 1,
  "contact_sub_id": null,
  "pr_invoice_type_id": null,
  "pr_invoice_type_amount": 0,
  "pr_budget_type_id": null,
  "pr_budget_type_amount": 0
}

Overwrite project

PUT /pr_project/2
Accept: application/json
Authorization: Bearer 677a1598d208d6c303fa5ca1c774709250e21749
{
  "name": "Villa Kunterbunt",
  "contact_id": 1,
  "user_id": 1,
  "pr_state_id": 1,
  "pr_project_type_id": 1
}
Name Required Type Description
callback optional string
Name Required Type Description
contact_id required Resource contact
name required string (255)
pr_project_type_id required Resource pr_project_type
pr_state_id required Resource pr_state
user_id required Resource user
comment optional string (10000)
contact_sub_id optional Resource contact
end_date optional datetime (Format yyyy-mm-dd hh:ii:ss)
pr_budget_type_amount optional decimal This field can only be edited if the pr_budget_type is set. (Only supported for budget types: type_budgeted_costs and type_budgeted_hours)
pr_budget_type_id optional Resource pr_budget_type
pr_invoice_type_amount optional decimal This field can only be edited if the pr_invoice_type is set. (Only supported for invoice types: type_hourly_rate_project and type_fix)
pr_invoice_type_id optional Resource pr_invoice_type
pr_sub_state_id optional Resource pr_sub_state
start_date optional datetime (Format yyyy-mm-dd hh:ii:ss)

The following scopes are needed:

  • project_edit
Status: 200 OK
X-Authenticated-User: apiextract_1
Etag: f3f58019579aacacca6726f67fa81b48
Content-Length: 274
Content-Type: application/json
{
  "id": 2,
  "nr": "00002",
  "name": "Villa Kunterbunt",
  "start_date": null,
  "end_date": null,
  "comment": "",
  "pr_state_id": 1,
  "pr_project_type_id": 1,
  "contact_id": 1,
  "contact_sub_id": null,
  "pr_invoice_type_id": null,
  "pr_invoice_type_amount": 0,
  "pr_budget_type_id": null,
  "pr_budget_type_amount": 0
}

Edit project

POST /pr_project/2
Accept: application/json
Authorization: Bearer 677a1598d208d6c303fa5ca1c774709250e21749
{
  "name": "Villa Wunderlich"
}
Name Required Type Description
callback optional string Javascript callback
Name Required Type Description
comment optional string (10000)
contact_id optional Resource contact
contact_sub_id optional Resource contact
end_date optional datetime (Format yyyy-mm-dd hh:ii:ss)
name optional string (255)
pr_budget_type_amount optional decimal This field can only be edited if the pr_budget_type is set. (Only supported for budget types: type_budgeted_costs and type_budgeted_hours)
pr_budget_type_id optional Resource pr_budget_type
pr_invoice_type_amount optional decimal This field can only be edited if the pr_invoice_type is set. (Only supported for invoice types: type_hourly_rate_project and type_fix)
pr_invoice_type_id optional Resource pr_invoice_type
pr_project_type_id optional Resource pr_project_type
pr_state_id optional Resource pr_state
pr_sub_state_id optional Resource pr_sub_state
start_date optional datetime (Format yyyy-mm-dd hh:ii:ss)
user_id optional Resource user

The following scopes are needed:

  • project_edit
Status: 200 OK
X-Authenticated-User: apiextract_1
Etag: ab9234a7111a69fae64cbc04b6d8fa76
Content-Length: 274
Content-Type: application/json
{
  "id": 2,
  "nr": "00002",
  "name": "Villa Wunderlich",
  "start_date": null,
  "end_date": null,
  "comment": "",
  "pr_state_id": 1,
  "pr_project_type_id": 1,
  "contact_id": 1,
  "contact_sub_id": null,
  "pr_invoice_type_id": null,
  "pr_invoice_type_amount": 0,
  "pr_budget_type_id": null,
  "pr_budget_type_amount": 0
}

Delete project

DELETE /pr_project/2
Accept: application/json
Authorization: Bearer 677a1598d208d6c303fa5ca1c774709250e21749
Name Required Type Description
callback optional string Javascript callback

The following scopes are needed:

  • project_show
Status: 200 OK
X-Authenticated-User: apiextract_1
Content-Length: 16
Content-Type: application/json
{
  "success": true
}

Complete project

Complete/archive the project

POST /pr_project/1/archive
Accept: application/json
Authorization: Bearer 677a1598d208d6c303fa5ca1c774709250e21749
Name Required Type Description
callback optional string Javascript-Callback

The following scopes are needed:

  • project_show
Status: 200 OK
X-Authenticated-User: apiextract_1
Content-Length: 16
Content-Type: application/json
{
  "success": true
}

Activate project

Reactivate the project

POST /pr_project/1/reactivate
Accept: application/json
Authorization: Bearer 677a1598d208d6c303fa5ca1c774709250e21749
Name Required Type Description
callback optional string Javascript-Callback

The following scopes are needed:

  • project_show
Status: 200 OK
X-Authenticated-User: apiextract_1
Content-Length: 16
Content-Type: application/json
{
  "success": true
}