Document toolboxDocument toolbox

Get Capacity Statistics SOAP API

Owned by Jason Andrew
Sept 17, 2024
6 min read

On This Page:

Related Pages:

The sp:GetCapacityStatsRequest API method can be used to obtain daily statistics about the capacity for jobs in the system, either for one or more specific FRU, or for all FRUs in the system.

Description

The sp:GetCapacityStatsRequest API method returns statistics about job capacity in the system, at a daily level.

Definition

The definition of this API is:

 Click here to expand...

Web Service

Type

Description

Req?

Val?

<sp:GetCapacityStatsRequest>

 

 

 

 

 

<FRUs>?</FRUs>

FRUID

The FRUs field may be supplied zero or more times.
  • Do not supply any FRUs field values, if capacity information should be returned for all FRUs in the system; or
  • Supply one or more FRUs values, to representing the FRU(s) for which capacity information should be returned.

(error)

(tick)

 <iruLevel>?</iruLevel>boolean

When set to true, capacity information will be broken down into IRU levels.

Default value is false.

(error)(tick)
 <teamLevel>?</teamLevel>boolean

When set to true, capacity information will be broken down into both IRU and team levels, even if the iruLevel parameter is false.

Default value is false.

(error)(tick)
 <startDate>?</startDate>spDate

The inclusive start date of the date range for which capacity information should be returned.

 

(tick)(tick)
 <endDate>?</endDate>spDateThe inclusive end date of the date range for which capacity information should be returned.(tick)(tick)
</sp:GetCapacityStatsRequest>    

Return Structure

The API returns a non-standard return structure.

 Click here to expand...

Web Service

Type                   

Description

Req?

Val?

<sp:GetCapacityStatsResponse>

 

 

 

 

 

<result>

 A structure containing details of the success or failure of the API call.  
  <type>?</type>stringThe Return Code name, representing the result of the API call.  
  <code>?</code>intThe Return Code number, representing the result of the API call.  
 </result>    
 <capacityStatsResponse> 

This structure is only returned when the API call does not return an error Return Code.

  
  <capacityStatsPerDate> One or more capacityStatsPerDate structures will be present, with each describing the job capacity for a single day.  
   <Date>?</Date>spDateThe date for which the parent capacityStatsPerDate structure relates to.  
   <capacityStatForAllFru> This structure contains total job capacity for all FRUs contained within the response, for the day of the parent capacityStatsPerDate structure.  
    <shiftTime>?</shiftTime>intFor all FRUs in the response, the total number of minutes in all shifts, including shifts override time, excluding break time, and excluding allowed overtime.  
    <allowedOvertime>?</allowedOvertime> int

For all FRUs in the response, the total number of minutes of allowed overtime.

  
    <breakTime>?</breakTime>intFor all FRUs in the response, the total number of minutes of break time.  
    <saTime>?</saTime>int

For all FRUs in the response, the total number of minutes of standard activity time, excluding travel time and excluding break time.

 

  
    <jobTime>?</jobTime>intFor all FRUs in the response, the total number of minutes of job time, excluding travel time and excluding break time.  
    <travelTime>?</travelTime>int

For all FRUs in the response, the total number of minutes of travel time for all jobs, including travel home time, including SA travel, excluding travel in overtime, and excluding travel outside shift time.

  
    <overTimeUsed>?</overTimeUsed>int

For all FRUs in the response, the total number of minutes of used overtime, excluding travel time.

  
    <outShiftTimeUsed>?</outShiftTimeUsed>intFor all FRUs in the response, the total number of minutes of used outside shift time, excluding travel time.  
    <travelInOverTime>?</travelInOverTime>intFor all FRUs in the response, the total number of minutes of travel time occurring in overtime.  
    <travelOutsideShift>?</travelOutsideShift>intFor all FRUs in the response, the total number of minutes of travel time occurring in outside shift time.  
   </capacityStatForAllFru>    
   

<capacityStatPerFru>

 

One or more capacityStatPerFru structures will be present, with each describing the job capacity for a single FRU, for the day of the parent capacityStatsPerDate structure.

  
    <FRU>?</FRU>FRUIDThe ID of the FRU to which the parent capacityStatPerFru structure relates to.  
    <capacityStatsFru>    
     <shiftTime>?</shiftTime>intFor the FRU, the total number of minutes in all shifts, including shifts override time, excluding break time, and excluding allowed overtime.  
     <allowedOvertime>?</allowedOvertime>intFor the FRU, the total number of minutes of allowed overtime.  
     <breakTime>?</breakTime>intFor the FRU, the total number of minutes of break time.  
     <saTime>?</saTime>int

For the FRU, the total number of minutes of standard activity time, excluding travel time and excluding break time.

  
     <jobTime>?</jobTime>intFor the FRU, the total number of minutes of job time, excluding travel time and excluding break time.  
     <travelTime>?</travelTime>intFor the FRU, the total number of minutes of travel time for all jobs, including travel home time, including SA travel, excluding travel in overtime, and excluding travel outside shift time.  
     <overTimeUsed>?</overTimeUsed>intFor the FRU, the total number of minutes of used overtime, excluding travel time.  
     <outShiftTimeUsed>?</outShiftTimeUsed>intFor the FRU, the total number of minutes of used outside shift time, excluding travel time.  
     <travelInOverTime>?</travelInOverTime>intFor the FRU, the total number of minutes of travel time occurring in overtime.  
     <travelOutsideShift>?</travelOutsideShift>intFor the FRU, the total number of minutes of travel time occurring in outside shift time.  
    </capacityStatsFru>    
    

<capacityStatPerIru>

 When the iruLevel or teamLevel parameter in the API call was set to true, then one or more capacityStatPerIru structures will be present, with each describing the job capacity for a single IRU of the FRU of the parent capacityStatPerFru structure, for the day of the parent capacityStatsPerDate structure.  
     <IRU>?</IRU>IRUIDThe ID of the IRU to which the parent capacityStatPerIru structure relates to.  
     <capacityStatsIru>    
      <shiftTime>?</shiftTime>intFor the IRU, the total number of minutes in all shifts, including shifts override time, excluding break time, and excluding allowed overtime.  
      <allowedOvertime>?</allowedOvertime>intFor the IRU, the total number of minutes of allowed overtime.  
      <breakTime>?</breakTime>intFor the IRU, the total number of minutes of break time.  
      <saTime>?</saTime>intFor the IRU, the total number of minutes of standard activity time, excluding travel time and excluding break time.  
      <jobTime>?</jobTime>intFor the IRU, the total number of minutes of job time, excluding travel time and excluding break time.  
      <travelTime>?</travelTime>intFor the IRU, the total number of minutes of travel time for all jobs, including travel home time, including SA travel, excluding travel in overtime, and excluding travel outside shift time.  
      <overTimeUsed>?</overTimeUsed>intFor the IRU, the total number of minutes of used overtime, excluding travel time.  
      <outShiftTimeUsed>?</outShiftTimeUsed>intFor the IRU, the total number of minutes of used outside shift time, excluding travel time.  
      <travelInOverTime>?</travelInOverTime>intFor the IRU, the total number of minutes of travel time occurring in overtime.  
      <travelOutsideShift>?</travelOutsideShift>intFor the IRU, the total number of minutes of travel time occurring in outside shift time.  
     </capacityStatsIru>    
     <capacityStatPerTeam> When the teamLevel parameter in the API call was set to true, then one or more capacityStatPerTeam structures will be present, with each describing the job capacity for a single team of the IRU of the parent capacityStatPerIru structure, for the FRU of the parent capacityStatPerFru structure, for the day of the parent capacityStatsPerDate structure.  
      <teamID>?</teamID>TeamIDThe ID of the team to which the parent capacityStatPerTeam structure relates to.  
      <CapacityStatsTeam> This structure contains total job capacity for all technicians contained within the team for the parent capacityStatPerTeam structure.  
       <shiftTime>?</shiftTime>intFor all technicians in the team, the total number of minutes in all shifts, including shifts override time, excluding break time, and excluding allowed overtime.  
       <allowedOvertime>?</allowedOvertime>intFor all technicians in the team, the total number of minutes of allowed overtime.  
       <breakTime>?</breakTime>intFor all technicians in the team, the total number of minutes of break time.  
       <saTime>?</saTime>intFor all technicians in the team, the total number of minutes of standard activity time, excluding travel time and excluding break time.  
       <jobTime>?</jobTime>intFor all technicians in the team, the total number of minutes of job time, excluding travel time and excluding break time.  
       <travelTime>?</travelTime>intFor all technicians in the team, the total number of minutes of travel time for all jobs, including travel home time, including SA travel, excluding travel in overtime, and excluding travel outside shift time.  
       <overTimeUsed>?</overTimeUsed>intFor all technicians in the team, the total number of minutes of used overtime, excluding travel time.  
       <outShiftTimeUsed>?</outShiftTimeUsed>intFor all technicians in the team, the total number of minutes of used outside shift time, excluding travel time.  
       <travelInOverTime>?</travelInOverTime>intFor all technicians in the team, the total number of minutes of travel time occurring in overtime.  
       <travelOutsideShift>?</travelOutsideShift>intFor all technicians in the team, the total number of minutes of travel time occurring in outside shift time.  
      </CapacityStatsTeam>    
      

<capacityStatPerTechnician>

 

 

One or more capacityStatPerTechnician structures will be present, with each describing the job capacity for a single technician of the team of the parent capacityStatPerTeam structure, for the IRU of the parent capacityStatPerIru structure, for the FRU of the parent capacityStatPerFru structure, for the day of the parent capacityStatsPerDate structure.

  
       <empID>?</empID>EmpIDThe ID of the technician to which the parent capacityStatPerTechnician structure relates to.  
       <empName>?</empName>EmpNameThe technician's full name.  
       <empSurname>?</empSurname>EmpSurnameThe technician's surname.  
       <capacityStats>    
        <shiftTime>?</shiftTime>intFor the technician, the total number of minutes in all shifts, including shifts override time, excluding break time, and excluding allowed overtime.  
        <allowedOvertime>?</allowedOvertime>intFor the technician, the total number of minutes of allowed overtime.  
        <breakTime>?</breakTime> intFor the technician, the total number of minutes of break time.  
        <saTime>?</saTime>intFor the technician, the total number of minutes of standard activity time, excluding travel time and excluding break time.  
        <jobTime>?</jobTime>intFor the technician, the total number of minutes of job time, excluding travel time and excluding break time.  
        <travelTime>?</travelTime>intFor the technician, the total number of minutes of travel time for all jobs, including travel home time, including SA travel, excluding travel in overtime, and excluding travel outside shift time.  
        <overTimeUsed>?</overTimeUsed>intFor the technician, the total number of minutes of used overtime, excluding travel time.  
        <outShiftTimeUsed>?</outShiftTimeUsed>intFor the technician, the total number of minutes of used outside shift time, excluding travel time.  
        <travelInOverTime>?</travelInOverTime>intFor the technician, the total number of minutes of travel time occurring in overtime.  
        <travelOutsideShift>?</travelOutsideShift>intFor the technician, the total number of minutes of travel time occurring in outside shift time.  
       </capacityStats>    
      </capacityStatPerTechnician>    
     </capacityStatPerTeam>    
    </capacityStatPerIru>    
   </capacityStatPerFru>    
  </capacityStatsPerDate>    
 </capacityStatsResponse>    
</sp:GetCapacityStatsResponse>    

Notes

Standard Activities

If a standard activity's time is longer than the time of the shift in which it is contained, then the shift time excluding break time is returned as the standard activity time.

Overlapping Items

The total time of all individual jobs, standard activities etc. are counted, even if there is some degree of item overlap.

Return Codes

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

 Click here to expand...
  • SP_END_NOT_GE_START_DATE (19)

  • SP_UNIT_INVALID (28)

  • SP_OUTSIDE_HORIZON (53)

  • SP_START_DATE_INVALID (55)

  • SP_END_DATE_INVALID (56)

  • SP_FRU_UNAVAILABLE (259)

  • SP_DATE_NOT_SUPPLIED (638)

  • SP_DUPLICATE_FRUID (811)

  • SP_DATERANGE_GT_MAX_DAYS_STATS (812)

  • SP_NOT_ALL_FRU_RESPOND (813)