| Panel |
|---|
On This Page: Related Pages: |
| Panel |
|---|
The sp:ApptBookRequest API method can be used to book a job, based on an offered appointment. |
Description
A particular appointment time can be reserved in ServiceOptimizer by calling the sp:ApptBookRequest API method. It will normally be called after a customer has chosen one of the possible appointments returned from a call to the Request Appointments SOAP API, however sp:ApptBookRequest can be called directly, in which case the system invokes the Request Appointments SOAP API 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 Appointments SOAP API interface has been called initially, then the resultant offers must instead be booked using the Book Split Dependency Group Jobs SOAP API.
Definition
The definition of this API is:
| Include Page |
|---|
| _API ApptBookRequest Definition |
|---|
| _API ApptBookRequest Definition |
|---|
|
Return Structure
The API returns a non-standard return structure.
| Include Page |
|---|
| _API ApptBookRequest Response |
|---|
| _API ApptBookRequest Response |
|---|
|
Return Codes
In addition to the Standard Return Codes, the possible Return Codes from this API are:
| Include Page |
|---|
| _API ApptBookRequest Return Codes |
|---|
| _API ApptBookRequest Return Codes |
|---|
|
