/
_API BookDependencyGroupRequest Response

_API BookDependencyGroupRequest Response

 Click here to expand...

Web Service

Type

Description

Req?

Val?

<sp:BookDependencyGroupResponse>

    
 <result>?</result>  This contains the standard return structure. This occurs once.  

 

<travelTime>?</travelTime>

int

If the call succeeds, this is the sum of the travel time for all of the jobs in the MultiJobID dependency group. This occurs once or not at all depending on whether the call has been successful or not.

 

 

 

<retJobs>

 

This occurs once for EACH job in the booking group.

 

 

 

 

<jobID>?</jobID>

JobID

is the regular JobID of the job

 

 

 

 

<empID>?</empID>

EmpID

is the ID of the operative that this job is allocated to.  Only if SP_OptFixToEmp was supplied in the input BookOptions will this job necessarily remain allocated to this operative.  If the job is unresourced, an empty string is returned.

 

 

 

 

<maybeETA>?</maybeETA>

spDateTime

are the ETA of the job at the time of booking.  It’s unlikely to remain scheduled to this ETA.  If the job is unresourced, empty strings are returned.

 

 

 

 

<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

 

 

 

</retJobs>

 

 

 

 

</sp:BookDependencyGroupResponse>