On This Page:

Related Pages:

The sp:BookSplitDependencyGroupRequest API method can be used to book a set of offers for a long-duration job.

Description

If the Request Appointments SOAP API interface has been used to retrieve a set of offers for a long-duration job, the chosen set can then be booked using the sp:BookSplitDependencyGroupRequest API method.

The original appointment information from the Request Appointments SOAP API call must be passed in, along with the set of individual offers received for the chosen specific operative.

Definition

The definition of this API is:

Click here to expand...

Web Service			Type	Description	Req?	Val?
`<sp:BookSplitDependencyGroupRequest>`
	`<appt>`			The `appt` structure is the same as used in the Book Appointment SOAP API interface.
	`</appt>`
	`<job>`			See note below.
		`…`
	`</job>`
	`<groupType>?</groupType>`		`SplitGrpType`	is one of ContigShift, ConsecShift, NonConsecShift and is returned with the first offer in each offer group to provide an indication of what type of offer group this is (it is undefined in the other offers in the same offer group): ContigShift means that the offers in this group are in the relevant operative’s contiguous shift time: no interruptions except for off-shift time and public holidays ConsecShift means that the offers in this group are on the relevant operative’s consecutive shifts, i.e. the operative will visit the site on consecutive shifts (but no more than once per shift) NonConsecShift means that the offers on this group aren’t in contiguous shift time nor on consecutive shifts, but will still be no more than Long Job: Max Fragment Gap days apart.
	`<empID>?</empID>`		`EmpID`	Is the employee that is being booked to do the work
	`<addJobs>?</addJobs>`		`boolean`	When set to `true`, indicates that the group, as a whole, is to be appended to a pre-exisiting group. If no existing job has the `JobID` specified then `SP_DEPJOBID_DOES_NOT_EXIST (530)` will be returned. If existing jobs are booked to a different `EmpID` than supplied then `SP_WRONG_EMP (492)` will be returned . All jobs in the pre-existing group should be either logged on, logged off of closed - if not then the error code `SP_MULTIJOBID_ALREADY_EXISTS (539)` will be returned. The auto-generated appointment reference (generated from `JobID<sparator>partNum`) will pick up from the last `partNum` used for any pre-exisiting logged on, logged off or cleared appointments with the same owning `JobID`. Defaults to false if not specified.
	`<forceJobs>?</forceJobs>`		`boolean`	When set to `true`, indicates that some of the supplied offer tokens may actually cause overlaps, and this is to be allowed. If the parameter is not set, and an overlap is found then `SP_DEPENDENCY_CONSTRAINT (529)` will be returned. Part jobs booked with this option set will cause the optimizer trigger count to be increased by `ABS_forced_appt_inc` - this is to ensure the optimizer run is brought forwards to remove the incurred overlaps. It is assumed that this parameter will only be set if, in the prior call to the Request Appointments SOAP API, it was necessary to set the `IgnoreOverlaps` option in order to obtain the appointment offers now being booked. Defaults to false if not specified. Forced jobs will be marked as `Fixed` to ensure they are not deallocated by the post optimization alloc/dealloc process (if it is enabled).
	`<splitTimes>`
		`<EarliestStartTime>?</EarliestStartTime>`	`spDateTime`	Are the date and times of the appointment bands. For the first fragment, these will be the arrival promise made to the customer. For subsequent fragments these will be the full shift for the operative in question.
		`<LatestStartTime>?</LatestStartTime>`	`spDateTime`
		`<OfferToken>?</OfferToken>`	`OfferToken`	As supplied from the offer process for each split/fragment
		`<Duration>?</Duration>`	`Int`	Is the duration of the specifc split/fragment for the operative in question (excluding travel)
	`</splitTimes>`
`</sp:BookSplitDependencyGroupRequest>`

The job structure is included for internal purposes only, so can be ignored.

Return Structure

The API returns a non-standard return structure.

Click here to expand...

Web Service			Type		Description	Req?	Val?
`<sp:BookSplitDependencyGroupResponse>`
	<result>?</result>			This contains the standard return structure. This occurs once.
	`<bookInfo>`			This occurs once for each job in the booking group.
		`<IRU>?</IRU>`	`RUID`	the ID of the IRU to which the job has been booked, determined as follows: If the job is resourced, it’s the ID of the IRU that contains the Team that the operative provisionally assigned to the job is posted to at the time of the job. If job is unresourced, it’s the ID of the IRU that contains the Region that the job is located in. If that Region is contained in more than one IRU in the FRU where the offer is being made (i.e. there are overlapping IRUs in the FRU), it’s the first IRU’s ID, ordered alphabetically.
		`<FRU>?</FRU>`	`RUID`	the ID of the FRU to which the job has been booked
	`</bookInfo>`
`</sp:BookSplitDependencyGroupResponse>`

Return Codes

In addition to the Standard Return Codes, the possible Return Codes from this API are:

Click here to expand...

SP_WRONG_EMP (492)
SP_DEPENDENCY_CONSTRAINT (529)
SP_DEPJOBID_DOES_NOT_EXIST (530)
SP_MULTIJOBID_ALREADY_EXISTS (539)
SP_INVALID_SPLIT_JOB_DETAILS (674)
SP_INVALID_SPLIT_DURATION (675)
SP_INVALID_SPLIT_EARLIEST (676)
SP_INVALID_SPLIT_LATEST (677)
SP_RESTRICTION_REF_DOES_NOT_EXIST (697)

Browser not supported