API Access Token

v1_permit API

/**
 * REST API end-points for interacting with the permit resource.
 * @author Maleesha
 */
Returns booking permits aka booking_permit.
@return ARRAY
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.
Booking ID
Booking ID
(YYYY-MM-DD HH:mm:ss)
(YYYY-MM-DD HH:mm:ss)
(YYYY-MM-DD HH:mm:ss), if supplied, only records modified more recent than this datetime will be returned
Permit ID
Permit Issuer ID
  

Create a new booking_permit.
@return booking_permit
Field Description
Booking ID (required)
Additional booking_ids to update, which share the same ongoing_booking_id as this booking
The date the permit is valid from
The date the permit is valid to
Permit ID
Permit Issuer ID (required)
  

Returns permit_issuers aka permit_issuer.
@return ARRAY
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.
(YYYY-MM-DD HH:mm:ss), if supplied, only records modified more recent than this datetime will be returned
  

Create a new permit_issuer.
@return permit_issuer
Field Description
The abbreviation of the permit issuer (optional)
The default cost of the permit issuer
Optional description.
The name of the permit issuer (required)
(required)
  

Returns a permit_status
This is a look up table, the values rarely change An new obsolete status should arrive soon
@return ARRAY
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.
1 or 0
(primary key)
  

Returns a permit
@return ARRAY
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.
(YYYY-MM-DD HH:mm:ss), if supplied, only records modified more recent than this datetime will be returned
The ID of the client_contact which originally requested the permit.
  

Create a new permit.
@return permit
Field Description
The permit actual cost
The permit code (required)
The date the permit is valid from (required)
The date the permit is valid to (required)
The permit's description
If the permit is valid all day on Fridays
When the permit is valid from on Fridays
Possible second entry for when the permit is valid from on Fridays
When the permit is valid to on Fridays
Possible second entry for when the permit is valid to on Fridays
[1 or 0] Indicates whether the permit is valid over different time periods per day of the week
The ID of the permit issuer (required)
The permit's latitude coordinate
The permit's longitude coordinate
The permit's location
If the permit is valid all day on Mondays
When the permit is valid from on Mondays
Possible second entry for when the permit is valid from on Mondays
When the permit is valid to on Mondays
Possible second entry for when the permit is valid to on Mondays
The ID of the client_contact which originally requested the permit.
If the permit is valid all day on Saturdays
When the permit is valid from on Saturdays
Possible second entry for when the permit is valid from on Saturdays
When the permit is valid to on Saturdays
Possible second entry for when the permit is valid to on Saturdays
(required)
If the permit is valid all day on Sundays
When the permit is valid from on Sundays
Possible second entry for when the permit is valid from on Sundays
When the permit is valid to on Sundays
Possible second entry for when the permit is valid to on Sundays
If the permit is valid all day on Thursdays
When the permit is valid from on Thursdays
Possible second entry for when the permit is valid from on Thursdays
When the permit is valid to on Thursdays
Possible second entry for when the permit is valid to on Thursdays
The time the permit is valid from
The time the permit is valid to
If the permit is valid all day on Tuesdays
When the permit is valid from on Tuesdays
Possible second entry for when the permit is valid from on Tuesdays
When the permit is valid to on Tuesdays
Possible second entry for when the permit is valid to on Tuesdays
If the permit is valid all day
If the permit is valid on Fridays
If the permit is valid on Mondays
If the permit is valid on Saturdays
If the permit is valid on Sundays
If the permit is valid on Thursdays
If the permit is valid on Tuesdays
If the permit is valid on Wednesdays
If the permit is valid all day on Wednesdays
When the permit is valid from on Wednesdays
Possible second entry for when the permit is valid from on Wednesdays
When the permit is valid to on Wednesdays
Possible second entry for when the permit is valid to on Wednesdays
Project ID (required)