API Access Token

v1_client_contact API

/**
 * REST API end-points for interacting with the 'client_contact' 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

client_contact 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.1081.1

Release Notes

DELETE client_contact
/api_third_party/v1_client_contact/client_contact

Description	Deletes a client_contact.
Returns	@return array The single client_contact record that has been deleted.

Field		Description
client_contact_id		The ID of the client_contact to delete. Required.

GET client_contact
/api_third_party/v1_client_contact/client_contact

Description	Returns information about the 'client_contact' resource (referred to as 'resource' below) filterable by the fields described below. The client_contact resource is dynamic and can be modified by the end user via the interface. Resource response fields: - 'client_contact_id' (primary key, number): The ID of the client_contact resource. - 'client_id' (foreign key, number): The ID of the client resource that the record belongs to. - 'client_contact_first_name' (string): The first name of the contact. - 'client_contact_last_name' (string): The last name of the contact. - 'client_contact_phone' (string): The phone number of the contact. - 'client_contact_email' (string): The email address of the contact. - '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.
Returns	@return array of resources. Returns a single record if the client_contact_id is provided.

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.
client_contact_id		The unique ID of the desired resource. Returns a single record if it exists. Other filters do not apply.
client_id		The unique ID of the client to which the resource belongs.
is_deleted		Flag indicating if the resource is deleted or not. 0 = not deleted, 1 = deleted.
max_last_modified		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.

POST client_contact
/api_third_party/v1_client_contact/client_contact

Description	Creates a client_contact with the provided data.
Returns	@return array The single client_contact record that has been created.

Field		Description
client_contact_email		The email address of the contact.
client_contact_first_name		The first name of the contact. Required.
client_contact_last_name		The last name of the contact. Required.
client_contact_phone		The phone number of the contact. Required.
client_id		The ID of the client that the contact belongs to. Required.

PUT client_contact
/api_third_party/v1_client_contact/client_contact

Description	Updates a client_contact with the provided data.
Returns	@return array The single client_contact record that has been updated.

Field		Description
client_contact_email		The email address of the contact.
client_contact_first_name		The first name of the contact.
client_contact_id		The ID of the client_contact to update. Required.
client_contact_last_name		The last name of the contact.
client_contact_phone		The phone number of the contact.
is_deleted		Whether the client_contact is considered deleted or not. Valid values: 0 = No, 1 = Yes.