Skip to content

bulkAppointmentBookerV1

Supported, no replacement yet

This endpoint remains fully supported. No replacement exists in the new API yet, and no action is needed. When a replacement ships you will get 12 months' notice, and this site will be updated.

Reference


/rest/rs/bulkAppointmentBook/

POST
Books appointments using the pooled booking mechanism for jobs that match the job search criteria provided.  Appointment booking will start from the start date provided and proceed to book pooled appointments for each job in a Day Division until that Day Division is full and then it moves on to the next Day Division.  Appointments will be booked with the Supplier and Zone Type provided.  Jobs will be processed in the order specified in the sortMethod parameter.  A limit on the number of days to try can also be set.

parameters:

None

acceptable request representations:

  • application/json
{
 "clientRef":"sor", "supplierId":"2",  "zoneType":"0",  "startDate":"12/12/2012",  "sortMethod" : "1",  "maxDaysToTry\":"7", "jobSearchCriteria" :  { 
                "serviceId":"2",  "workTypeId":"45",           "workLogTypeId":"1",  "priorityId":"2",  "causeId":"4", "statusId":"2",  "createdDateStart":"10/12/2012",  "createdDateEnd":"12/12/2012",        "reportedDateStart":"01/12/2012",        "reportedDateEnd":"01/12/2012", "loggedById":"35",  "siteGroupId":"4",  "supplierId":"12", 
 } 
}

Notes

  • zoneType: 0 = Any, 1 = Primary Only, 2 = Primary and Secondary POST CODE ZONE COVERAGE, NOT SERVICE
  • sortMethod: 1 = By Job Creation Date, 2 = By Post Code
  • maxDaysToTry defaults to 60
  • NOTE: the SERSE right can be used to control whether resources who cover Primary or Secondary services are considered - this right would have to be assigned/removed from the user who is calling this API
  • jobSearchCriteria parameters are optional.  If not provided "ALL" is assumed.

available response representations:
  • 200 - application/json
{
  "result" : "success or fail",
  "result_msg" : "error message"
}

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