API Access Token

v1_item_classification API

/**
 * REST API end-points for interacting with the 'resource' resource.
 *
 */

Sign in

Available APIs

v1_active_people v1_asignit v1_asset v1_booking v1_booking_client_contact v1_client v1_client_contact v1_depot v1_document_type v1_driver_licence_type v1_equipment v1_files v1_form v1_invoice v1_item_classification v1_lookup v1_permit v1_person v1_project v1_resource v1_sage_50 v1_skill v1_tag v1_upload v1_vehicle v1_works_docket

Methods

item_classification_resource GET POST PUT DELETE DELETED

item_classification GET POST PUT DELETE DELETED

Help

Definitions

primary keyIndicates that the related field is a primary key and uniquely identifies the record.
composite keyIndicates that the related field is part of a composite primary key which as a whole, uniquely identifies the record.
foreign keyIndicates that the related field refers to another resource record. The foreign resource is often named as the prefix of the field. Eg; project_id is a foreign key to a 'project' resource.
stringA data type containing alpha-numeric characters of variable length.
numberA data type of positive or negative decimal number.
datetimeA data type representing a date and time in the format of YYYY-MM-DD HH:MM:SS.
booleanA data type representing a true or false state with the possible values of 0 (false), 1 (true) or null (undetermined).
[data type] setA set/list of data types. Depending on the response format, the set may be represented as CSV or JSON array of the corresponding data type.

T-2.961.1

Release Notes

GET item_classification_resource
/api_third_party/v1_item_classification/item_classification_resource

Description	Returns item_classification_resource. the quantity and type of resource that are required for each item classification. some item classifications will require only one resource. some will require multiple resources { "item_classification_id": "1", #primary key "resource_id": "5", #primary key "item_classification_resource_quantity": "1", #required quantity of this resource for this item classification "created_by": null, "created_on": null, "last_modified": "2021-05-25 02:10:12", "modified_by": null, "is_deleted": "0", "item_classification_name": "Traffic Controller", #provided for convenience "resource_name": "Traffic Controller", #provided for convenience "resource_type_id": "2", #provided for convenience "resource_type_name": "Person", #provided for convenience "max_last_modified": "2024-07-28 21:39:57.4621" }
Returns	@return ARRAY of item classification

Field		Description
fields
fields	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
exclude_fields
exclude_fields	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.
is_deleted
item_classification_id
max_last_modified		(YYYY-MM-DD HH:mm:ss), if supplied, only records modified more recent than this datetime will be returned
resource_id
resource_type_id

GET item_classification
/api_third_party/v1_item_classification/item_classification

Description	Returns item classifications. Item classifications are the types of items that can be used in a booking. an item classification will require several resources. eg a 1TC crew will require a traffic controller, and a vehicle the mapping of item classification to resource can be found in teh item_classification_resource api below to access this api you will need third party booking read access { "item_classification_id": "1", # primary key "item_classification_code": null, # default is null "is_allowance": "0", # if 1, this item classification is an allowance eg: travel allowance "item_classification_name": "Traffic Controller", "item_classification_description": null, "item_classification_is_task": "0", # if 1, this item classification is a task "is_deleted": "0", "created_by": null, "created_on": null, "last_modified": "2017-04-07 00:54:56", "modified_by": null, "max_last_modified": "2024-07-28 21:06:49.0610" }
Returns	@return ARRAY of item classification

Field		Description
fields
fields	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
exclude_fields
exclude_fields	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.
is_deleted
item_classification_category_id
item_classification_id
item_classification_is_task		0 or 1. If supplied, only item classifications of this type will be returned.
max_last_modified		(YYYY-MM-DD HH:mm:ss), if supplied, only records modified more recent than this datetime will be returned