Document toolboxDocument toolbox

Integration ServiceOptimizer Common API Concepts Schedule Cost Breakdown

Owned by Matthew Wren
Nov 24, 2022
1 min read

Schedule Cost Breakdown

When requesting an appointment offer, some APIs allow for a "cost breakdown" of the appointment offers to be optionally returned, offering an insight into the various factors that have been taken into account when ServiceScheduling has calculated possible available appointment slots.

The format of this "cost breakdown" structure which will be embedded in API responses is:

Web Service

Type

Description

Req?

Val?

<costBreakDownInformation>






<costNetValue>?</costNetValue>doubleThe sum of all of the (componentCost x componentWeight) values for the appointment offer.


<costBreakDownDetail>
There are multiple costBreakDownDetail structures returned in the response - one for each componentId value.



<componentId>?</componentId>spCostId

The component cost for which the associated componentCost and componentWeight values in the structure are for.

Valid componentId values are as follows:

ValueServiceScheduling Cost Component
TravelTRAVEL
AOTAUTHORISED_OVERTIME
UAOTUNAUTHORISED_OVERTIME
TOTAAFTER_SHIFT_TRAVEL
TOTBBEFORE_SHIFT_TRAVEL
SkillSKILL
LKLOCAL_KNOWLEDGE
2nd PrefOpSECOND_PREFERRED_OPERATIVE
Neither PrefOpNEITHER_PREFERRED_OPERATIVE
RU PrefPREFERRED_RU
OverdueSLA
DreferredDEFERRED
SparesSPARES_DIFFERENCE
Work timeWORKTIME
Travel HomeTRAVEL_HOME
AOT Travel HomeAOT_ON_TRAVEL_HOME
UAOT Travel HomeUAOT_ON_TRAVEL_HOME
HFHARD_FACTOR
SequenceSEQUENCE
Access HoursACCESS_HOURS
OOSHOUT_OF_SERVICE_HOURS
Group IDCUSTOMER_GROUPING
Site IDSITE_GROUPING
Group Id SequenceCUSTOMER_GROUPING_SEQUENCE
Site ID SequenceSITE_GROUPING_SEQUENCE
JobDependency DifferenceJOB_DEPENDENCY_DIFFERENCE




<componentCost>?</componentCost>doubleThe component cost value for the appointment offer.



<componentWeight>?</componentWeight>doubleThe component weight value for the appointment offer.


</costBreakDownDetail>



</costBreakDownInformation>