Skip to content

availableAppointmentSlots

Deprecated

This endpoint will stop working on 1 August 2027. Migrate to GET /classic/appointments/slots/{jobRef}/{startDate} in the new API; the migration guide has the recommended order of work and the important model differences.

GET /classic/appointments/slots/{jobRef}/{startDate} is a compatibility wrapper around the legacy GET /rest/availability/getAppSlots/.... Slot-availability discovery for pooled scheduling is preserved with the same response shape, served under the new authentication. Accepts optional teamId, numberOfDays, allowSecondary, zoneCriteria query params.

Open GET /classic/appointments/slots/{jobRef}/{startDate} in the new API →

View legacy reference

/rest/availability/getAppSlots/{jobRef}/{startDate}

GET
Retrieves all available slots for a given period based on the job reference and start date provided in the rest call - this follows the same logic as the pooled appointment screen and will return available day division slots and the date they are available on.

parameters:

jobRef - Oneserve's unique J reference number
startDate - the starting date of the first available slots to return in dd-mmm-yyyy format


Include parameter for Resource Services

/rest/availability/getAppSlots/{JobRef}/{Start Date}/?allowSecondary=true


Include parameter for Resource Postcode Coverage

/rest/availability/getAppSlots/{JobRef}/{Start Date}/?zoneCriteria ={zoneCriteria}


Include parameter for Resource Services and Postcode Coverage

/rest/availability/getAppSlots/{JobRef}/{Start Date}/?allowSecondary=true&zoneCriteria={zoneCriteria}


allowSeconday with allow you to specify what resource services you would like to use. If it's not specified it will only be the resource's primary skills that are considered when determining resource availability.

Values:

True

False


ZoneCriteria If it's not specified it will use the resource primary zone coverage

Values:

Primary

Both

Any

'primary', the resources primary postcode coverage is used.  If 'both', the combination of both primary and secondary coverage is used.  If 'any', then resource's postcode coverage is not used to determine if a resource will be available.


The following HTTP headers are required:

  • Content-Type with a value of application/xml
  • username
  • password

Sample Response:

<root>
  <available>
    <date>03/06/2016</date>
    <slot>AM</slot>
    <slot>All Day</slot>
    <slot>PM</slot>
    <slot>School Run</slot>
  </available>
  <available>
    <date>06/06/2016</date>
    <slot preferred="true">AM</slot>
    <slot>All Day</slot>
    <slot>PM</slot>
    <slot>School Run</slot>
  </available>
  <available>
    <date>07/06/2016</date>
    <slot>AM</slot>
    <slot>All Day</slot>
    <slot>PM</slot>
    <slot>School Run</slot>
  </available>
  <available>
    <date>08/06/2016</date>
    <slot>AM</slot>
    <slot>All Day</slot>
    <slot>PM</slot>
    <slot>School Run</slot>
  </available>
</root>

See the Resource Scheduler API matrix for the full list of endpoints in this category.