Skip to end of metadata
Go to start of metadata

You are viewing an old version of this content. View the current version.

Compare with Current View Version History

« Previous Version 5 Current »

5.0.0

The Book Appointment Object is part of the overall ServiceBroker Job Booking object, in the following location:

  • Job Booking > Book Appointment

Book Appointment objects are used to book a job, based on an offered appointment.

A particular appointment time can be reserved in ServiceScheduling using the Book Appointment object. It will normally be called after a customer has chosen one of the possible appointments returned from a call to the Request Appointment Object, however it can be called directly, in which case the system invokes the Request Appointment Object and books the ‘best’ solution returned.

When called directly, this API may be used to book appointments of long duration which require splitting/fragmenting across multiple shifts, however, if the Request Appointment Object interface has been called initially, then the resultant offers must instead be booked using the Book Split Dependency Object.

On this page:

Related pages:

Book Appointment Object Format

{
  "jobID": "",
  "jobType": "",
  "postcode": "",
  "date": "",
  "allowRebook": "",
  "extraSkills": {
    "reqSkills": {
      "skillID": "",
      "skillLevel": ""
    }
  },
  "listReqEmps": {
    "reqEmp": {
      "empID": "",
      "MPX": ""
    }
  },
  "bookLoc": "",
  "promBand": {
    "timeBandID": ""
  },
  "siteID": "",
  "groupID": "",
  "capacityCategory": "",
  "reqSpares": {
    "reqSpare": [
      {
        "spare": "",
        "quantity": ""
      },
      {
        "spare": "",
        "quantity": ""
      },
      {
        "spare": "",
        "quantity": ""
      },
      {
        "spare": "",
        "quantity": ""
      },
      {
        "spare": "",
        "quantity": ""
      }
    ]
  },
  "customer": {
    "custID": "",
    "custName": "",
    "custAddress": [
      "",
      "",
      "",
      ""
    ],
    "contactName": "",
    "phoneNum": [
      "",
      ""
    ]
  },
  "desc": [
    "",
    "",
    "",
    ""
  ],
  "desc2": ""
}


Appt Book Object Properties

  • No labels