API Access Token

v1_files API

/**
 * REST API end-points for interacting with the 'files' resource.
 *
 */
Returns a URL for a single requested 'permit_file' from which the file asset can be downloaded. The URL remains valid for 20 minutes.
Passing the 'should_redirect' parameter with a value of '1' will redirect the requester to the asset with a 302 HTTP status.
This end-point requires the 'permit_read_access' and 'file_read_access' permissions.
UNKNOWN
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.
Part of the unique ID of the desired resource. Returns a single record if it exists. Required.
part of a unique ID of each permit.
A flag to indicate if the response should redirect the requester to the asset. 0 = no, 1 = yes.
  

Get permit files.
@return ARRAY of permit_file
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.
Set to '0' to undelete the record.
(YYYY-MM-DD HH:mm:ss), if supplied, only records modified more recent than this datetime will be returned
  

Link a file with a permit. You must have access to both for this to work.
@return Array Single record.
Field Description
doc type id
Description for this file.
The file name. (Required)
Title for this file.
ID of the permit to upload the file for. (Required)
  

Returns a URL for a single requested 'person_file' from which the file asset can be downloaded. The URL remains valid for 20 minutes.
Passing the 'should_redirect' parameter with a value of '1' will redirect the requester to the asset with a 302 HTTP status.
This end-point requires the 'person_read_access' and 'file_read_access' permissions.
UNKNOWN
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.
Part of the unique ID of the desired resource. Returns a single record if it exists. Required.
Part of the unique ID of the desired resource. Returns a single record if it exists. Required.
A flag to indicate if the response should redirect the requester to the asset. 0 = no, 1 = yes.
  

Deletes an existing person_file record.
This end-point requires the 'person_write_access, 'file_write_access' permissions.

Resource response fields: Documentation to come.
@return array Returns the file record that has been deleted.
Field Description
ID of the file resource to link the person to. Required.
ID of the person to upload the file for. Required.
  

Returns information about the 'person_skill_file' resource (referred to as 'resource' below) filterable by the fields described below.
This end-point requires the 'person_read_access' and 'file_read_access' permissions.
Resource response fields: Documentation to come.
UNKNOWN
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.
Filter resources to match these comma separated unique IDs of the corresponding files document_type resource.
Part of the unique ID of the desired resource. Returns a single record if it exists. Other filters do not apply.
Filter resources to match this flag. 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.
Part of the unique ID of the desired resource. Returns a single record if it exists. Other filters do not apply.
Filter resources to match these comma separated unique IDs of the corresponding files tags.
  

Creates and returns a new person_file record.
This end-point requires the 'person_write_access' and 'file_write_access' permissions.

Resource response fields: Documentation to come.
@return array Returns the file record that has been created.
Field Description
The ID of the document_type of the file. Required.
A description of the file. Max length: 255.
The file name. Required. Max length: 255.
A title for the file. Max length: 255.
ID of the person to upload the file for. Required.
  

Updates an existing person_file record.
This end-point requires the 'person_write_access' and 'file_write_access' permissions.

Resource response fields: Documentation to come.
@return array Returns the file record that has been updated.
Field Description
The ID of the document_type of the file.
A description of the file. Max length: 255.
ID of the file resource to link the person to. Required.
A title for the file. Max length: 255.
Flag indicating if the resource is deleted or not. 0 = not deleted, 1 = deleted.
ID of the person to upload the file for. Required.
  

Creates and returns a new file record of 'person image' type.
This end-point requires the 'person_write_access' and 'file_write_access' permissions.
@return array Returns the file record that has been created.
Field Description
A description of the file. Max length: 255.
The file name. Required. Max length: 255.
A title for the file. Max length: 255.
The unique ID of the person resource to which the image will be attached.
  

Returns a URL for a single requested 'person_skill_file' from which the file asset can be downloaded. The URL remains valid for 20 minutes.
Passing the 'should_redirect' parameter with a value of '1' will redirect the requester to the asset with a 302 HTTP status.
This end-point requires the 'person_read_access', 'skill_read_access' and 'file_read_access' permissions.
UNKNOWN
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.
Part of the unique ID of the desired resource. Returns a single record if it exists. Required.
Part of the unique ID of the desired resource. Returns a single record if it exists. Required.
A flag to indicate if the response should redirect the requester to the asset. 0 = no, 1 = yes.
Part of the unique ID of the desired resource. Returns a single record if it exists. Required.
  

Deletes an existing person_skill_file record.
This end-point requires the 'person_write_access, 'file_write_access' permissions.
@return array Returns the file record that has been deleted.
Field Description
ID of the file resource. Required.
ID of the person resource. Required.
ID of the skill resource. Required.
  

Returns information about the 'person_skill_file' resource (referred to as 'resource' below) filterable by the fields described below.
This end-point requires the 'person_read_access', 'skill_read_access' and 'file_read_access' permissions.
Resource response fields: Documentation to come.
UNKNOWN
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.
Filter resources to match this unique ID of the corresponding files document_type resource.
Part of the unique ID of the desired resource. Returns a single record if it exists. Other filters do not apply.
Filter resources to match this flag. 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.
Part of the unique ID of the desired resource. Returns a single record if it exists. Other filters do not apply.
Part of the unique ID of the desired resource. Returns a single record if it exists. Other filters do not apply.
Filter resources to match these comma separated unique IDs of the corresponding files' tags.
  

Creates and returns a new person_skill_file record.
This end-point requires the 'person_write_access' abd 'file_write_access' permissions.
@return array Returns the file record that has been created.
Field Description
The ID of the document_type of the file. Required.
A description of the file. Max length: 255.
The file name. Required. Max length: 255.
A title for the file. Max length: 255.
ID of the person resource to upload the file for. Required.
ID of the skill resource to upload the file for. Required.
  

Updates an existing person_skill_file record.
This end-point requires the 'person_write_access' and 'file_write_access' permissions.
@return array Returns the file record that has been updated.
Field Description
The ID of the document_type of the file.
A description of the file. Max length: 255.
ID of the file resource. Required.
A title for the file. Max length: 255.
Flag indicating if the resource is deleted or not. 0 = not deleted, 1 = deleted.
ID of the person resource. Required.
ID of the skill resource. Required.