On This Page:

The ServiceOptimizer SOAP APIs utilize a number of defined data types, to ensure consistency across the APIs.

These are either pre-defined primitive data types of a specified length, or are enumerated types with a defined set of valid values.

Some of the primitive data types, like spDateTime, require data in a specific format - see Data Type Formats for definitions of these formats.

Common Specified Length Data Types

Data Type Name	Primitive Type	Size
`ActCategoryDesc`	`string`	30
`ActNo`	`unsigned int`	N/A
`ActNotes`	`string`	4003
`ActTypeNum`	`unsigned int`	N/A
`ActTypeStr`	`string`	30
`BookLocID`	`string`	4
`BookLocName`	`string`	50
`BreakName`	`string`	20
`cancelReasonId`	`unsigned int`	N/A
`cancelDescription`	`string`	500
`CapacityCategoryName`	`string`	20
`ColourID`	`string`	30
`ContactName`	`string`	50
`CostID`	`string`	20
`CountryCode`	`string`	2
`CustAddress`	`string`	50
`CustID`	`string`	30
`CustName`	`string`	50
`CustomKeyword`	`string`	12
`CustomValue`	`string`	20
`DayInd`	`string`	3
`Days`	`string`	7
`DepCostID`	`string`	10
`Desc`	`string`	500
`Desc2`	`string`	3500
`DescriptionStr`	`string`	256
`DRUID`	`string`	8
`EmpAddress`	`string`	50
`EmpID`	`string`	25
`EmpJobTitle`	`string`	24
`EmpName`	`string`	50
`EmpSurname`	`string`	50
`FRUID`	`string`	8
`GeofenceName`	`string`	25
`GeofenceType`	`string`	5
`GPSAddressLine`	`string`	50
`GPSPostcode`	`string`	15
`GroupID`	`string`	30
`HandheldAddress`	`string`	10

Data Type Name	Primitive Type	Size
`IRUID`	`string`	8
`JobCategoryDesc`	`string`	30
`JobID`	`string`	50
`JobTypeDesc`	`string`	40
`JobTypeID`	`string`	30
`LocAdd`	`string`	50
`OfferText`	`string`	47
`OfferToken`	`string`	60
`PagerNum`	`string`	20
`PhoneNum`	`string`	40
`Postcode`	`string`	30
`Printer`	`string`	10
`PromSetID`	`string`	2
`PromTypeID`	`string`	2
`PubHolSetID`	`string`	30
`RegionID`	`string`	26
`RestrictionRef`	`string`	30
`RUDescription`	`string`	40
`RUID`	`string`	8
`ServHoursPattID`	`string`	10
`ServHoursPattName`	`string`	30
`ShiftPatternID`	`string`	30
`SiteID`	`string`	20
`SkillDesc`	`string`	36
`SkillID`	`string`	30
`SpareID`	`string`	30
`SpareLoc`	`string`	26
`spCostId`	`string`	N/A
`spDate`	`string`	8
`spDateTime`	`string`	16
`SpecialPeriodID`	`unsigned int`	N/A
`TeamID`	`string`	40
`Time`	`string`	4
`TimeBandID`	`string`	4
`timestamp`	`unsigned long`	N/A
`TravelProfileID`	`string`	10
`TZID`	`string`	32
`Unit`	`string`	8
`WorkItemID`	`string`	50

Data Type Name	Primitive Type	Size
`sp2:BandDescName`	`string`	5
`sp2:spTime`	`string`	15

Enumerated Data Types

`ActLocType`
Permitted Value(s)	Description
`None`	There is no location defined.
`Supplied`	Supplied in `StartPostCode` or `EndPostCode`.
`Home`	Employee’s home region.
`Depot`	Employee’s depot region.
`Work`	Employee’s work region.
`Start`	Employee’s shift start region.
`End`	Employee’s shift end region.
`ActTravelModeType`
Permitted Value(s)	Description
`None`	The Activity will not automatically include any travel into the duration.
`ETS`	The Activity will include travel such that the start time remains the same.
`ETA`	The Activity will include travel such that the arrival time remains the same.
`ActTZType`
Permitted Value(s)	Description
`Home`	The Activity times are defined assuming the Employee’s home TZ.
`FRU`	The Activity times are defined assuming the TZ of the FRU to which the employee is currently posted.
`Location`	The Activity times are defined assuming the TZ of the given location.
`Default`	The Activity times are defined assuming default TZ for the system.
`AssignmentType`
Permitted Value(s)	Description
`EQ`	Grant permission if the role's formal parameter matches.
`NEQ`	Grant permission if the role's formal parameter does not match.
`AuditStatus`
Permitted Value(s)	Description
`OFF`	Auditing of job history via the relevant mechanism is not enabled.
`ON`	Auditing of job history via the relevant mechanism is enabled.
`PARTIAL`	There is a mixture of enabled and not enabled job history auditing in place.
`AuthType`
Permitted Value(s)	Description
`INTERNAL`	Deprecated in ServiceScheduling 13.0.6 (The use of `INTERNAL` with Create User SOAP API or Update User SOAP API is still supported, but users will be created with the `SECURED` type.) Users with an `AuthType` value of `INTERNAL` will fail authentication. Run `spsecure` to update to `SECURED`.
`SECURED`	The user's login will be authenticated against a secure password hash stored in ServiceScheduling.
`LDAP`	The user's login will be authenticated using the configured external LDAP server.
`Boolean`
Permitted Value(s)	Description
`false or 0`	FALSE
`true or 1`	TRUE
`BreakType`
Permitted Value(s)	Description
`Default`	The Break is from the defined shift Break specification.
`Overridden`	The Break has been overridden by a user.
`Fixed`	The Break has been taken so times are actual break times.
`DayOfTheWeek`
Permitted Value(s)	Description
`Mon`	Monday
`Tue`	Tuesday
`Wed`	Wednesday
`Thu`	Thursday
`Fri`	Friday
`Sat`	Saturday
`Sun`	Sunday
`DepEmpType`
Permitted Value(s)	Description
`None`	There is no Employee dependency required.
`Same`	Dependent jobs must be done by the same Employee.
`Diff`	Dependent jobs must be done by a different Employee.
`DepTimeType`
Permitted Value(s)	Description
`ETA`	Dependency should be based on Estimated Time of Arrival.
`ETF`	Dependency should be based on Estimated Time of Finish.
`DepUnits`
Permitted Value(s)	Description
`Mins`	Units for the time dependency specified are minutes.
`Hours`	Units for the time dependency specified are hours.
`Days`	Units for the time dependency specified are days.
`DispEarmarkTypes`
Permitted Value(s)	Description
`Earmark`	A job has been earmarked.
`UnEarmark`	A job has been unearmarked.
`ReEarmark`	A job has been re-earmarked.
`SA-Earmark`	A standard activity has been earmarked.
`SA-UnEarmark`	A standard activity has been unearmarked.
`SA-ReEarmark`	A standard activity has been re-earmarked.
`None`	A job has changed jeopardy state. Only supported as a value when the Dispatch configuration is set for this feature.
`DispMode`
Permitted Value(s)	Description
`RealTime`	Jobs will be dispatched in real time as they come within inform lead time.
`Batch`	All Jobs due before specified date/time will be dispatched.
DispRangeType
Permitted Value(s)	Description
`Jobs`	Dispatch date/time range refers to Jobs within the range.
`Shifts`	Dispatch date/time range refers to shifts falling within the range.
`DisStatus`
Permitted Value(s)	Description
`Tentative`	Tentative, assigned but not confirmed.
`Fixed`	Fixed.
`Earmarked`	Dispatched.
`Contacted`	Accepted by the Employee.
Cancelled	Displays a Cancelled status of cancelled jobs.
`Travelling`	EnRoute or travelling to Job.
`LoggedOn`	LoggedOn or Onsite at Job.
`LoggedOff`	LoggedOff or left site of Job.
`Cleared`
`EmpLocType`
Permitted Value(s)	Description
`Home`	The Employee’s home location.
`Work`	The Employee’s work location.
`Depot`	The Employee’s depot location.
`Supplied`	A supplied location.
`EmpMPX`
Permitted Value(s)	Description
`None`	There is no preferred or mandatory Employee.
`Preferred`	This is one of possibly several preferred Employees.
`Mandatory`	This is one of possibly several mandatory Employees.
`PreferredOrdered`	There is more than one preferred Employee and this one is more preferred than those marked as ‘Preferred’.
`MandatoryOrdered`	There is more than one mandatory Employee and this one is more preferred than one marked as ‘Mandatory’
`MandatoryNot`	This is one of possibly several (up to 10) Employees who should not be used.
`EmpTravelStatus2`
Permitted Value(s)	Description
`Stopped`	The Employee is currently stopped, with engine off.
`Stationary`	The Employee is temporarily stationary.
`Moving`	The Employee is currently moving.
`Unknown`	Travel status is currently unknown.
`EmpType`
Permitted Value(s)	Description
`Operative`	Employee is an individual.
`Crew`	Employee is actually a crew made up from employeed individuals.
`ContractCrew`	Employee is a crew where the individuals are not employed.
`EmpTZType`
Permitted Value(s)	Description
`None`	No timezone is set for the employee so will default to FRU timezone.
`Supplied`	A timezone will be supplied as well, in another field.
`Home`	The timezone of the postal code for the employee’s home.
`Depot`	The TZ of the postal code for the depot to which the employee is currently posted.
`RU`	The TZ of the FRU to which the employee is currently posted.
`HistoryOptions`
`All`	All recorded changes to the relevant job will be returned.
`Manual`	For the relevant job, only the initial creation of the job (regardless of the method of job creation) and changes made via ServiceGANTT will be returned.
`System`	For the relevant job, only changes made via the API and/or ServiceOptimizer system processes will be returned.
`LKType`
Permitted Value(s)	Description
`Range`	Local Knowledge is defined for a range of travel times around a central point.
`Region`	Local Knowledge is defined on a region by region basis.
`LocType`
Permitted Value(s)	Description
`None`	The spare has no location.
`Pickup`	The spare needs to be picked up from some location.
`Vehicle`	The spare is located in the employees vehicle.
`Postcode`	The spare is available from the given postcode.
`OpenHoursOvrType`
Permitted Value(s)	Description
`Add`	The specified override should be taken as additional to existing open hours.
`Replace`	The specified override should replace existing open hours.
`ParameterId`
Permitted Value(s)	Description
`FRUID`	The supplied formal parameter `<value>` will be used where the role defines a formal parameter using the `FRU_ID` parameter type.
`OPERID`	The supplied formal parameter `<value>` will be used where the role defines a formal parameter using the `OPER_ID` parameter type.
`TEAMID`	The supplied formal parameter `<value>` will be used where the role defines a formal parameter using the `TEAM_ID` parameter type.
`ReturnCodeType`
Permitted Value(s)	Description
`OK`	The SOAP API call has been successful.
`Warning`	The SOAP API call has been successful, but there are provisos that have been made.
`Error`	The SOAP API call has failed.
`Fixed`	The Break has been taken so times are actual Break times.
`RoleAction`
Permitted Value(s)	Description
`ADD`	Add the role (and formal parameters, if supplied) the to user's permissions.
`UPDATE`	Update (i.e. replace) the formal parameters for the given role, for the user's permissions.
`REMOVE`	Delete the role (and any formal parameters, if configured) from the user's permissions.
`SameUnit`
Permitted Value(s)	Description
`Final`	In a booking operation, the same Final Responsibility Unit (FRU) should be used as previously offered.
`SpareSource`
Permitted Value(s)	Description
`None`	No spares are required on the job, or the job is in the intray.
`Van`	Spares are to be sourced from the van.
`External`	Spares are to be sourced externally.
`SpecialPeriodTZType`
Permitted Value(s)	Description
`Home`	The Special Periods are defined assuming the Employee’s home TZ.
`FRU`	Use the TZ of the FRU to which the Employee is posted.
`Default`	Use the TZ associated with the Employee.
`SplitGrpType`
Permitted Value(s)	Description
`NonConsecShift`	The split group is neither contiguous, nor consecutive.
`ConsecShift`	The split group is spread across consecutive shifts (i.e. there may be holidays and/or weekends between the shifts).
`ContigShift`	The split group only covers contiguous shifts (there are no non-working days between any part).
`StandardActivityTravelMode`
Permitted Value(s)	Description
`NoTravel`	Standard Activity will be given no travel either to or home from.
`ETS`	Travel will be included in the Standard Activity and it will be assumed that the start time given is the start time for travelling.
`ETA`	Travel will be included in the Standard Activity and it will be assumed that the start time given is the arrival time - travel will be added before this time.
`StandardActivityTZType`
Permitted Value(s)	Description
`Default`	Use the TZ associated with the Employee.
`Home`	Use the TZ of the Employee’s home address.
`FRU`	Use the TZ of the FRU to which the Employee is posted.
`Location`	Use the TZ of the location given for the Standard Activity (if one is given, otherwise defaults to `tz_default`).
`StdExtraDuration`
Permitted Value(s)	Description
`None`	There is no extra duration required to be added.
`LocalKeyPU`	There is a need to pick up a key from e.g. next door.
`DurationOneDay`	The job is an all day job so should be sized according to the Employee’s shift.
`UserUnitType`
Permitted Value(s)	Description
`ROOT`	The user's responsibility unit type is the top level responsibility unit.
BRU	The user's responsibility unit type is an BRU.
DRU	The user's responsibility unit type is an DRU.
`FRU`	The user's responsibility unit type is an FRU.
`UnitType`
Permitted Value(s)	Description
`FRU`	The unit specified is an FRU.
`DRU`	The unit specified is a DRU.
`WorkItemType`
Permitted Value(s)	Description
`Job`	The work item is a Job.
`StandardActivity`	The work item is a Standard Activity.

Common Specified Length Data Types

Enumerated Data Types

`ActLocType`

`ActTravelModeType`

`ActTZType`

`AssignmentType`

`AuditStatus`

`AuthType`

`Boolean`

`BreakType`

`DayOfTheWeek`

`DepEmpType`

`DepTimeType`

`DepUnits`

`DispEarmarkTypes`

`DispMode`

`DisStatus`

`EmpLocType`

`EmpMPX`

`EmpTravelStatus2`

`EmpType`

`EmpTZType`

`HistoryOptions`

`LKType`

`LocType`

`OpenHoursOvrType`

`ParameterId`

`ReturnCodeType`

`RoleAction`

`SameUnit`

`SpareSource`

`SpecialPeriodTZType`

`SplitGrpType`

`StandardActivityTravelMode`

`StandardActivityTZType`

`StdExtraDuration`

`UserUnitType`

`UnitType`

`WorkItemType`

Browser not supported