WorkOrders

Gets Work Order by Id

Retrieves a Work Order by id for a given AgencyRef and all permissable branches.

get/work-orders/{id}

Request

  • Base URL: https://api.alto.zoopladev.co.uk
  • URL: https://api.alto.zoopladev.co.uk/work-orders/{id}
  • Auth: appAuth (a scheme the document does not define)

Path parameters

idinteger required

Id of the Work Order

Headers

AgencyRefstring required

A GUID required in the header of all API requests that grants access to an agent's data

Response

Success

idstring nullable

Id of the Work Order

propertyIdstring nullable

The unique identifier for the Property associated with the Work Order.

supplierContactIdstring nullable

The unique identifier for the Supplier associated with the Work Order.

reportedDatestring date-time

The date the Work Order was reported.

startDatestring date-time nullable

The preferred start date for the work to be carried out.

quotenumber double nullable

The estimated cost of the work

workOrderNumberstring nullable

Unique Work Order reference number

statusstring nullable

Current status of the Work Order

summarystring nullable

The title of the Work Order.

descriptionstring nullable

A detailed description of the Work Order.

notesstring nullable

Additional notes.

prioritystring nullable

The priority level of the Work Order.

modifiedDatestring date-time nullable

The date the Work Order was last modified.

Changes

No recorded changes to this operation across all 1 revision of this API.