Contract Link

Get contract links for a specific site

Retrieve a list of contract links for a specific site (excludes ward-level)

get/agency/{agency_id}/site/{site_id}/contract-links

Request

  • Base URL
    http://localhost:3010/v1
  • URL
    http://localhost:3010/v1/agency/{agency_id}/site/{site_id}/contract-links
  • Auth
    HTTP basic and HTTP basic and HTTP basic

Query parameters

pageinteger

The page number

items_per_pageinteger

No of records per page

sortBystring[]

A comma separated list of fields indicating sort order, a negative sign reverses direction

contract_idstring

Filter by contract ID

contract_namestring

Filter by contract name

link_status'active' | 'inactive'

Filter by link status

standardboolean

Filter by standard contract flag

date_created_fromstring date-time

Filter by created date (from)

date_created_tostring date-time

Filter by created date (to)

date_modified_fromstring date-time

Filter by modified date (from)

date_modified_tostring date-time

Filter by modified date (to)

last_job_title_min_end_date_fromstring date-time

Filter by min end date (from)

last_job_title_min_end_date_tostring date-time

Filter by min end date (to)

last_job_title_max_end_date_fromstring date-time

Filter by max end date (from)

last_job_title_max_end_date_tostring date-time

Filter by max end date (to)

Headers

Authorizationstring string required

OAuth Bearer token

Contextstring string required

The executing context

Accept'application/json' required

Advertises which content types the client understands

X-Accept-Timezonestring

The timezone the content will be displayed in

Response

List of contract links for the site

idstring required
contract_idstring required
contract_namestring required
contract_descriptionstring
organisation_idstring required
organisation_namestring required
site_idstring required
site_namestring required
site_post_codestring
ward_idstring
ward_namestring
link_status'active' | 'inactive' required
timezonestring
date_createdstring date-time required
date_modifiedstring date-time required
standardboolean
last_job_title_min_end_datestring date-time
last_job_title_max_end_datestring date-time

Changes

No recorded changes to this operation across all 3 revisions of this API.