appointmentsV10

Deprecated

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

Same shape as legacy appointments - lists appointments for a resource in a date range. The new endpoint accepts clientRef only and does not support resource/date-range filtering. Response payload structure also differs significantly.

Open GET /v1/appointments in the new API →

View legacy reference

/rest/rs/resource/{resourceRef}/appointments/{startDate}/{endDate}

GET

Get's a list of appointments for the specified resource with a planned start date falling within the specified date range.  Returned in plannedStartDate order.

parameters:

resourceRef - a String containing a Resource ref
startDate - the starting date of the date range within which to include appointments
endDate - the ending date of the date range within which to include appointments

available response representations:

• 200 - application/json

{
  "appointments" : [ 
      { 
        "id" : "656378",
        "siteRef" : "64536",
        "jobRef" : "J00123",
        "jobClientRef" : "000123",
        "statusID" : "2",
        "workState" : "2",
        "plannedStartDate" : "12/12/2011 12:34",
        "plannedEndDate" : "12/12/2011 12:34",
        "actualStartDate" : "12/12/2011 12:34",
        "actualEndDate" : "12/12/2011 12:34",  
        "requireCompletionOfActivities" : "true",  //workLogType.require_completion_of_activities
        "currentProcess" : "1",  //Job.job_currentprocess
        "workLog" : 
            {
                "sal" : "Mr",
                "forename" : "John",
                "surname" : "Lombard",
                "address1" : "12 Fillimore Str",
                "address2" : "Weymouth",
                "address3" : "Dorset",
                "address4" : "",
                "postCode" : "WM3 8YU",
                "contact1" : "08787 334998",
                "client" : "default",
            },

        "service" : 
            {
                "id" : "23",
                "description" : "Electrical",
                "icon" : "electrical.jpg"
            },
        "resource" :
            {
                "id" : "232",
                "name" : "Bill Smith",
                "workState" : "2"
            }, 
        "activities" :[ 
            {
                "appointmentId" : "232",
                "activityId" : "Bill Smith",
                "code" : "2",
                "description" : "Replace boiler", 
                "completedQuantity" : "1",
                "totalQuantity" : "2",
                "activityVersion" : "4", 
                "note" : "Replace boiler and all pipes",
                siteLocation {
                    "id"   : "28", 
                    "name" : "Bathroom"   
                },
                category {
                    "id"   : "98", 
                    "name" : "Plumbing"   
                }
            } ,
            {
                "appointmentId" : "232",
                "activityId" : "Bill Smith",
                "code" : "4",
                "description" : "Replace bench", 
                "completedQuantity" : "0",
                "totalQuantity" : "1",
                "activityVersion" : "0", 
                "note" : ""
            }]     }, 
        "siteLocations" :[ 
            {
                "id" : "28",
                "name" : "Bathroom"
            },
            {
                "id" : "11",
                "name" : "Kitchen"
            }] 

      }
    ]
}

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