API Access Token

v1_project API

/**
 * REST API end-points for interacting with the 'project', and related, resources.
 *
 */
Returns information about the 'project_classification' resource (referred to as 'resource' below) filterable by the fields described below.
The project_classification resource is mostly static and cannot be modified by the end user via the interface.
Resource response fields:
- 'project_classification_id' (primary key, number): The ID of the project_classification resource.
- 'project_classification_name' (string): The name of the resource.
- 'project_classification_description' (string): The description of the resource.
@return array of resources. Returns a single record if the project_classification_id is provided.
Field Description
Comma Separated list of columns to restrict results to. Order is kept. If field does not exist then column will be included, but a blank result will be returned
eg: "name,description,created_by"

Currently only enabled for GET requests using formats of HTML, TSV, CSV
Comma Separated list of columns to exclude from results.
Currently only enabled for GET requests using formats of HTML, TSV, CSV Note: Exclude field will be ignored if fields are supplied.
The unique ID of the desired resource. Returns a single record if it exists. Other filters do not apply.
  

Returns information about the 'project_type' resource (referred to as 'resource' below) filterable by the fields described below.
The project_type resource is dynamic and can be modified by the end user via the interface.
Resource response fields:
- 'project_type_id' (primary key, number): The ID of the project_type resource.
- 'project_type_name' (string): The name of the project type.
- 'project_type_description' (string): The description of the resource.
- 'is_deleted' (boolean): Whether the resource is considered deleted or not.
- 'created_on' (datetime): The date and time that the resource was originally created on.
- 'last_modified' (datetime): The date and time that the resource was last modified.
- 'max_last_modified' (datetime): The date and time that the resource is being requested. Used to query for only resources that have changed after this date and time on subsequent requests.
@return array of resources. Returns a single record if the project_type_id is provided.
Field Description
Comma Separated list of columns to restrict results to. Order is kept. If field does not exist then column will be included, but a blank result will be returned
eg: "name,description,created_by"

Currently only enabled for GET requests using formats of HTML, TSV, CSV
Comma Separated list of columns to exclude from results.
Currently only enabled for GET requests using formats of HTML, TSV, CSV Note: Exclude field will be ignored if fields are supplied.
Flag indicating if the resource is deleted or not. 0 = not deleted, 1 = deleted.
A datetime of which the resource was last modified in the format of YYYY-MM-DD HH:mm:ss. Returns records with a last_modified datetime value greater that the datetime provided.
The unique ID of the desired resource. Returns a single record if it exists. Other filters do not apply.
  

Returns information about the 'project' resource (referred to as 'resource' below) filterable by the fields described below.
The project resource is dynamic and can be modified by the end user via the interface.
Resource response fields:
- 'project_id' (primary key, number): The ID of the project resource.
- 'client_id' (foreign key, number): The ID of the client resource that the record belongs to.
- 'project_type_id' (foreign key, number): The ID of the project_type resource that the record belongs to.
- 'project_classification_id' (foreign key, number): The ID of the project_classification resource that the record belongs to.
- 'tag_ids' (number set): A set of tag resource IDs related to the record.
- 'project_name' (string): The human readable name of the project.
- 'project_description' (string): The human readable description of the project.
- 'required_skill_ids (number set as CSV): The ids of the required skills for the project
- 'required_vehicle_induction_ids' (number set a CSV): The ids of the required vehicle inductions for the project
- 'project_type_name' (string): The name of the project_type resource that the record belongs to. Corresponds to the 'project_type_id' field.
- 'project_classification_name' (string): The name of the project_classification resource that the record belongs to. Corresponds to the 'project_classification_id' field.
- 'is_deleted' (boolean): Whether the resource is considered deleted or not.
- 'created_on' (datetime): The date and time that the resource was originally created on.
- 'last_modified' (datetime): The date and time that the resource was last modified.
- 'max_last_modified' (datetime): The date and time that the resource is being requested. Used to query for only resources that have changed after this date and time on subsequent requests.
@return array of resources. Returns a single record if the project_id is provided.
Field Description
Comma Separated list of columns to restrict results to. Order is kept. If field does not exist then column will be included, but a blank result will be returned
eg: "name,description,created_by"

Currently only enabled for GET requests using formats of HTML, TSV, CSV
Comma Separated list of columns to exclude from results.
Currently only enabled for GET requests using formats of HTML, TSV, CSV Note: Exclude field will be ignored if fields are supplied.
The unique ID of the client to which the resource belongs.
Flag indicating if the resource is deleted or not. 0 = not deleted, 1 = deleted.
A datetime of which the resource was last modified in the format of YYYY-MM-DD HH:mm:ss. Returns records with a last_modified datetime value greater that the datetime provided.
The unique ID of the desired resource. Returns a single record if it exists. Other filters do not apply.
  

Creates a new project with the provided data.
@return array The single project record that has been created.
Field Description
An array of default client contact IDs that are associated with each new booking created within this project.
An array of client contact IDs that invoices will be sent to by default for each new booking created within this project.
An array of client contact IDs that dockets will be sent to by default for each new booking created within this project.
The ID of the client resource that the record belongs to. Required.
The ID of the project_classification resource that the record belongs to. Valid values: 1 = Project, 2 = Cottage.
The contract code of the project. Max length: 255.
The default purchase order number for bookings created within this project.
The description of the project. Max length: 255.
The name of the project. Max length: 255.
Whether a purchase order is required for plans created within this project. Valid values: 0 = No, 1 = Yes.
The ID of the project_type resource that the record belongs to.
An array of skill IDs that are required for bookings from this project.
An array of vehicle induction IDs that are required for bookings from this project.
An array of tag IDs that are associated with the project.
  

Updates a project with the provided data.
@return array The single project record that has been updated.
Field Description
An array of default client contact IDs that are associated with each new booking created within this project.
An array of client contact IDs that invoices will be sent to by default for each new booking created within this project.
An array of client contact IDs that dockets will be sent to by default for each new booking created within this project.
Whether the project is considered deleted or not. Valid values: 0 = No, 1 = Yes.
The ID of the project_classification resource that the record belongs to. Valid values: 1 = Project, 2 = Cottage.
The contract code of the project. Max length: 255.
The default purchase order number for bookings created within this project.
The description of the project. Max length: 255.
The ID of the project to update. Required.
Whether the project is considered active or not.
The name of the project. Max length: 255.
Whether a purchase order is required for plans created within this project. Valid values: 0 = No, 1 = Yes.
The ID of the project_type resource that the record belongs to.
An array of skill IDs that are required for the project.
An array of tag IDs that are associated with the project.