Document toolboxDocument toolbox

14.1 Return Codes

On This Page:

Every ServiceOptimizer SOAP API will return a return code, indicating success, a warning, or the reason for failure.

Return Codes 0 - 99

Return Code Name (Number)

Type

Description

SP_OK (0)


Success.

SP_JOBID_INVALID (1)

Error

The supplied JobID or ActNo is:

  • not in the ServiceOptimizer database;
  • is too long;
  • is empty; or
  • the job referenced starts outside the memory horizon.

SP_JOBTYPE_INVALID (2)

Error

The supplied JobType is:

  • not in the ServiceOptimizer database;
  • is too long; or
  • is empty.

SP_POSTCODE_INVALID (3)

Error

The supplied Postcode is:

  • not in the ServiceOptimizer database; 
  • is too long;
  • is empty; or
  • is not mapped to a region.

SP_LOCATION_INVALID (4)

Error

The supplied BookLoc is:

  • not in the ServiceOptimizer database; or
  • is too long.

SP_EMPID_INVALID (5)

Error

The supplied EmpID is:

  • too long;
  • is empty when required (EmpCreateRequest and EmpUpdateRequest); or
  • in a call to BookSplitDependencyRequest, with a pre-exisiting JobID, is not the same EmpID as previously used for that JobID.

(6) - (7)


Reserved.

SP_NO_TIME_AVAILABLE (8)

Error

An appointment for the criteria supplied is not available.

(9) - (11)


Reserved.

SP_DURATION_INVALID (12)

Error

The total job duration (including ‘overhead’ time) is longer than can be booked (SJTDMax) or (JobChangeFinishTimeRequest) the job’s Finish time would be the same as or before its Arrival time OR

In a call to EmpAddActRequest the expectedDuration given is < 0.

(13)


Reserved.

SP_DATE_INVALID (14)

Error

The supplied Date is:

  • not a date on the calendar; or
  • is too long.

SP_DAY_INVALID (15)

Error

A character other than “Y” or “N” is in the supplied Days; or

The field is too long.

SP_BAND_INVALID (16)

Error

The TimeBand supplied is not in the ServiceOptimizer database.

SP_INDEX_INVALID (17)

Error

The supplied Index parameter is invalid

SP_COUNT_INVALID (18)

Error

The supplied NumReq parameter in ApptOfferRequest is invalid; or

The ActCount field in GetActsRequest is invalid.

SP_END_NOT_GE_START_DATE (19)

Error

The supplied EndDate must be the same as or after the supplied StartDate.

SP_ABS_LOGGED_ERROR (20)

Error

The booking server (ABS) has detected a database error and logged it.

SP_EMP_UNAVAILABLE (21)

Error

There is no time during the Appointment Search Window (ApptOfferRequest) or the SLA Search Window (JobBookRequest) when at least one of the supplied mandatory EmpIDs is on shift (and not on public holiday) and is not unavailable (aka unschedulable).

(22)


Reserved.

SP_JOBID_EXISTS (23)

Error

The supplied JobID already exists in ServiceOptimizer (and AllowRebook is not set); or

In a call to BookSplitDependantJobsRequest, the JobID exists and existing part jobs are not logged off or cleared.

(24) - (26)


Reserved.

SP_SKILL_INVALID (27)

Error

(One of) the supplied ExtraSkills is:

  • not in the ServiceOptimizer database; or
  • is too long.

SP_UNIT_INVALID (28)

Error

The supplied Unit is :

  • not in the ServiceOptimizer database; 
  • is too long;
  • is the wrong type (not consistent with the corresponding UnitType field);
  • is missing (when both EmpMPX and UnitType are not _None); or
  • is present (when both EmpMPX and UnitTypeare _None); or

In a call to GetJobsRequest, the supplied RespUnit isn’t an FRU; or

A mandatory responsibility unit has been supplied but there is no one in it with the required skills to do the job during the Appointment Search Window (offerApptsRequest) or the SLA Search Window (JobBookRequest); or

In a call to loginRequest, the responsibility unit associated with the profile for the ServiceOptimizer username is invalid.

SP_TIME_INVALID (29)

Error

The supplied Time is not a valid time.

SP_PROM_SET_INVALID (30)

Error

The supplied PromSet is:

  • not in the ServiceOptimizer database; or
  • is empty; or

In a call to ApptBookRequest an OfferToken was not supplied:

  • if Band has been supplied, of type BandType, the promise set called “$<BandType>”  (e.g “$D”) is:
    • invalid; or
    • too long (>2 chars); or
  • if Band has not been supplied, the promise set “$$” is invalid.

(warning) The PromSet name does not support wide (i.e. multibyte) characters. Use of wide characters in the PromSet will cause the >2 chars error to be returned also.

SP_END_NOT_GT_START_TIME (31)

Error

In a call to ApptOfferRequest, StartDate and EndDate are the same but DayStartTime is later than DayEndTime; or

In a call to JobBookRequest, ContractLatest is before ContractEarliest; or

For one of the JobChange??TimeRequest functions , the job’s Arrival time would be earlier than its Start time, or its Finish time would be earlier than its Arrival time; or

For Add/UpdateSpecialPeriodRequest the end time of the Special Period would be before the start time.

SP_SKILLLEVEL_INVALID (32)

Error

The supplied skill level is not between 1 and 9; or

No skill level has been supplied in a call to EmpUpdateRequest.

SP_CANNOT_FORCE_SKILL (33)

Error

An appointment cannot be forced, with options InTrayWithSkills or InTrayAfterAll, because no one is available with the right skills during the Appointment Search Window (ApptOfferRequest) or the SLA Search Window  (JobBookRequest).

(34)

Error

Reserved.

SP_INVALID_PARAM (35)

Error

An invalid input parameter has been passed to an interface.

SP_CONNECT_FAIL (36)

Error

A SOAP call can’t be executed because the connection between the client library and the ServiceOptimizer server has been lost.

(37)


Reserved.

SP_COMMIT_ERROR (38)

Error

A database error occurred whilst trying to commit to the database.

SP_DATABASE_ERROR (39)

Error

A database error occurred whilst trying to perform a database action.

SP_DYN_MEMORY_ERROR (40)

Error

A SOAP call is unable to allocate space from heap memory.

(41)


Reserved.

SP_EMPID_ALREADY_EXISTS (42)

Error

The supplied EmpID is already in the ServiceOptimizer database.

(43) - (44)


Reserved.

SP_INVALID_STATUS (45)

Error

The supplied DisStatus is invalid OR an attempt has been made to set a status on a standard activity that is invalid e.g Travelling status on a standard activity that has TravelMode NoTravel, or any dispatch status on a standard activity that cannot be dispatched.

SP_NAME_NOT_SUPPLIED (46)

Error

The mandatory EmpName is empty.

(47)


Reserved.

SP_MANDATORY_SURNAME_NULL (48)

Error

The mandatory EmpSurname is empty.

SP_JOBTYPE_NOT_IN_DATE (49)

Error

The supplied JobType is not valid during any part of the Appointment Search Window (ApptOfferRequest) or the SLA Search Window  (JobBookRequest) or on the date specified (DVForceFixJobRequest).

SP_PROMTYPE_INVALID (50)

Error

The supplied PromType (NumReqType) is not in the ServiceOptimizer database, or isn’t the type of at least one of the timebands in the supplied promise set.

SP_JOBTYPE_CANNOT_BE_FORCED (51)

Error

The supplied JobType has the ‘cannot be forced’ flag set in the ServiceOptimizer database (only for ForceOptions InTray, InTrayWithSkills and InTrayAfterAll).

(52)


Reserved.

SP_OUTSIDE_HORIZON (53)

Error

SP_EXTRA_DURATION_INVALID (54)

Error

The supplied ExtraDuration + ExtraOverhead is  > 99999999, or > the database parameter SJEDMax, or the total duration for the job is > SJTDMax.

SP_START_DATE_INVALID (55)

Error

The supplied StartDate is invalid.

SP_END_DATE_INVALID (56)

Error

The supplied EndDate is invalid.

SP_PREFERRED_DATE_INVALID (57)

Error

The supplied PreferredDate is invalid.

SP_DAY_START_TIME_INVALID (58)

Error

The supplied DayStartTime is invalid (offer).

SP_DAY_END_TIME_INVALID (59)

Error

The supplied DayEndTime is invalid (offer).

SP_PROM_START_TIME_INVALID (60)

Error

The supplied PromStartTime is invalid (book).

SP_PROM_END_TIME_INVALID (61)

Error

The supplied PromEndTime is invalid (book).

SP_START_TIME_INVALID (62)

Error

The supplied StartTime is invalid.

SP_END_TIME_INVALID (63)

Error

The supplied EndTime is invalid.

(64) - (72)


Reserved.

SP_SEPMAX_EXCEEDED (73)

Error

Maximum number of separators exceeded (SP_AddSep()).

SP_REQTYPE_INVALID (74)

Error

The supplied ReqType is outside its allowed range (employees and responsibility units), or is STRT_None and UnitType is not SPUT_None and Unit has been supplied, or is not SPRT_None and UnitType is SPUT_None and Unit is empty. Or the supplied ReqEmpType is SPRT_None and the corresponding EmpID is not empty, or ReqEmpType isn’t SPRT_None and EmpID is empty. Or the supplied ReqEmpType is SPRT_MandOrdered or SPRT_PrefOrdered and 2 EmpIDs haven’t been supplied.

SP_EMP_NOT_SKILLED (75)

Error

None of the supplied mandatory EmpIDs has the skills for the Job Type during any part of the Appointment Search Window (ApptOfferRequest) or the SLA Search Window  (JobBookRequest).

SP_STDEXTRADURATION_INVALID (76)

Error

The supplied StdExtraDuration is outside its allowed range.

SP_UNITTYPE_INVALID (77)

Error

The supplied UnitType is outside its allowed range or is not implemented, or is SPUT_None and the corresponding ReqType is not SPRT_None and a Unit has been supplied, or is not SPUT_None and ReqType is SPRT_None and Unit is empty. Or (DispInitRequest) an IRU has been supplied for non-batch dispatch.

SP_INVALID_LOC_TYPE (78)

Error

The supplied LocType is outside its allowed range or is not implemented.

(79)


Reserved.

SP_OPTIONS_INVALID (80)

Error

The supplied Options has an undefined bit set.

SP_PRIORITY_INVALID (81)

Error

The supplied Priority is not >= 1 and <= 99.

SP_OFFERTOKEN_INVALID (82)

Error

The OfferToken supplied doesn’t reference an available appointment – usually because another user has booked it. It can also be returned when ApptBookRequestis called without supplying an OfferToken and another user books the job between the self-generated offer (self-generated because there was no OfferToken) and the corresponding book.

(83) - (84)


Reserved.

SP_STATUS_BACKWARDS (85)

Error

In a call to 14.1 Change Work Item Status SOAP API, the supplied NewStatus field has a value lower than the current value of the job’s dispatch status.

SP_STATUS_NO_CHANGE (86)

Error

In a call to 14.1 Change Work Item Status SOAP API, the supplied NewStatus field has a value which is the same as the current value of the job’s dispatch status; or

In a call to EmpChangeTravelStatus2Request the supplied NewStatus has the value Stopped when the Travel Status is already stopped.

SP_ALLOWREBOOK_INVALID (87)

Error

The value of  the supplied AllowRebook field is out of range.

SP_EMPSMAX_EXCEEDED (88)

Error

The number of MPX emps supplied exceeds 10.

SP_EMPID_DUPLICATED (89)

Error

The same EmpID has been supplied more than once.

(90) - (94)


Reserved.

SP_CUSTID_INVALID (95)

Error

The supplied CustID field is too long.

SP_CUSTNAME_INVALID (96)

Error

The supplied CustName field is too long.

SP_CUSTADD1_INVALID (97)

Error

The supplied CustAdd1 field is too long.

SP_CUSTADD2_INVALID (98)

Error

The supplied CustAdd2 field is too long.

SP_CUSTADD3_INVALID (99)

Error

The supplied CustAdd3 field is too long.

Return Codes 100 - 199

Return Code Name (Number)

Type

Description

SP_CUSTADD4_INVALID (100)

Error

The supplied CustAdd4 field is too long.

SP_CONTACTNAME_INVALID (101)

Error

The supplied ContactName field is too long.

SP_CUSTPHONE1_INVALID (102)

Error

The supplied CustPhone1 field is too long.

SP_CUSTPHONE2_INVALID (103)

Error

The supplied CustPhone2 field is too long.

SP_DESC1_INVALID (104)

Error

The supplied Desc1 field is too long.

SP_DESC2_INVALID (105)

Error

The supplied Desc2 field is too long.

SP_DESC3_INVALID (106)

Error

The supplied Desc3 field is too long.

SP_DESC4_INVALID (107)

Error

The supplied Desc4 field is too long.

(108) - (110)


Reserved.

SP_SPAREID_INVALID (111)

Error

The supplied SpareID is either longer than SpareID Size or is not in the ServiceOptimizer database. (If spareIgnVanStock is set, ServiceOptimizer doesn’t check that the SpareID is in the database)

SP_QUANTITY_INVALID (112)

Error

A supplied spare Quantity is either:

(113) - (114)


Reserved.

SP_NO_REG_TO_RU_MAPPING (115)

Error

In a call to ApptOfferRequest, ApptBookRequest, or JobBookRequest, the region containing the supplied PostCode is not mapped to a Responsibility Unit

SP_RELATIVE_START_DATE_INVALID (116)

Error

In a call to ApptOfferMultRequest, a relative StartDate has been supplied which is not in the format “+n”, “>=n”, “+n(TBT)”, or “>=n(TBT)” where n is an integer and TBT is a time band type in the ServiceOptimizer database

SP_MAX_OFFER_COUNT_REACHED (117)

Warning

Success – In a call to ApptOfferMultRequest, the search has been stopped after 999 (see section 4.3) offers have been generated. The offers generated so far are nonetheless returned.

SP_EXTRASKILL_DUPLICATED (118)

Error

In a call to a function which takes an ExtraSkills parameter, at least one skill has been supplied more than once

SP_JOBSKILLSMAX_EXCEEDED (119)

Warning

Success – In a call to a function which takes an ExtraSkills parameter, the number of extra skills supplied plus the number of skills already required by the job type is greater than can be returned in a call of GetJobsRequest (10)

SP_ACTIVITY_TYPE_INVALID (120)

Error

The supplied Act.ActTypeNum is either ActTypePreRingFenced or SP_ActTypePreShiftOverride or SP_ActTypePreCrewMember, or is not defined in the ServiceOptimizer database

SP_START_POSTCODE_INVALID (121)

Error

The supplied StartPostCode is too long or is not in the ServiceOptimizer database

SP_END_POSTCODE_INVALID (122)

Error

The EndPostCode field is either not supplied or is too long or is not in the ServiceOptimizer database

SP_ACTIVITY_NOTES_INVALID (123)

Error

The supplied ActNotes field is too long or, in a call to EmpAddActRequest or SP_ActSet(), has the value SP_StrNoUpdate

SP_EMP_NOT_IN_TEAM (124)

Error

The EmpID supplied is in the ServiceOptimizer database, but is not in a team during the period of the new Standard Activity.

SP_TEAM_NOT_IN_RU (125)

Error

The EmpID supplied is in a team during the period of the new activity, but the team is not in a responsibility unit.

(126) - (130)


Reserved.

SP_ACTIVITY_NO_INVALID (131)

Error

The supplied Act.ActNo is not in the ServiceOptimizer database, or it refers to something other than a standard activity (i.e. a job).  Or: the activity is outside the memory horizon.

SP_OVERLAPPED_JOBS (132)

Error

In a call to either EmpAddActRequest or ActUpdateRequest the supplied Options field contains CheckJobs and creating/changing the standard activity would give rise to one or more overlaps between it and existing resourced jobs.  Or : (DVForceFixJobRequest) moving the job to this position would cause an overlap with one or more other existing resourced jobs. OR: in a call to BookSplitDependencyGroupRequest an job part is attempting to be placed overlapping another work item without the forceJob option being set.

SP_EMPNAME_INVALID (133)

Error

The supplied employee Name is longer than EmpName Size, or is SP_StrNoUpdate (EmpCreateRequest)

SP_EMPSURNAME_INVALID (134)

Error

The supplied employee Surname is longer than EmpSurnameSize, or is SP_StrNoUpdate (EmpCreateRequest)

SP_EMPJOBTITLE_INVALID (135)

Error

The supplied employee JobTitle is longer than EmpJobTitle Size, or is SP_StrNoUpdate (EmpCreateRequest)

SP_EMPADDRESS1_INVALID (136)

Error

The supplied employee Address1 is longer than EmpAdd, or is SP_StrNoUpdate (EmpCreateRequest)

SP_EMPADDRESS2_INVALID (137)

Error

The supplied employee Address2 is longer than EmpAdd, or is SP_StrNoUpdate (EmpCreateRequest)

SP_EMPADDRESS3_INVALID (138)

Error

The supplied employee Address3 is longer than EmpAdd, or is SP_StrNoUpdate (EmpCreateRequest)

SP_EMPADDRESS4_INVALID (139)

Error

The supplied employee Address4 is longer than EmpAdd, or is SP_StrNoUpdate (EmpCreateRequest)

SP_EMPPHONE1_INVALID (140)

Error

The supplied employee Phone1 is longer than PhoneNo Size, or is SP_StrNoUpdate (EmpCreateRequest)

SP_EMPPHONE2_INVALID (141)

Error

The supplied employee Phone2 is longer than PhoneNo Size, or is SP_StrNoUpdate (EmpCreateRequest)

SP_PAGERNO_INVALID (142)

Error

The supplied employee PagerNo is longer than PagerNo Size, or is SP_StrNoUpdate (EmpCreateRequest)

(143)
Reserved.

SP_INVALID_TIME_ZONE_LOCATION (144)

Error

The timezone for a responsibility unit, region, employee etc has an illegal value

SP_ACT_DESC_INVALID (145)

Error

The supplied activity type description (ActType) is either empty, too long or does not exist in the ServiceOptimizer database.

SP_EXTRASKILLS_INVALID (146)

SP_SPARE_SUBS_EXCEEDED (147)

Error

The number of spares IDs supplied is more than 5

SP_UNRESOURCED_JOB (148)

Error

14.1 Change Work Item Status SOAP API has been called for an unresourced job OR JobUpdateRequest has been called for an unresourced job and the update is for an attribute other than Customer, Priority or Importance.

SP_VERSION_INVALID (149)

Error

The version of the interface call in a supplied Version field is not supported, or is not a valid value (eg. is SP_IntNoValue or SP_IntNoUpdate).

SP_FORCEOPTIONS_INVALID (150)

Error

The supplied ForceOptions field has an invalid bit set; or

For a call to the 14.1 Request Multi-Job Appointments SOAP API, any of the ForceOptions have been set.

(151)


Reserved.

SP_ACT_LOC_TYPE_INVALID (152)

Error

In a call to EmpAddActRequest, Act.ActEndLocType  can’t be Start or End on a day when the operative isn’t on shift OR,

in a call to ActUpdateRequest an attempt has been made to change an activity from one without a location to one with a location.

SP_ACT_LOC_REGION_NULL (153)

Error

The employee does not have the type of region specified in a supplied ActLocType (e.g: Work is supplied, but the employee doesn’t have a work region)

SP_TRAVEL_INVALID (154)

Error

In a call to one of the JobChange???TimeRequest functions or 14.1 Change Work Item Status SOAP API the new travel time would be longer than the (current) built in limit of 999999 seconds.

SP_EMP_ZERO_LK (155)

Error

Neither of the supplied EmpIDs has non-zero local knowledge of the region where the job is located during any part of the Appointment Search Window (ApptOfferRequest) or the SLA Search Window  (JobBookRequest).

SP_NO_SKILL (156)

Error

There is no employee available with the necessary skills during any part of the Appointment Search Window (ApptOfferRequest) or the SLA Search Window  (JobBookRequest).

SP_ACTIVITY_NOT_FOUND (157)

Error

In a call to GetActsRequest, no standard activity has been found for the search criteria provided.

(158)


Reserved.

SP_OPTION_COMBINATION_INVALID (159)

Error

SP_OVERLAPPED_STDACTS (160)

Error

SP_DISPATCHING_ALREADY (161)

Error

A second or subsequent call to DispInitRequest has been made, either for the same FRU in real time or for an FRU, Team or employee already being dispatched in batch mode. (The Team might be in an FRU already being dispatched, or the employee might be in a Team that may or may not be in an FRU already being dispatched.)

(162)


Reserved.

SP_DISP_BATCH_FINISHED (163)

Warning

Success. All of the jobs in this batch run have now been dispatched.

(164) - (165)


Reserved.

SP_NET_PORT_NUMBER_INVALID (166)

Error

The supplied port number is not in the range 1 to 65535 inclusive if a hostname has been supplied, or is > 65535 if the supplied hostname is NULL or empty (local host)

SP_NET_LOCAL_PORT_UNKNOWN (167)

Error

For a local host connection, the file containing the port number ($SPHOME/<InstanceName>/log/APIport.<username>) can’t be opened for reading

SP_NET_INIT_FAILED (168)

Error

The (client) initialisation of the network stack failed (usually because it’s installed incorrectly)

SP_NET_HOSTNAME_UNKNOWN (169)

Error

The supplied Hostname can’t be resolved to an IP address (often a DNS problem)

SP_NET_ADDRESS_INVALID (170)

Error

An invalid IP address has been supplied (e.g. 0.0.0.0 or 255.255.255.255)

SP_NET_UNREACHABLE (171)

Error

The network addressed could not be reached (usually a network or router problem))

SP_NET_TIME_OUT (172)

Error

The attempt to run the SOAP call has timed out

SP_NET_CONNECT_REFUSED (173)

Error

The attempted connection has reached the host but not the requested port (usually because the server software isn’t listening (running), or there are too many connections)

SP_NET_NO_CONNECTION (174)

Error

An interface function has been called when there is no TCP/IP connection between the client thread and the ServiceOptimizer server – possibly because loginRequest hasn’t been called from within the thread. (From V5, each client thread must open its own connection.)

SP_LOGIN_FAILED (175)

Error

The supplied database username and/or password are wrong for the supplied hostname and port

SP_USERNAME_INVALID (176)

Error

The ServiceOptimizer username (usually the same as the username on the host where the client program is running) is not in the ServiceOptimizer database

SP_VERSION_MISMATCH (177)

Error

The client and server can’t interoperate

SP_EMP_NOT_POSTED (178)

Error

None of supplied mandatory EmpIDs has a posting to the supplied mandatory Unit at any time during any part of the Appointment Search Window (ApptOfferRequest) or the SLA Search Window  (JobBookRequest).  Or (GetJobsRequest) the supplied EmpID doesn’t have a posting on the supplied DispatchDate. Or (DispInitRequest) has been asked to batch dispatch an Employee who is no longer in the system.

SP_POSTCODE_NOT_MAPPED (179)

Error

The supplied Postcode is not mapped to the supplied mandatory Unit. Or (when a mandatory Unit is not supplied): none of the supplied mandatory EmpIDs is posted to an FRU mapped to the supplied Postcode during any part of the Appointment Search Window (ApptOfferRequest) or the SLA Search Window  (JobBookRequest).

(180) - (183)

Error

Reserved.

SP_EMPTYPE_INVALID (184)

Error

The supplied EmpType is not one of its declared values, or is SP_IntNoUpdate (create), or is SP_IntNoValue

SP_EFFICIENCY_INVALID (185)

Error

The supplied Efficiency is not between 10 and 999.

SP_MAXOVERTIME_INVALID (186)

Error

The supplied MaxOvertime is not between 0 and 999

SP_ILT_INVALID (187)

Error

The supplied InformLeadTime is not between the limits defined in the ServiceOptimizer database (sp083.min_value/max_value where name = “TIL”), or, if these are undefined, is not between 0 and 9999

SP_EARMARKEDJOBSMAX_INVALID (188)

Error

The supplied EarmarkedJobsMax is not between 1 and 99

SP_HOMEPOSTCODE_INVALID (189)

Error

The supplied HomePostcode is longer than  Postcode Size, or is SP_StrNoUpdate (create)

SP_WORKPOSTCODE_INVALID (190)

Error

The supplied WorkPostcode is longer than  Postcode Size or is SP_StrNoUpdate (create)

SP_EMPTZTYPE_INVALID (191)

Error

The supplied EmpTZType is not one of its declared values, or is SP_IntNoUpdate (create)

SP_WORKTZ_INVALID (192)

Error

The supplied TZID is longer than TZID Size, or is SP_StrNoUpdate (create)

SP_AVAILABLE_INVALID (193)

Error

The supplied Available is not one of the declared values for SP_Bool, or is SP_IntNoUpdate (create)

SP_HANDHELDADD1_INVALID (194)

Error

The supplied HandHeldAdd1 is longer than  HandHeld Size or is SP_StrNoUpdate (create)

SP_HANDHELDADD2_INVALID (195)

Error

The supplied HandHeldAdd2 is longer than  HandHeld Size or is SP_StrNoUpdate (create)

SP_CURRENTHANDHELD_INVALID (196)

Error

The supplied CurrentHandHeld is not between 0 and 2 or is not specified on create

SP_PRINTER_INVALID (197)

Error

The supplied Printer is longer than Printer Size or is SP_StrNoUpdate (create)

(198)


Reserved.

SP_SKILL_DESC_INVALID (199)

Error

The supplied SkillDesc is longer than SkillDesc Size or is SP_StrNoUpdate (create)

Return Codes 200 - 299

Return Code Name (Number)

Type

Description

SP_TEAMID_INVALID (200)

Error

The supplied TeamID is longer than TeamID Size or is SP_StrNoUpdate (create)

SP_POSTINGSTARTDATE_INVALID (201)

Error

The supplied StartDate is longer than spDate Size or is SP_StrNoUpdate (create) or is not a date on the calendar

SP_POSTINGENDDATE_INVALID (202)

Error

The supplied EndDate is longer than spDate Size or is SP_StrNoUpdate (create) or is not a date on the calendar

SP_POSTINGTYPE_INVALID (203)

Error

The supplied SP_PostingType is not one of its declared values

SP_SKILLSTARTDATE_INVALID (204)

Error

The supplied StartDate is longer than spDate Size or is SP_StrNoUpdate (create) or is not a date on the calendar

SP_SKILLENDDATE_INVALID (205)

Error

The supplied EndDate is longer than spDate Size or is SP_StrNoUpdate (create) or is not a date on the calendar

SP_SHIFTPERIODTYPE_INVALID (206)

Error

The ShiftPeriodType in the supplied SP_EmpSkill is not one of its declared values or is SP_IntNoUpdate (create)

SP_SKILLISDERIVED_INVALID (207)

Error

The supplied IsDerived is not one of the declared values for SP_Bool, or is SP_IntNoUpdate (create)

SP_SHIFTPATTERNID_INVALID (208)

Error

The supplied ShiftPatternID is longer than ShiftPatternID Size, or is SP_StrNoUpdate (create)

SP_SHIFTASSSTARTDATE_INVALID (209)

Error

The supplied StartDate is longer than spDate Size or is SP_StrNoUpdate (create) or is not a date on the calendar

SP_SHIFTASSENDDATE_INVALID (210)

Error

The supplied EndDate is longer than spDate Size or is SP_StrNoUpdate (create) or is not a date on the calendar

SP_EMPCREATEOPTIONS_INVALID (211)

Error

The supplied Options field has an undefined bit set

SP_EMPUPDATEOPTIONS_INVALID (212)

Error

The supplied Options field has an undefined bit set

SP_SKILLID_NOT_SUPPLIED (213)

Error

The mandatory SkillID is empty

(214)


Reserved.

SP_EMPID_NOT_SUPPLIED (215)

Error

The supplied mandatory EmpID is empty

(216) - (219)


Reserved.

SP_HOMEPOSTCODE_NOT_SUPPLIED (220)

Error

The mandatory HomePostcode is empty

SP_WORKTZ_NOT_SUPPLIED (221)

Error

The supplied TZID is empty (if the supplied EmpTZType is SPETZT_Supplied)

SP_TEAMID_NOT_SUPPLIED (222)

Error

The mandatory TeamID is empty (create)

SP_POSTINGSTARTDATE_NOT_SUPPLIED (223)

Error

The mandatory StartDate is empty or is not a date on the calendar

(224) - (225)


Reserved.

SP_SKILLSTARTDATE_NOT_SUPPLIED (226)

Error

The mandatory StartDate is empty

SP_SHIFTPATTERNID_NOT_SUPPLIED (227)

Error

The mandatory ShiftPatternID is empty

SP_SHIFTASSSTARTDATE_NOT_SUPPLIED (228)

Error

The mandatory StartDate is empty

SP_SKILLID_ALREADY_EXISTS (229)

Error

There is already a skill with the supplied SkillID in the ServiceOptimizer database

(230)


Reserved.

SP_EMPID_DOES_NOT_EXIST (231)

Error

The supplied EmpID is not in the ServiceOptimizer database

SP_HOMEPOSTCODE_DOES_NOT_EXIST (232)

Error

The supplied HomePostcode is not in the ServiceOptimizer database

SP_WORKPOSTCODE_DOES_NOT_EXIST (233)

Error

The supplied WorkPostcode is not in the ServiceOptimizer database

SP_WORKTZ_DOES_NOT_EXIST (234)

Error

The supplied TZID is not in the ServiceOptimizer database

SP_POSTING_DOES_NOT_EXIST (235)

Error

A posting with the supplied primary key (EmpID and StartDateTime) is not in the ServiceOptimizer database.

SP_SHIFTASS_DOES_NOT_EXIST (236)

Error

A shift assignment with the supplied primary key (EmpID and StartDateTime) is not in the ServiceOptimizer database

SP_SKILLASS_DOES_NOT_EXIST (237)

Error

A skill assignment with the supplied primary key (EmpID, SkillID and StartDateTime) is not in the ServiceOptimizer database

SP_POSTING_START_GE_END (238)

Error

The supplied EndDateTime is not after the supplied StartDateTime

SP_SKILL_START_GE_END (239)

Error

The supplied EndDateTime is not after the supplied StartDateTime

SP_SHIFTASS_START_GE_END (240)

Error

The supplied EndDateTime is not after the supplied StartDateTime

SP_POSTINGS_OVERLAP (241)

Error

Two or more of the supplied SP_EmpPostings overlap in time

SP_SHIFTASS_OVERLAP (242)

Error

Two or more of the supplied shift assignments overlap in time

SP_SKILLS_OVERLAP (243)

Error

Two or more of the supplied SP_EmpSkills with the same SkillID overlap in time (irrespective of skill level)

SP_HOMEPOSTCODE_NOT_MAPPED (244)

Error

The supplied HomePostcode is in the ServiceOptimizer database, but is not mapped to a region

SP_WORKPOSTCODE_NOT_MAPPED (245)

Error

The supplied WorkPostcode is in the ServiceOptimizer database, but is not mapped to a region

SP_POSTING_STDACT_OVERLAP (246)

Error

A change to a posting has been requested that would cause at least one existing standard activity to be no longer wholly contained within one posting

SP_POSTING_WOULD_DEALLOC (247)

Error

A change to a posting has been requested that would cause at least one existing job to be no longer wholly contained within a single posting to the operative’s current FRU so that it would be de-allocated.

SP_SHIFTASS_WOULD_DEALLOC (248)

Error

A change to a shift assignment has been requested that would cause at least one existing job to be no longer wholly contained within a single shift assignment so that it would be de-allocated.

SP_TEAMID_DOES_NOT_EXIST (249)

Error

A team with the supplied TeamID does not exist in the ServiceOptimizer database

SP_SKILLID_DOES_NOT_EXIST (250)

Error

A skill with the supplied SkillID does not exist in the ServiceOptimizer database

SP_SHIFTPATTERNID_DOES_NOT_EXIST (251)

Error

A shift pattern with the supplied ShiftPatternID is not in the ServiceOptimizer database

(252)


Reserved.

SP_SKILLID_INVALID (253)

Error

The supplied SkillID is longer than Skill Size or is SP_StrNoUpdate (create)

SP_SPARE_SUB_DUPLICATED (254)

Error

One of the spare IDs in a list of substitutes has been supplied more than once.

(255) - (257)


Reserved.

SP_SERVICE_NOT_YET_RUNNING (258)

Error

The ServiceOptimizer service that a call to loginRequest is trying to connect to has started but isn’t yet available for calls. (Effectively, it’s still initialising.)

SP_FRU_UNAVAILABLE (259)

Error

The FRU that this call needs is not available. (This may be because it is being restarted. It may also be returned if all of the FRUs needed aren’t available.)

SP_INTERPROCESS_TIMEOUT (260)

Error

Communication between two ServiceOptimizer processes has timed out. It’s not possible to determine if the call executed completely or in part, though clearly read-only calls can simply be re-tried. One or more processes may be restarted, so subsequent calls may return SP_FRU_UNAVAILABLE (259) until full availability is restored.

SP_UNIT_NOT_SUPPLIED (261)

Error

In a call to GetJobsRequest, the RespUnit field is empty as well as the EmpID field. Or, in a call to OptimizerStartRequest or OptimizerStopRequest, the mandatory FRU wasn’t supplied.

SP_DISP_INIT_EXPECTED (262)

Error

A call to DispRequest has been made before a call to DispInitRequest.

SP_DISP_REQ_EXPECTED (263)

Error

A call to DispResultRequest has been made immediately after DispInitRequest, or another call to DispResultRequest has been made immediately after a call to DispResultRequest.

SP_OUTSIDE_FRU_POSTING (264)

Error

In a call to DVForceFixJobRequest, 14.1 Change Work Item Status SOAP API or one of the JobChangeTimeRequest functions, the job would move to a date and time when the employee it’s allocated to is either posted to another FRU or has no posting at all. (This won’t be returned if the 14.1 Change Work Item Status SOAP API call is to set the job’s status to SPDS_Cleared).

SP_NET_CONNECTED (265)

Error

A call to loginRequest has been made when a connection has already been established. (This may have occurred because an existing connection hasn’t been closed by a call to spQuit).

SP_OUTSIDE_CONTRACT (266)

Error

Moving the job to this position would place the job outside of its contract hours.

SP_EMP_NO_SPARES (267)

Error

The specified Employee does not have the appropriate spares for the job.

SP_EMP_MAXOVERTIME_EXCEEDED (268)

Error

The employee is on shift for this day, but the employee’s maximum allowed overtime will be exceeded by placing the job here.

SP_CAPACITY_EXCEEDED (269)

Error

Moving the job to this position would result in the allowed capacity for the day being exceeded.

SP_EMP_NOT_REQEMP (270)

Error

In a call to DVForceFixJobRequest the identified employee is not one of the Mandatory/Preferred employees for the job, or IS one of the excluded employees.

SP_EMP_NO_SHIFT_ASS (271)

Error

In a call to DVForceFixJobRequest the employee specified has no shift assignment for the given date.

SP_SPARES_AND_NOT_TENTATIVE (272)

Error

In a call to DVForceFixJobRequest the job cannot be moved due to the fact that it requires spares and it is no longer at Tentative status.

SP_EMP_NOT_SCHEDULABLE (273)

Error

The specified employee is marked as unschedulable.

SP_EMP_NOT_ON_SHIFT (274)

Error

The employee is not on shift in the given period

SP_JOB_GT_LOGGEDON (275)

Error

The supplied job cannot be moved as its status is LoggedOff or greater.

SP_OUTSIDE_APPOINTMENT (276)

Error

Moving the job to this position would place the job outside of its Earliest time and Latest time.

SP_REGIONID_INVALID (277)

Error

The supplied RegionID is not in the ServiceOptimizer database.

SP_FRUID_INVALID (278)

Error

The supplied FRUID doesn’t exist in the ServiceOptimizer database.

SP_NO_REGIONS_IN_RU (279)

Error 

No regions were found for the FRU.

SP_EMP_NO_LK (280)

Error 

No local knowledge has been found for the employee.

SP_MAX_INVALID (281)

Error

The supplied Max value is outside its allowed range.

(282) - (283)


Reserved.

SP_TRANS_MAX_RESTARTS_EXCEEDED (284)

Error

A concurrent update of the database has been detected so the call has been re-started, but the number of times that it should be re-started has been exceeded.

SP_POSTING_HAS_ENDDATE (285)

Error

EmpAddActRequest (or ActUpdateRequest or SP_ActSet()) has been called with no Act.ExpectedEnd (i.e. to create an indefinite standard activity) but the employee’s posting has an end date so the requested activity can’t be contained in a posting to the same FRU.

SP_SPANS_POSTINGS (286)

Error

In a call to EmpAddActRequest, or ActUpdateRequest or SP_ActSet(), or AddSpecialPeriodRequest, the supplied start and end times aren’t within the same posting to the same FRU (not necessarily to the same Team).

SP_IMPORTANCE_INVALID (287)

Error

The supplied value of Importance isn’t within the allowed range of 0  to  ABS_importance_max or has been supplied in a call to ApptOfferMultRequest.

(288) - (290)


Reserved.

SP_CLIENT_TYPE_INVALID (291)

Error

A web services client has attempted to connect to a server that isn’t an API Agent (possibly a Gantt Server?).

SP_OPT_RUN_TIME_INVALID (292)

Error

The supplied value of RunTime is either less than zero or is greater than the value of opt_api_rt_max (minutes) for the supplied FRU.

SP_OPT_ALREADY_RUNNING (293)

Error

An Optimizer can’t be started because there’s already one running for the supplied FRU on the supplied Date.

SP_OPT_ON_HOLD (294)

Error

The Optimizer requested can’t be started because it has been put on hold.

SP_OPT_NOT_RUNNING (295)

Error

The Optimizer requested isn’t in the Waiting, Running, De-allocating or Re-allocating states.

SP_DATE_IN_PAST (296)

Error

The supplied Date is earlier than today.

(297) - (299)


Reserved.

Return Codes 300 - 399

Return Code Name (Number)

Type

Description

(300) - (303)


Reserved.

SP_STARTLOC_INVALID (304)

Error

The supplied DefaultStartLoc (EmpAttr) or StartLoc (EmpWorkPatt) is outside the range of values defined by EmpLocType.

SP_STARTLOCPOSTCODE_INVALID (305)

Error

The supplied DefaultStartLocPostcode (EmpAttr) or StartLocPostcode (EmpWorkPatt) is longer than Postcode Size.

SP_ENDLOC_INVALID (306)

Error

The supplied DefaultEndLoc (EmpAttr) or EndLoc (EmpWorkPatt) is outside the range of values defined by EmpLocType.

SP_ENDLOCPOSTCODE_INVALID (307)

Error

The supplied DefaultEndLocPostcode (EmpAttr) or EndLocPostcode (EmpWorkPatt) is longer than Postcode Size.

(308)


Reserved.

SP_STARTLOCPOSTCODE_DOES_NOT_EXIST (309)

Error

The supplied DefaultStartLocPostcode (EmpAttr) or StartLocPostcode (EmpWorkPatt) is not in the ServiceOptimizer database.

SP_ENDLOCPOSTCODE_DOES_NOT_EXIST (310)

Error

The supplied DefaultEndLocPostcode (EmpAttr) or EndLocPostcode (EmpWorkPatt) is not in the ServiceOptimizer database.

(311) - (313)


Reserved.

SP_STARTLOCPOSTCODE_NOT_SUPPLIED (314)

Error

The supplied DefaultStartLoc (EmpAttr) is set to Supplied, but the employee does not have a DefaultStartLocPostcode already in the ServiceOptimizer database or supplied in this call. Or: A supplied StartLoc (EmpWorkPatt) is set to Supplied, but the employee doesn’t have a StartLocPostcode for the same WorkPattDay already in the ServiceOptimizer database or supplied with this call.

SP_ENDLOCPOSTCODE_NOT_SUPPLIED (315)

Error

The supplied DefaultEndLoc (EmpAttr) is set to Supplied, but the employee does not have a DefaultEndLocPostcode defined in the ServiceOptimizer database or supplied in this call. Or: A supplied EndLoc (EmpWorkPatt) is set to Supplied, but the employee doesn’t have a EndLocPostcode for the same WorkPattDay already in the ServiceOptimizer database or supplied with this call.

SP_FRUS_AND_TEAMS_BOTH_SUPPLIED (316)

Error

A call to JeopReportRequest should supply a list of FRUs or Teams, but not both.

(317)


Reserved.

SP_JEOPARDYINIT_EXPECTED (318)

Error

N/A

SP_JEOPARDY_FINISHED (319)

Warning

The whole report of jobs in jeopardy, requested by a series of calls to JeopReportRequest, has been sent to the caller.

SP_JEOPARDY_REPORT_INCOMPLETE (320)

Warning

The report of jobs in jeopardy, requested by a series of  calls call to JeopReportRequest, has been sent to the caller, but some jobs may be missing because of an unexpected internal error.

SP_BREAK_EARLIEST_INVALID (321)

Error

The supplied BreakEarliest isn’t a valid Time.

SP_BREAK_LATEST_INVALID (322)

Error

The supplied BreakLatest isn’t a valid Time.

SP_BREAK_DURATION_INVALID (323)

Error

The supplied BreakDuration isn’t ≥ 0 and ≤ 999.

OR

A supplied BreakDuration = -1 and the supplied BreakName does not exist

(324)


Reserved.

SP_SO_NO_SHIFT (325)

Error

The EmpID has no shift or shift assignment on the supplied Date and SP_OptEmpOverrideNoShift isn’t set.  Or, the EmpID has no shift or shift assignment on that Date, and StartTime and EndTime have both not been supplied.

SP_SO_HOLIDAY (326)

Error

The EmpID is on public holiday on the supplied Date and OptEmpOverridePubHol isn’t set.

(327)


Reserved.

SP_OK_JOBS_ON_HOLIDAY (328)

Warning

Success, but the EmpID has jobs assigned to him on a day when a public holiday has been restored.

SP_OK_JOBS_ON_NO_SHIFT (329)

Warning

Success, but EmpID has jobs assigned to him on a day when he has no shift to be restored.

SP_PUBHOLSETID_INVALID (330)

Error

A supplied PubHolSetID is too long.

SP_PUBHOLSETID_DOES_NOT_EXIST (331)

Error

A supplied PubHolSetID is not in the  ServiceOptimizer database

(332)


Reserved.

SP_DELIVERY_SIZE_INVALID (333)

Error

The supplied DeliverySize is either less than 0 or is greater than glob_vehicle_capacity_max. Or has been supplied with a non-zero value in a call to ApptOfferMultRequest.

SP_PICKUP_SIZE_INVALID (334)

Error

The supplied PickupSize is either less than 0 or is greater than glob_vehicle_capacity_max. Or has been supplied with a non-zero value in a call to ApptOfferMultRequest.

SP_DESCRIPTION2_INVALID (335)

Error

The supplied Desc2 is longer than Description2Size.

SP_OFFERTOKEN_OPTIONS_MISMATCH (336)

Error

In a call to ApptBookRequest, the supplied OfferToken is for a forced (in-tray) offer but neither InTray nor InTrayWithSkills is set – or vice versa.

(337) - (338)


Reserved.

SP_PREFERRED_DATE_OUTSIDE_HORIZON (339)

Error

In a call to ApptOfferRequest, the supplied PreferredDate is outside the memory horizon.

(340)


Reserved.

SP_RANGELKS_TRAVEL_INVALID (341)

Error

In a supplied EmpLocKnowRange struct TravelTime is greater than 255.

SP_RANGELKS_LKVALUE_INVALID (342)

Error

A supplied LKValue is greater than 10.

SP_RANGELKS_DUPLICATE (343)

Error

In the supplied SP_EmpLocKnowRangeSeq contains more than one SP_EmpLocKnowRange struct with the same TravelTime value.

SP_SHIFTS_WOULD_OVERLAP (344)

Error

One or more of the operative’s shifts would overlap another (while the shift assignments dates don’t).

SP_SHIFTS_TOO_CLOSE (345)

Error

The time between the end of one shift and the start of the next would be smaller than glob_min_shift_gap and SP_OptEmpAllowShiftsTooClose isn’t set.

SP_OK_IMPORTANCE_IGNORED (346)

Warning

Success.  In a call to ApptOfferRequest, ApptBookRequestor JobBookRequest,  a value for Importance has been supplied but has been ignored because the Allow De-allocation option isn’t switched on in the ServiceOptimizer server for all of the FRUs being searched.  Offers may nonetheless still be returned.

SP_LKCLOC_INVALID (347)

Error

The supplied DefaultLKCLoc (EmpAttr) or LKCLoc (EmpWorkPatt) is outside the range of values defined by EmpLocType.

SP_LKCLOCPOSTCODE_DOES_NOT_EXIST (348)

Error

The  supplied DefaultLKCLocPostcode (EmpAttr) or LKCLocPostcode (EmpWorkPatt) is not in the ServiceOptimizer database.

SP_LKCLOCPOSTCODE_NOT_SUPPLIED (349)

Error

The supplied DefaultLKCLoc (EmpAttr) is set to Supplied, but the employee doesn’t have DefaultLKCLocPostcode defined in the ServiceOptimizer database or supplied in this call. Or: A supplied LKCLoc (EmpWorkPatt) is set to Supplied, but the employee doesn’t have a LKCLocPostcode for the same WorkPattDay already in the ServiceOptimizer database or supplied with this call.

SP_LKCLOCPOSTCODE_INVALID (350)

Error

The supplied DefaultLKCLocPostcode (EmpAttr) or LKCLocPostcode (EmpWorkPatt) is longer than Postcode Size.

SP_SO_SHIFT_END_NOT_AFTER_START (351)

Error

The shift override end is not after its start.

SP_BREAK_EARLIEST_AFTER_LATEST (352)

Error

The supplied BreakEarliest is after the supplied BreakLatest.

SP_BREAK_EARLIEST_BEFORE_SHIFT_START (353)

Error

The supplied BreakEarliest is before the supplied shift start.

SP_BREAK_LATEST_AFTER_SHIFT_END (354)

Error

The supplied BreakLatest is after the supplied shift end.

SP_ISADJSHIFT_INVALID (355)

Error

The value supplied for IsAllDayJobShift is not valid for type SP_Bool.

SP_ISCAPSHIFT_INVALID (356)

Error

The value supplied for IsCapacityShift is not valid for type SP_Bool.

SP_RANGELKS_DOES_NOT_EXIST (357)

Error

In a supplied SP_EmpLocKnowRange struct, at least one of the LKValues doesn’t already exist and UpdateAllowAdd isn’t set to allow it to be created.

(358) - (360)


Reserved.

SP_DISPATCH_MODE_INVALID (361)

Error

In a call to DispInitRequest, the supplied value of DispatchMode isn’t one of the values defined in DispMode.

SP_JOBS_MAX_INVALID (362)

Error

In a call to DispInitRequest, the supplied value of BatchInfo.JobsMax is 0.

SP_RANGE_TYPE_INVALID (363)

Error

In a call to DispInitRequest, the supplied value of BatchInfo.RangeType isn’t one of the values defined in DispRangeType.

SP_RANGE_START_GT_END (364)

Error

In a call to DispInitRequest, the supplied value of BatchInfo.RangeStart is later than BatchInfo.RangeEnd.

SP_RANGE_START_INVALID (365)

Error

In a call to DispInitRequest, the supplied value of BatchInfo.RangeStart is not a valid date and time.

SP_RANGE_END_INVALID (366)

Error

In a call to DispInitRequest, the supplied value of BatchInfo.RangeEnd is not a valid date and time.

SP_FRU_TEAM_EMP_COMBINATION_INVALID (367)

Error

In a call to DispInitRequest, FRUs or Teams or an EmpID can be supplied, but not a combination.

SP_BATCHINFO_NULL (368)

Error

In a call to DispInitRequest, DispatchMode is set to Shifts, but the supplied BatchInfo is NULL.

SP_OK_ABS_SEARCH_TIMEOUT (369)

Warning

Success.  In a call to ApptOfferRequest, ApptBookRequestor JobBookRequest, the time taken searching for available capacity has exceeded ABS_search_timeout (though some offers have been returned).

SP_NTA_ABS_SEARCH_TIMEOUT (370)

Error

In a call to ApptOfferRequest, ApptBookRequestor JobBookRequest, no available capacity has been found and the search time has exceeded ABS_search_timeout (similar to SP_NO_TIME_AVAILABLE (8), but the search timed out).

SP_WOULD_BREAK_ACCESS_HOURS (371)

Error

In a call to EmpAddActRequest, ActUpdateRequest or SP_ActSet(), the Option CheckJobsShuffle is set (to allow shuffling), but the shuffling operation would allow at least one job to break its Access Hours and CheckJobsAllowBreakAH isn’t set.

(372)


Reserved.

SP_OK_WITH_OVERLAPS (373)

Warning

Success. In a call to 14.1 Change Work Item Status SOAP API one of the JobChange???TimeRequest functions, EmpAddActRequest, ActUpdateRequest, SP_ActSet(), FixBreakTimesRequest or EmpOverrideRequest some overlaps have remained, even though job shuffling may have been done.

SP_WOULD_SPAN_DAYS (374)

Error

In a call to onr of the JobChange???TimeRequest functions, the job would end up spanning more than one day and so would be fixed and not schedulable by the Optimizer.

SP_SHIFT_TOO_LONG (375)

Error

The time between the start time and the end time of the shift is greater than 24 hours.

(376)


Reserved.

SP_INTERNAL_ERROR (377)

Error

An internal error has occurred in the ServiceOptimizer server. The details are in the appropriate FRU process’s diagnostic log (see System Admin Guide).

(378)


Reserved.

SP_DST_TIME_INVALID (379)

Error

One of the supplied times is invalid because it’s during the Spring DST changeover when clocks are put forward.

SP_TRAVELLING_TOO_EARLY (380)

Error

In a call to SP_ChangeJobStatus(SPDS_Travelling), the supplied value of DateTime is earlier than the current Start time by more than tol_cjs_travelling.

SP_TRAVELLING_TOO_LATE (381)

Error

In a call to SP_ChangeJobStatus(SPDS_Travelling), the supplied value of DateTime is later than the current Start time by more than tol_cjs_travelling.

SP_LOGGEDON_TOO_EARLY (382)

Error

In a call to SP_ChangeJobStatus(SPDS_LoggedOn), the supplied value of DateTime is earlier than the current Arrival time by more than tol_cjs_logged_on.

SP_LOGGEDON_TOO_LATE (383)

Error

In a call to SP_ChangeJobStatus(SPDS_LoggedOn), the supplied value of DateTime is later than the current Arrival time by more than tol_cjs_logged_on.

SP_LOGGEDOFF_TOO_LATE (384)

Error

In a call to SP_ChangeJobStatus(SPDS_LoggedOff), the supplied value of DateTime is later than <now> by more than tol_cjs_logged_off.

SP_CLEARED_TOO_LATE (385)

Error

In a call to SP_ChangeJobStatus(SPDS_Cleared), the supplied value of DateTime is later than <now> by more than tol_cjs_cleared.

SP_START_MOVED_TOO_FAR (386)

Error

In a call to JobChangeStartTimeRequest, the supplied StartDateTime is later than the end of the day on tol_cjdt_start working days after the day on which the job is currently scheduled.

SP_ARRIVES_ON_ANOTHER_DAY (387)

Error

In a call to JobChangeArrivalTimeRequest, the supplied ArrivalDateTime is not on the same day as the existing arrival time.

SP_JOB_TOO_LONG (388)

Error

In a call to JobChangeFinishTimeRequest, the supplied FinishDateTime is not before the end of the next day

SP_SERVHOURS_DUPLICATED (389)

Error

Either ServHoursPreDefPatts or ServHoursPatts should be supplied but not both.

SP_ACCHOURS_DUPLICATED (390)

Error

If ServAsAccHours is set, an Access Hours Pattern should not be supplied too.

SP_OPEN_ENDED_ACCHOURS_NOT_ALLOWED (391)

Error

At least one of the supplied Access Hours Overrides doesn’t have an end date and time.

(392)


Reserved.

SP_VEHICLE_CAPACITY_INVALID (393)

Error

The supplied value of  VehicleCapacity is greater than glob_vehicle_capacity_max.

SP_DOTW_INVALID (394)

Error

One of the supplied DotW fields is not within the range defined by DayOfTheWeek

SP_GRACE_PERIOD_INVALID (395)

Error

The supplied GracePeriod isn’t between 0 and 240 (inclusive).

(396)


Reserved.

SP_SERVHOURS_STARTTIME_INVALID (397)

Error

The supplied StartTime is not a valid time.

SP_SERVHOURS_ENDTIME_INVALID (398)

Error

The supplied EndTime is not a valid time.

SP_SERVHOURS_OVERLAP (399)

Error

At least two of the supplied Service Hours Periods overlap.

Return Codes 400 - 499

Return Code Name (Number)

Type

Description

SP_SERVHOURS_STARTDATE_INVALID (400)

Error

The supplied StartDate is not a valid date.

SP_SERVHOURS_ENDDATE_INVALID (401)

Error

The supplied EndDate is not a valid date.

(402)


Reserved.

SP_SERVHOURSPATTSEQ_PATTS_NULL (403)

Error

In a supplied SP_ServHoursPattSeq, Reserved is > 0 but ServHourPatts is NULL.

SP_OUTSIDE_SERVICE_HOURS (404)

Error

Moving the job to this position would place the job outside of its Service hours (including its Grace period).

SP_SERVHOURSPREDEFPATTSEQ_PATTS_NULL (405)

Error

In a supplied SP_ServHoursPreDefPattSeq, Size is > 0 but ServHoursPreDefPatts is NULL.

SP_SERVHOURS_PATTID_INVALID (406)

Error

The supplied ServHoursPattID is longer than ServHoursPattID Size.

SP_SERVHOURS_PATTID_DOES_NOT_EXIST (407)

Error

The supplied ServHoursPattID does not exist.

(408)


Reserved.

SP_TOTB_INVALID (409)

Error

The supplied value of  TOTB is < 0 or > 1440

SP_DAYANDTIMEPERIODSEQ_PERIODS_NULL (410)

Error

In a supplied SP_DayAndTimePeriodSeq, Size is > 0 but DayAndTimePeriods is NULL.

SP_ACCHOURS_STARTTIME_INVALID (411)

Error

The supplied StartTime is not a valid time.

SP_ACCHOURS_ENDTIME_INVALID (412)

Error

The supplied EndTime is not a valid time. (This can arise if ServAsAccHours is set and an Access Hours time period becomes > 24 hours when the Grace Period is added.)

SP_ACCHOURS_OVERLAP (413)

Error

At least two of the supplied Access Hours Periods overlap.

SP_ACCHOURS_STARTDATE_INVALID (414)

Error

The supplied StartDate is not a valid date.

SP_ACCHOURS_ENDDATE_INVALID (415)

Error

The supplied EndDate is not a valid date.

(416)


Reserved.

SP_ACCHOURSPATTSEQ_PATTS_NULL (417)

Error

In a supplied SP_AccHoursPattSeq, Size is > 0 but Reserved is NULL.

SP_SERVHOURSPATTSEQ_SIZE_INVALID (418)

Error

In a supplied SP_ServHoursPattSeq, Size is not > 0.

SP_DAYANDTIMEPERIODSEQ_SIZE_INVALID (419)

Error

In a supplied SP_DayAndTimePeriodSeq, Size is not > 0.

SP_SERVHOURSPREDEFPATTSEQ_SIZE_INVALID (420)

Error

In a supplied SP_ServHoursPreDefPattSeq, Size is not > 0.

SP_ACCHOURSPATTSEQ_SIZE_INVALID (421)

Error

In a supplied SP_AccHoursPattSeq, Size is not > 0.

(422)


Reserved.

SP_OUTSIDE_ACCHOURS (423)

Error

Moving the job to this position would mean the employee arrives to begin the job outside of the Access hours for the job or (call-to-fix only) ends the job outside of the Access hours for the job.

(424)


Reserved.

SP_CUSTOMKWVSEQ_SIZE_INVALID (425)

Error

The Size supplied in CustomKWVs is < 0.

SP_CUSTOMKEYWORD_INVALID (426)

Error

At least one of the supplied Keywords is longer than CustomKeywordSize or is “”.

SP_CUSTOMVALUE_INVALID (427)

Error

At least one of the supplied Values is longer than CustomValueSize or is of the wrong type (format).

SP_CUSTOMKEYWORD_DOES_NOT_EXIST (428)

Error

At least one of the supplied Keywords is not defined in the ServiceOptimizer database.

SP_SERVHOURSPATTSEQ_NOT_SAME (429)

Error

In a supplied SP_ServHoursPattSeq, the same Service Hours pattern must be supplied for each date range.

(430)


Reserved.

SP_DATETIMERANGESEQ_RANGES_NULL (431)

Error

In a supplied SP_DateTimeRangeSeq, DateTimeRanges is NULL.                                         

SP_DATETIMERANGESEQ_SIZE_INVALID (432)

Error

In a supplied SP_DateTimeRangeSeq, Size is not > 0.

SP_OPENHOURSOVRTYPE_INVALID (433)

Error

A supplied OpenHoursOvrType is not one of its defined values.

SP_OPENACCHOURSOVR_START_INVALID (434)

Error

A supplied StartDateTime is not a valid date/time or is not supplied.

SP_OPENACCHOURSOVR_END_INVALID (435)

Error

A supplied EndDateTime is not a valid date/time.

SP_OPENACCHOURSOVR_END_NOT_GT_START (436)

Error

A supplied EndDateTime is not greater than the StartDateTime.

SP_CLOSEDACCHOURSOVR_START_INVALID (437)

Error

A supplied StartDateTime is not a valid date/time or is not supplied.

SP_CLOSEDACCHOURSOVR_END_INVALID (438)

Error

A supplied EndDateTime is not a valid date/time.

SP_CLOSEDACCHOURSOVR_END_NOT_GT_START (439)

Error

A supplied EndDateTime is not greater than the StartDateTime.

SP_AFTER_JEOPARDY_ETA (440)

Error

Moving the job to this position would mean the job now starts after the set Jeopardy ETA.

SP_CONTRACT_EARLIEST_INVALID (441)

Error

The supplied ContractEarliest isn’t a valid date.

SP_CONTRACT_LATEST_INVALID (442)

Error

The supplied ContractLatest isn’t a valid date or is not supplied.

SP_NO_ACCHOURS (443)

Error

No access hours (access hours pattern or overrides) have been supplied.

SP_SERVHOURS_DATERANGE_END_NOT_GT_START (444)

Error

In a supplied date range for a Service Hours pattern, the EndDate isn’t the same as or after the corresponding StartDate.

SP_TOTA_INVALID (445)

Error

The supplied value of  TOTA is < 0 or > 1440

SP_SERVHOURS_DATERANGE_OVERLAP (446)

Error

Two or more of the supplied date ranges for Service Hours overlap.

SP_ETA_OUTSIDE_ACC_HOURS (447)

Error

The current ETA (or ETF if call to fix) of the job is not within the resulting Access Hours

SP_SERVHOURSPREDEFPATTSEQ_NOT_SAME (448)

Error

In a supplied SP_ServHoursPreDefPattSeq, the same ServHoursPattID must be supplied for each date range.

SP_NET_NOT_LOGGED_IN (449)

Error

An attempt has been made to execute a SOAP web service call without having logged in or supplied login information with the service call.

SP_OPT_USE_AH_INVALID (450)

Error

OpenAccHoursOvrs have been supplied but the UseAccHours option has also been set.

SP_CUSTOMKEYWORD_DUPLICATED (451)

Error

In the supplied set of custom values (SP_CustomKWVSeq), at least one of the Keywords has been supplied more than once.

SP_PUBHOLSETID_DUPLICATED (452)

Error

In the supplied set of Public Holidays (SP_PubHolSetSeq), at least one of the PubHolSetIDs has been supplied more than once.

(453)

Error

Reserved.

SP_CUSTOMKWVSEQ_CUSTOMKWVS_NULL (454)

Error

In a supplied SP_CustomKWVSeq, CustomKWVs is NULL.

SP_PUBHOLSETSEQ_PUBHOLSETS_NULL (455)

Error

In a supplied SP_PubHolSetSeq, PubHolSets is NULL.

SP_REGIONLKS_LKVALUE_DOES_NOT_EXIST (456)

Error

A supplied LKValue in DefaultRegionLKs (EmpSeqs) or RegionLKs (WorkPattDay) is not in the ServiceOptimizer database.

(457)


Reserved.

SP_LKRANGE_LKVALUE_DOES_NOT_EXIST (458)

Error

A supplied LKValue in DefaultRangeLKs (EmpSeqs) or RangeLKs (WorkPattDay) is not in the ServiceOptimizer database.

SP_TRAVELTIME_INVALID (459)

Error

The Supplied TravelTime is greater than 255

SP_CLOSEDDATES_SEQ_SIZE_INVALID (460)

Error

In the supplied ClosedDates sequence, Size is not > 0.

(461)


Reserved.

SP_CLOSEDDATES_SEQ_DATERANGES_NULL (462)

Error

In the supplied ClosedDates sequence, DateRanges is NULL.

SP_CLOSEDDATES_STARTDATE_INVALID (463)

Error

A supplied ClosedDates StartDate is not valid.

SP_CLOSEDDATES_ENDDATE_INVALID (464)

Error

A supplied ClosedDates EndDate is not valid.

SP_ACCHOURS_DATERANGE_END_NOT_GT_START (465)

Error

A date range for the supplied Access Hours has an EndDate that isn’t the same as or after the corresponding StartDate.

SP_ACCHOURS_DATERANGE_OVERLAP (466)

Error

Two or more of the supplied DateRanges for Access Hours overlap.

(467)


Reserved.

SP_ACCHOURSPATTSEQ_NOT_SAME (468)

Error

In a supplied SP_AccHoursPattSeq, the same Access Hours pattern must be supplied for each date range.

(469)


Reserved.

SP_CLOSEDDATES_END_NOT_GT_START (470)

Error

A supplied ClosedDates EndDate isn’t the same as or after the corresponding StartDate.

SP_REQ_OPTION_NOT_SET (471)

Error

A mandatory Option isn’t set but the corresponding fields has been supplied for a ‘replacement’ type of update.

SP_EMPWORKPATT_DAYS_NULL (472)

Error

In a supplied SP_EmpWorkPatt, Size is > 0 but WorkPattDays is NULL.

SP_LOCKNOWREGIONSEQ_REGIONS_NULL (473)

Error

In a supplied SP_LocKnowRegionSeq, Size is > 0  but LocKnowRegions is NULL.

SP_LOCKNOWRANGESEQ_RANGES_NULL (474)

Error

In a supplied SP_LocKnowRangeSeq, Size is > 0 but LocKnowRanges is NULL.

SP_PRIORITY_NO_COST (475)

Error

There is no overdue cost associated with either the supplied Priority or with the default (SP_PriorityNormal).

SP_IMPORTANCE_NO_COST (476)

Error

A value of Importance has been supplied for which the associated cost  is 0.

SP_JOB_IS_APPOINTMENT (477)

Error

JobUpdateRequest can’t be called for an appointment

SP_EMPWORKPATT_SIZE_GT_MAX (478)

Error

In the supplied Work Pattern (EmpWorkPatt), Size is > Max.

SP_WPD_DUPLICATED (479)

Error

In the supplied Work Pattern (EmpWorkPatt), at least one day (WeekNum & DotW) has been supplied more than once.

SP_EMP_WPD_WEEKNUM_INVALID (480)

Error

In the supplied Work Pattern (EmpWorkPatt), at least one value of WeekNum isn’t between (inclusive) 1 and 53

SP_DEFAULT_RANGE_DUPLICATED (481)

Error

In the supplied DefaultRangeLKs (EmpSeqs), at least one TravelTime has been supplied more than once.

SP_DEFAULT_REGION_DUPLICATED (482)

Error

In the supplied DefaultRegionLKs (EmpSeqs), at least one RegionID has been supplied more than once.

SP_EMP_WPD_RANGE_DUPLICATED (483)

Error

On at least one of the days in the supplied EmpWorkPatt, at least one RangeLKs TravelTime has been supplied more than once.

SP_EMP_WPD_REGION_DUPLICATED (484)

Error

On at least one of the days in the supplied EmpWorkPatt, at least one RegionLKs RegionID has been supplied more than once.

(485) - (487)


Reserved.

SP_REGIONLKS_LKVALUE_INVALID (488)

Error

A supplied LKValue in DefaultRegionLKs or RegionLKs (WorkPattDay) is greater than 10.

SP_EMPWORKPATT_SYNC_DATE_INVALID (489)

Error

The supplied SyncDate is not a valid date.

(490) - (491)


Reserved.

SP_WRONG_EMP (492)

Error

The supplied CheckEmp isn’t the same as the employee that the job is currently allocated to. OR in call to BookSplitDependencyGroupRequest, the supplied EmpID is not the same as the one assigned to the existing other parts in the same DependencyGroup.

SP_CLEARED_JOB (493)

Error

The supplied JobID is for a job whose dispatch status is already SPDS_LoggedOff or SPDS_Cleared.

(494) - (499)


Reserved.

Return Codes 500 - 599

Return Code Name (Number)

Type

Description

SP_SITEID_INVALID (500)

Error

The supplied SiteID is longer than SiteID Size.

SP_GROUPID_INVALID (501)

Error

The supplied GroupID is longer than GroupID Size.

SP_SITE_OR_GROUP_ID_INVALID (502)

Error

In a call to ApptOfferMultRequest,either a SiteID or a GroupID has been supplied.

SP_EMPID_NOT_ALLOWED (503)

Error

An EmpID has been supplied in a call to DispInitRequest, but DispatchMode isn’t set to Batch.

SP_TIMESTAMP_INVALID (504)

Error

In a call of GetChangedWorkItemsRequest,  the supplied TimeStampIn is in the future.

(505)


Reserved.

SP_BDGJOBSEQ_SIZE_INVALID (506)

Error

In a supplied SP_BDGJobSeq, Size is not >0.

(507)


Reserved.

SP_BDGJOBSEQ_JOBS_NULL (508)

Error

In a supplied SP_BDGJobSeq, Jobs is NULL.

SP_JOBDEPSEQ_SIZE_INVALID (509)

Error

In a supplied SP_JobDepSeq, Size is not >0.

(510)


Reserved.

SP_JOBDEPSEQ_JOBDEPS_NULL (511)

Error

In a supplied SP_JobDepSeq, JobDeps is NULL.

SP_DEPJOBID_INVALID (512)

Error

In the supplied JobDeps, one of the DepJobIDs is empty or is longer than JobID Size.

SP_DEPJOBSTIME_INVALID (513)

Error

In the supplied JobDeps, one of the DepJobsTimes is not one of the defined values for the DepTimeType type.

SP_TARGJOBID_INVALID (514)

Error

In the supplied JobDeps, one of the TargJobIDs is empty or is longer than JobID Size.

SP_TARGJOBSTIME_INVALID (515)

Error

In the supplied JobDeps, one of the TargJobsTimes is not one of the defined values for the DepTimeType type.

SP_EARLIESTTIMEUNITS_INVALID (516)

Error

In the supplied JobDeps, one of the EarliestTimeUnits is not one of the defined values for the DepUnits type.

SP_LATESTTIMEUNITS_INVALID (517)

Error

In the supplied JobDeps, one of the LatestTimeUnits is not one of the defined values for the DepUnits type.

SP_TARGETTIMEUNITS_INVALID (518)

Error

In the supplied JobDeps, one of the TargetTimeUnits is not one of the defined values for the DepUnits type.

SP_COSTID_INVALID (519)

Error

In the supplied JobDeps, one of the CostIDs is empty or is longer than CostID Size.

SP_COSTID_DOES_NOT_EXIST (520)

Error

In the supplied JobDeps, one of the CostIDs is not in the ServiceOptimizer database.

SP_DEPEMPTYPE_INVALID (521)

Error

In the supplied JobDeps, one of the DepEmpTypes is not one of the defined values for the DepEmpType type.

(522) - (525)


Reserved.

SP_TARGET_TIME_BEFORE (526)

Error

In the supplied JobDeps, one of the TargetTimes is earlier than the corresponding EarliestTime.

SP_TARGET_TIME_AFTER (527)

Error

In the supplied JobDeps, one of the TargetTimes is later than the corresponding LatestTime.

SP_CYCLIC_DEPENDENCY_TIME (528)

Error

There is an impossible cyclic dependency in the time dependencies between the jobs in the supplied JobDeps.

SP_DEPENDENCY_CONSTRAINT (529)

Error

The jobs can’t be booked within the supplied dependency constraints.  (This could be a conflict between the Jobs’ ReqEmps and the dependency’s ReqEmpType. or that there are overlaps as a result of the use of the allowOverlaps option when offering for long jobs)

SP_DEPJOBID_DOES_NOT_EXIST (530)

Error

In the supplied JobDeps, one of the DepJobIDs neither matches one of the JobIDs in the supplied Jobs, nor exists in the ServiceOptimizer database.

SP_TARGJOBID_DOES_NOT_EXIST (531)

Error

In the supplied JobDeps, one of the TargJobIDs neither matches one of the JobIDs in the supplied Jobs, nor exists in the ServiceOptimizer database.

SP_CYCLIC_DEPENDENCY_EMP (532)

Error

There is an impossible cyclic dependency in the operative dependencies between the jobs in the supplied JobDeps.

SP_DIFFERENT_FRUS (533)

Error

The jobs in this dependency group are in more than one FRU.  Or: an request has been made to rebook a dependency group  (AllowRebookAll is set) into a different FRU from where it already exists.

(534) - (537)


Reserved.

SP_DATETIME_INVALID (538)

Error

A supplied SP_DateTime is not valid

SP_MULTIJOBID_ALREADY_EXISTS (539)

Error

A dependency group already exists with the supplied MultiJobID.

SP_DEPJOBID_ALREADY_IN_GROUP (540)

Error

In the supplied JobDeps, one of the DepJobIDs is the ID of a job that’s in another existing dependency group.

SP_TARGJOBID_ALREADY_IN_GROUP (541)

Error

In the supplied JobDeps, one of the TargJobIDs is the ID of a job that’s in an existing job dependency group.

SP_BDGRETJOBSSEQ_NULL (542)

Error

In a supplied SP_BDGRetInfo, RetJobs is NULL.

(543) - (544)


Reserved.

SP_NO_POSTINGS (545)

Error

There are no operatives posted to any of the FRUs that are mapped to the location of this job.

(546) - (547)


Reserved.

SP_NO_OVERRIDES (548)

Error

No overrides have been supplied at all.

(549) - (550)


Reserved.

SP_SO_NWD_TOO_SHORT (551)

Error

The shift override would result in an operative day shorter than specified by glob_min_wd_len.

(552)


Reserved.

SP_SO_START_INVALID (553)

Error

The proposed shift start must be between -23 and +23 hours of 00:00 on the supplied Date.

SP_SO_END_INVALID (554)

Error

The proposed shift end must be between +1 and +47 hours of 00:00 on the supplied Date (i.e. between -23 and +23 of 24:00).

SP_SO_START_NO_TIME (555)

Error

A StartDate has been supplied but no StartTime.

SP_SO_END_NO_TIME (556)

Error

An EndDate has been supplied but no EndTime.

SP_SO_BREAK_OUTSIDE (557)

Error

The latest end of the break (BreakLatest + BreakDuration) is after the end of the shift override.

SP_SO_ADJ_IN_SHIFT (558)

Error

There is a ADJ on this shift, though it’s no longer an ADJ shift.

(559)


Reserved.

SP_OK_NO_SHIFT_OVERRIDE (560)

Warning

Success, but SP_OptRestoreShift is set and there was no shift override.

SP_OK_NO_LOC_OVERRIDES (561)

Warning

Success, but SP_OptRestoreLocs is set and there were no location overrides.

SP_NO_RESTORES (562)

Error

Neither SP_OptRestoreShift nor SP_OptRestoreLocs is set.

SP_MULTIJOBID_INVALID (563)

Error

In a supplied SP_MultiJob, MultiJobID is empty or is longer than JobID Size OR has been identified as the id of a part job OR a MultiJobID for a Split Job has been supplied to JobCancelRequest.

SP_BDGJOBSEQ_DUPLICATE_JOBIDS (564)

Error

In the supplied Jobs, the same JobID appears in more than one SP_BDGJob.

SP_DEPJOBID_SAME_AS_TARGJOBID (565)

Error

In one of the supplied JobDeps, the DepJobID is the same as the TargJobID

SP_JOB_NO_DEPENDENCY (566)

Error

A job has been supplied in Jobs but there are no dependencies for it in the supplied JobDeps.

SP_NO_DEPENDENCIES (567)

Error

In a call of BookDependencyGroupRequest, JobDeps hasn’t been supplied.

SP_EMP_TRAVEL_STATUS_INVALID (568)

Error

The value supplied in NewTravelStatus is not one of the declared values for type EmpTravelStatus.

SP_OK_EMP_TRAVEL_STATUS_OFF (569)

Warning

The receipt of travel status (and consequent checking) is switched off for the supplied EmpID.

SP_SHOWOPERATIVESTATUS_INVALID (570)

Error

The value supplied in ShowOperativeStatus is not one of the declared values for type SP_Bool.

SP_SHOWTRAVELSTATUS_INVALID (571)

Error

The value supplied in ShowTravelStatus is not one of the declared values for type SP_Bool.

SP_LATEST_BEFORE_EARLIEST (572)

Error

In the supplied JobDeps, one of the LatestTimes is earlier than the corresponding EarliestTime.

SP_DEPENDENCY_ON_UNRESOURCED_JOB (573)

Error

A dependency has been supplied on an existing job that’s unresourced.

SP_BDGJOBSEQ_NOT_SAME_ITAA (574)

Error

The ForceOptions value of InTrayAfterAll has not been supplied for all or none of the jobs in the supplied Jobs.

SP_ISPRIMARYJOB_INVALID (575)

Error

The value supplied for IsPrimaryJob isn’t SP_False or SP_True.

SP_COSTID_NO_TARGET_TIME (576)

Error

In a supplied JobDeps, a CostID has been supplied but no TargetTime.

SP_ADJ_WOULD_SPAN_DAYS (577)

Error

In a call of 14.1 Change Work Item Status SOAP API for an all-day job, the supplied DateTime would cause the job to span more than one operative day.

SP_SPAREID_DUPLICATED (578)

Error

In a call to 14.1 Change Work Item Status SOAP API one of the SpareIDs has been supplied more than once per operative.

In a call to 14.1 Update Spares Stock SOAP API one of the SpareIDs has been supplied more than once per operative (Combination of SpareID & Operative is used as unique ID).

(579) - (580)


Reserved.

SP_CAPACITYCATEGORY_NOT_DEFINED (581)

Error

Capacity checking is enabled and no CapacityCategory was supplied and the job's job type has no capacity category defined.

SP_FDLT_INVALID (582)

Error

In a call to EmpCreateRequest or EmpUpdateRequest, the supplied FreezeTheDayLeadTime isn’t >= 0 or isn’t <= 999.

(583) - (584)


Reserved.

SP_FROZEN_DAY (585)

Error

One of EmpAddActRequest, ActUpdateRequest or SP_ActSet() has been called for a frozen day and CheckFrozen is set.

SP_FDLT_NOT_SUPPLIED (586)

Error

In a call of EmpCreateRequest, FreezeTheDayTimeOfDay has been supplied but not FreezeTheDayLeadTime.  Or in a call of EmpUpdateRequest, FreezeTheDayTimeOfDay is supplied but there’s no value already set for FreezeTheDayLeadTime, nor is it supplied.

SP_FDT_NOT_SUPPLIED (587)

Error

In a call of EmpCreateRequest, FreezeTheDayLeadTime has been supplied but not FreezeTheDayTimeOfDay.  Or in a call of EmpUpdateRequest, FreezeTheDayLeadTime is supplied but there’s no value already set for FreezeTheDayTimeOfDay, nor is it supplied.

SP_OK_DISPATCH_REQUEST_TIMEOUT (588)

Warning

A call of DispRequest has returned because the Dispatch Request Timeout has expired and there are no jobs ready to be dispatched.  (DispRequest should be called again before the Dispatch Re-Request Timeout has elapsed otherwise the connection will be closed.)

SP_NO_WORKPOSTCODE_FOR_DEFAULTSTARTLOC (589)

Error

The DefaultStartLoc is already “Work” or will be (Work supplied) but there won’t be a corresponding Work Postcode

SP_NO_WORKPOSTCODE_FOR_DEFAULTENDLOC (590)

Error

The DefaultEndLoc is already “Work” or will be (Work supplied) but there won’t be a corresponding Work Postcode

SP_NO_WORKPOSTCODE_FOR_DEFAULTLKCLOC (591)

Error

The DefaultLKCLoc is already “Work” or will be (Work supplied) but there won’t be a corresponding Work Postcode

SP_NO_WORKPOSTCODE_FOR_WORKPATT_STARTLOC (592)

Error

In the resulting Work Pattern one of the StartLocs would be “Work” but there won’t be a corresponding Work Postcode

SP_NO_WORKPOSTCODE_FOR_WORKPATT_ENDLOC (593)

Error

In the resulting Work Pattern one of the EndLocs would be “Work” but there won’t be a corresponding Work Postcode

SP_NO_WORKPOSTCODE_FOR_WORKPATT_LKCLOC (594)

Error

In the resulting Work Pattern one of the LKCLocs would be “Work” but there won’t be a corresponding Work Postcode

SP_NO_DEPOT_FOR_DEFAULTSTARTLOC (595)

Error

The DefaultStartLoc is already “Depot” or will be (Depot supplied) but not all of the teams that the operative is posted to will have an associated Depot

SP_NO_DEPOT_FOR_DEFAULTENDLOC (596)

Error

The DefaultEndLoc is already “Depot” or will be (Depot supplied) but not all of the teams that the operative is posted to will have an associated Depot

SP_NO_DEPOT_FOR_DEFAULTLKCLOC (597)

Error

The DefaultLKCLoc is already “Depot” or will be (Depot supplied) but not all of the teams that the operative is posted to will have an associated Depot

SP_NO_DEPOT_FOR_WORKPATT_STARTLOC (598)

Error

In the resulting Work Pattern one of the StartLocs would be “Depot” but not all of the teams that the operative is posted to will have an associated Depot

SP_NO_DEPOT_FOR_WORKPATT_ENDLOC (599)

Error

In the resulting Work Pattern one of the EndLocs would be “Depot” but not all of the teams that the operative is posted to will have an associated Depot

Return Codes 600 - 699

Return Code Name (Number)

Type

Description

SP_NO_DEPOT_FOR_WORKPATT_LKCLOC (600)

Error

In the resulting Work Pattern one of the LKCLocs would be “Depot” but not all of the teams that the operative is posted to will have an associated Depot

SP_JOBDEPSEQ_DUPLICATE_DEPENDENCIES (601)

Error

In the supplied JobDeps, more than one SP_JobDep has been supplied.  (The currently supported use cases require only one.)

SP_CAPACITYCATEGORY_DOES_NOT_EXIST (602)

Error

The supplied CapacityCategory does not exist in the ServiceOptimizer database.

SP_CAPACITYCATEGORY_INVALID (603)

Error

The supplied CapacityCategory is longer than CapacityCategoryIDSize.

(604) - (607)


Reserved.

SP_LATITUDE_INVALID (608)

Error

The supplied Latitude isn’t in the range -90.0 to +90.0

SP_LONGITUDE_INVALID (609)

Error

The supplied Longitude isn’t in the range -180.0 to +180.0

SP_LOCADD1_INVALID (610)

Error

The supplied Address1 is longer than LocAdd Size.

SP_LOCADD2_INVALID (611)

Error

The supplied Address2 is longer than LocAdd Size.

SP_LOCADD3_INVALID (612)

Error

The supplied Address3 is longer than LocAdd Size.

SP_LOCADD4_INVALID (613)

Error

The supplied Address4 is longer than LocAdd Size.

SP_LOCPOSTCODE_INVALID (614)

Error

The supplied PostCode is longer than Postcode Size.

SP_COUNTRY_INVALID (615)

Error

The supplied CountryCode is longer than CountryCodeSize.

SP_GEOFENCELOCTYPE_INVALID (616)

Error

The supplied GeoFence.LocType is longer than GeoFenceLocType Size.

SP_GEOFENCELOCTYPE_NOT_SUPPLIED (617)

Error

The supplied GeoFence.LocType is empty.  (GeoFence is optional, but if supplied, must contain a LocType.)

SP_GEOFENCELOCNAME_INVALID (618)

Error

The supplied GeoFence.LocName is longer than GeoFenceLocName Size.

SP_GEOFENCE_DOES_NOT_EXIST (619)

Error

The supplied GeoFence.LocType does not exist in the ServiceOptimizer database.

SP_DATETIME_NOT_SUPPLIED (620)

Error

In a call to EmpChangeTravelStatus2Request, the supplied (mandatory) TimeStamp is empty, or

In a call to UpdateSpecialPeriodRequest neither startTime or endTime is specified.

SP_DIFFERENT_DRUS (621)

Error

In a call to BookDependencyGroupRequest, not all of the DRUs supplied for each job are the same.

SP_MULTIJOBID_DOES_NOT_EXIST (622)

Error

In a call toCancelDependencyGroupRequest, the supplied MultiJobID does not exist in the ServiceOptimizer memory horizon.

SP_JOBID_DOES_NOT_EXIST (623)

Error

In a call to CancelDependencyGroupRequest, IsJobID is set but the supplied JobID does not exist in the ServiceOptimizer memory horizon.

SP_JOBID_NOT_IN_DG (624)

Error

In a call to CancelDependencyGroupRequest, IsJobID is set but the supplied JobID is not a job in an existing dependency group.

SP_DRU_NO_FRUS (625)

Error

A DRU has been supplied but it contains no FRUs.

SP_JOBID_OUTSIDE_HORIZON (626)

Error

An attempt has been made to re-book a dependency group (AllowRebookAll is set) but one or more of the existing JobIDs in this Dependency Group  is outside the memory horizon.

SP_NOT_AVAILABLE (627)

Error

In a call to ApptOfferMultRequest, capacity checking isn’t switched off for all of the FRUs where offers would be made, or a CapacityCategory has been supplied, or there is a capacity category associated with at least one of the supplied job types.

(628) - (635)


Reserved.

SP_FRUID_DOES_NOT_EXIST(636)


The supplied FRUID does not exist in the database.

(637)


Reserved.

SP_DATE_NOT_SUPPLIED (638)

 Error

Returned by the 14.1 Get Job Statistics SOAP API and Jeopardy Report SOAP API when the StartDate and EndDate fields are not supplied.

(639)


Reserved.

SP_OK_CAPACITY_EXCEEDED (640)

Warning

The call has succeeded, but capacity has been exceeded in some way (it may have been exceeded before the call).

(641) - (643)


Reserved.

SP_NUMREQ_NO_DEFAULT (644)

Error

In a call to ApptOfferRequest, NumReq is not supplied but no default is defined in the ServiceOptimizer database (database parameter num_req_default).

SP_PROMSET_MULTIPLE_BAND_TYPES (645)

Error

In a call to ApptOfferRequest, NumReqType is not supplied but the time band type cannot be inferred from the specified PromSet because the promise set contains time bands of more than one type.

SP_OK_VAN_SPARES_NOT_UPDATED (646)

Warning

The EmpUpdateRequest call has succeeded, but the operative’s van spares allocation may not have been updated.

SP_TEAM_CHANGE_REQUIRES_RESTART (647)

Error

In a call to EmpCreateRequest or EmpUpdateRequest, a team is referenced that has been updated via ServiceManager but which has not yet been reloaded in ServiceOptimizer.  For example, the team may be new or may have been assigned to a different IRU.  The ServiceOptimizer instance must be restarted before the team can be used in this way.

SP_POSTING_WOULD_ORPHAN (648)

Error

In a call to EmpUpdateRequest a posting change would result in one or more completed jobs allocated to this operative being outside the posting to this FRU.

SP_SHIFTASS_WOULD_ORPHAN (649)

Error

In a call to EmpUpdateRequest one or more completed jobs have been found which would lie inside a period where the operative would no longer have a shift assignment.

SP_BREAKTYPE_INVALID (650)

Error

The shift has a break type that is not allowed with this request.

SP_BREAKTYPE_NOT_OVERRIDDEN (651)

Error

In a call to EmpOverrideRequest all Breaks should be of type Overridden.

SP_BREAKSEQ_SIZE_INVALID (652)

Error

In a supplied SP_BreakSeq, Size will result in the total number of breaks being > 5.

SP_BREAKSEQ_DUPLICATE_BREAKNAMES (653)

Error

In the supplied SP_BreakSeq, the same BreakName appears in more than one SP_EmpBreakPeriod

SP_BREAKSEQ_OVERLAPS (654)

Error

In the supplied SP_BreakSeq, at least one of the SP_EmpBreakPeriods specified overlaps with another, or with a pre-defined shift SP_EmpBreakPeriod.

This error can also be returned when breaks are passed to the API out of chronological order eg. first break 12:00-14:00, second break 08:00-09:00. In effect, the end of one of the breaks is later than the start of the next break in the sequence.

SP_BREAKNAME_INVALID (655)

Error

The supplied BreakName is too long or is empty or is not a valid BreakName for the operative day in question (FixBreakTimesRequest)

SP_BREAKTYPE_NOT_FIXED (656)

Error

In a call to FixBreakTimesRequest the break is not of type Fixed.

SP_BREAKTIME_EARLIEST_INVALID (657)

Error

The supplied BreakEarliest is not a valid spDateTime.

SP_BREAK_WINDOW_MAX_EXCEEDED (658)

Error

BreakLatest – BreakEarliest > glob_max_break_window_len

SP_EXTERNAL_NAME_INVALID (659)

Error

RequiredObjects supplied to GetChangedEmpRequest or Name supplied to EmpCreateRequest or EmpUpdateRequest is not known or invalid/too long

SP_EXTERNAL_SPESDTTYPE_INVALID (660)

Error

SPESDTType supplied to EmpCreateRequest or EmpUpdateRequest is either outside the allowed range or cannot be found.

SP_DUPLICATE_EXTERNAL_NAME (661)

Error

Name supplied to EmpCreateRequest or EmpUpdateRequest duplicates another previously given ()

SP_VEHICLE_CAPACITY_EXCEEDED (662)

Error

The DeliverySize or PickupSize provided is greater than the maximum Vehicle Capacity (available for any single vehicle within the FRU.) available for any single vehicle within the FRU.

SP_EXTERNAL_VALUE_INVALID (663)

Error

ExternalData supplied to EmpCreateRequest or EmpUpdateRequest is too long

SP_SHIFTASS_CONFLICTS_BREAK_OVERRIDE (664)

Error

Period of new shift assignment in EmpUpdateRequest call conflicts with existing overrides for the employee in question.

SP_SA_CONFLICTING_END (665)

Error

In a call to EmpAddActRequest both duration and expectedEnd have been defined.

(666)


Reserved.

SP_SATM_INVALID (667)

Error

The supplied SP_SA_TravelMode is not one of the defined values.

SP_SA_DISPATCH_CANNOT_CHANGE (668)

Error

In a call to ActUpdateRequest the supplied Dispatch mode is different than that currently set.

SP_SA_TRAVELMODE_CANNOT_CHANGE (669)

Error

In a call to ActUpdateRequest the supplied TravelMode is different than that currently set.

SP_SA_DISPATCH_INVALID (670)

Error

When creating a Standard Activity the dispatch mode is not a Boolean value

SP_WORKITEMTYPE_INVALID (671)

Error

The supplied WorkItemType is not one of Job or Activity.

SP_SA_TRAVELMODE_ENDTIME_INVALID (672)

Error

Endtime cannot be used in conjunction with a Standard Activity with TravelMode ETS when creating a Standard Activity.

SP_SA_LOCATIONTYPE_MISSING_POSTCODE (673)

Error

In a call to EmpAddActRequest the Location Type specified for the Standard Activity requires a postcode to also be given.

SP_INVALID_SPLIT_JOB_DETAILS (674)

Error

In a call to BookSplitDependencyGroupRequest only one of SP_ApptBook or JobBookRequest should be supplied.

SP_INVALID_SPLIT_DURATION (675)

Error

In a call to BookSplitDependencyGroupRequest the duration is either not given, or is invalid

SP_INVALID_SPLIT_EARLIEST (676)

Error

In a call to BookSplitDependencyGroupRequest the Earliest time specified is invalid

SP_INVALID_SPLIT_LATEST (677)

Error

In a call to BookSplitDependencyGroupRequest the Latest time specified is invalid

SP_INVALID_JOBTYPE_CATEGORY (678)

Error

In a call to JobTypeCreate the Category supplied does not exist.

SP_INVALID_STATUS_NOTRAVEL_JOB (679)

Error

In a call to ChangeJobStatus “SPDS_Travelling” is invalid for a noTravel job.

SP_ACCEPT_REJECT_NOT_PENDING (680)

Error

A call has been made on a job which requires the job to be in the Pending state and the job is not in that state, or was never booked as Pending.

SP_ACCEPT_REJECT_NOT_ACCEPTED (681)

Error

A call has been made which expects the acceptance state of the job to be Accepted and the job is not in that state

SP_ACCEPT_REJECT_NO_CHANGE (682)

Error

A call to change the acceptance status of a job is attempting to set the job to its current state.

SP_LOCTZ_INVALID_COMBINATION (683)

Error


SP_LISTREQEMPS_NULL (684)

Error

In a supplied SP_ListReqEmps, Size is > 0 but ReqEmp is NULL.

SP_LISTREQEMPS_SIZE_GT_MAX (685)

Error

In a supplied SP_ListReqEmps, Size is not >

SP_LISTREQEMPS_SIZE_INVALID (686)

Error

In a supplied SP_ListReqEmps, Size is invalid

SP_SPECIAL_PERIOD_ID_INVALID (687)

Error

The supplied SpecialPeriodID does not exist in the ServicePower database.

SP_POSTING_CONFLICTS_SPECIAL_PERIOD (688)

Error

In a call to Update Operative SOAP API a supplied posting update would cause a Special Period to span postings.

SP_LISTREQEMPS_COMBINATION_INVALID (689)

Error

The combination of MPX is invalid. Mandatory and MandatoryOrdered operatives cannot be mixed with other types.

SP_UDLOC_INVALID_ACTION (690)

Error

In a call to Create/Update/Delete Postcode/Location SOAP API the requested action is unsupported.

SP_UDLOC_INVALID_NAME (691)

Error

In a call to Create/Update/Delete Postcode/Location SOAP API the supplied name does not exist in the database.

SP_UDLOC_FAILED_REGION_MAPPING (692)

Error

In a call to Create/Update/Delete Postcode/Location SOAP API OR, when offer/booking with an UNKNOWN postcode, the attempt to map the postcode/location to a region has failed. The named postcode/location has not been added/updated.

SP_UDLOC_NAME_ALREADY_EXISTS (693)

Error

In a call to Create/Update/Delete Postcode/Location SOAP API the supplied name already exists and action is not ‘update’.

SP_TOO_MANY_MANDATORYORDERED (694)

Error

Only 1 Mandatory Ordered employee may be specified.

SP_OK_BREAK_STATUS_LOST (695)WarningA call to Fix Break Times SOAP API has been made that is removing either the Started or Finished status.
(696)
Reserved.

SP_RESTRICTION_REF_DOES_NOT_EXIST (697)

Error

SP_USER_DERESTRICTION_EXISTS (698)

ErrorReturned when a supplied ref value in an <add> section of the Update User Job Restriction SOAP API results in attempting to add a restriction type to the specified user that already exists.

SP_USER_DERESTRICTION_DOES_NOT_EXIST (699)

ErrorReturned when a supplied ref value in a <remove> section of the Update User Job Restriction SOAP API results in attempting to remove a restriction type from the specified user that does not exist.

Return Codes 700 - 799

Return Code Name (Number)

Type

Description

(700) - (701)


Reserved.
SP_USERID_EXISTS (702)ErrorReturned when the userId value supplied in a call to the Create User SOAP API already exists in the ServiceOptimizer database.
SP_USERID_DOES_NOT_EXIST (703)Error

Returned when the userId value supplied in a call to the Delete User SOAP API, Update User SOAP API or Update User Job Restriction SOAP API does not exist in the ServiceOptimizer database.

Returned when a filterUser value in the filterUserList structure in a call to the 14.1 Job History SOAP API does not exist in the ServiceOptimizer database.

SP_PROFILE_DOES_NOT_EXIST (704)

ErrorReturned when the profile value supplied in a call to the Create User SOAP API or Update User SOAP API is not a valid profile in the ServiceOptimizer database.

SP_UNIT_REF_INVALID (705)

Error

Returned when the respUnit value supplied in a call to the Create User SOAP API or Update User SOAP API either:

  • is not a valid responsibility unit in the ServiceOptimizer database; or
  • the type of the responsibility unit does not match the type of responsibility unit defined by the unitType parameter.
SP_ROLE_ID_DOES_NOT_EXIST (706)ErrorReturned when the id value supplied in a call to the Update User SOAP API is not a valid role in the ServiceOptimizer database.
SP_PARAMETER_VALUE_DOES_NOT_EXIST (707)ErrorReturned when the value supplied in a call to the Update User SOAP API is not a valid FRU, Operative or Team in the ServiceOptimizer database.
SP_PARAMETER_TYPE_INVALID (708)ErrorReturned when the <formalParameter> section of a call to the Update User SOAP API does not match a defined formal parameter for the supplied role.
SP_ROLE_EXISTS (709)ErrorReturned when a call to the Update User SOAP API is an attempt to ADD a role to a user that is already assigned to the given user.
SP_LANGUAGE_CODE_DOES_NOT_EXIST (710)ErrorReturned when the languageCode parameter in a call to the 14.1 Get Job Type SOAP API is an invalid language code.
SP_NO_TRANSLATION_AVAILABLE (711)ErrorReturned when a call to the 14.1 Get Job Type SOAP API results in one or more job types being returned for which no translation has been set for the requested languageCode.
(712) - (799)
Reserved.

Return Codes 800 - 899

Return Code Name (Number)

Type

Description

SP_ROLE_DOES_NOT_EXIST (800)ErrorReturned when a call to the Update User SOAP API is an attempt to UPDATE a role for a user, or DELETE a role from a user, where that role is not currently assigned to the given user.
SP_PARAMETER_TYPE_DUPLICATED (801)ErrorReturned when a call to the Update User SOAP API contains a duplicated <formalParameter> section. A role’s formalParameter is duplicated when the parameterType, parameterName and parameterValue are duplicated - if a different parameterValue is given then it is not a duplicate and is treated as an OR with the other parameterName settings
SP_PARAMETER_TYPE_LEFT_UNDEFINED (802)ErrorReturned when a call to the Update User SOAP API is an attempt to ADD or UPDATE a role for a user, where a parameterName defined for the role has not been given a value.
SP_DUPLICATE_RESOURCE (803)
ErrorReturned by the Update Spares Stock SOAP API when a skill or special resource with this name already exists; a spare cannot use the same ID.
SP_JOB_SPARE_NOT_BOOKED (804)
ErrorReturned by the Change Work Item Status SOAP API when a spare that was not booked for the job is passed in.

SP_FILTER_ACTION_DOES_NOT_EXIST (805)

ErrorReturned by the 14.1 Job History SOAP API when a supplied filterAction value in the filterActionList structure does not match a valid action in the SP501_GANTT_ACTIONS table.

SP_FILTER_ACTION_DUPLICATE (806)

ErrorReturned by the 14.1 Job History SOAP API when the filterActionList structure contains one or more duplicate filterAction values.

SP_NO_OPTIONS_SET (807)

ErrorReturned by the 14.1 Job History SOAP API when no options value is supplied, but at least one of the filterUserList and/or filterActionList structures are supplied.

SP_USER_NOT_VALID (808)

ErrorReturned by the 14.1 Job History SOAP API when a filterUser value in the filterUserList structure references a user that is not enabled.

SP_FILTER_USER_DUPLICATE (809)

ErrorReturned by the 14.1 Job History SOAP API when the filterUserList structure contains one or more duplicate filterUser values.
SP_OK_FILTERLIST_IGNORED (810)WarningReturned by the 14.1 Job History SOAP API when a supplied filterUserList and/or filterActionList structures was supplied, but was ignored by the API.
SP_DUPLICATE_FRUID (811)ErrorReturned by the 14.1 Get Capacity Statistics SOAP API, 14.1 Get Job Statistics SOAP API and Jeopardy Report SOAP API when a duplicate FRUID value is supplied.
SP_DATERANGE_GT_MAX_DAYS_STATS (812)ErrorReturned by the 14.1 Get Capacity Statistics SOAP API and 14.1 Get Job Statistics SOAP API when the date range supplied via the StartDate and EndDate field values exceeds the maximum permitted range for the API, as defined by the max_days_stats value in the sp083_system_parameters database table.

SP_NOT_ALL_FRU_RESPOND (813)

Warning

Returned by the 14.1 Get Capacity Statistics SOAP API, 14.1 Get Job Statistics SOAP API and Jeopardy Report SOAP API when the request was intended to return results for multiple FRUs, but it was not possible to return results for at least one (but not all) of the FRUs.

SP_DUPLICATE_TEAMID (814)ErrorReturned by the Jeopardy Report SOAP API when a duplicate TeamID value is supplied.
SP_DEPENDENCY_ON_APPOINTMENT_JOB (815)ErrorReturned by the 14.1 Book Dependency Group Job SOAP API when a dependency that has been supplied with an appointment cannot be moved.
SP_JOB_OUT_OF_SCOPE (816)ErrorReturned by the 14.1 Set Pause Job SOAP API when trying to set the paused status of a job that is not scheduled for today.
SP_UNRESOURCED_JOB_NOT_PAUSABLE (817)ErrorReturned by the 14.1 Set Pause Job SOAP API when the job is unresourced and the pause status cannot, therefore, be set.
SP_JOB_IS_PAUSED (818)ErrorReturned by the 14.1 Set Pause Job SOAP API when trying to set a job as paused, but the job is already in this state.
SP_JOB_IS_UNPAUSED (819)ErrorReturned by the 14.1 Set Pause Job SOAP API when trying to set a job as unpaused, but the job is already in this state.
SP_ALL_DAY_JOB_NOT_PAUSABLE (820)ErrorReturned by the 14.1 Set Pause Job SOAP API when the job is not a valid job type for setting the pause status.
SP_JOB_NOT_PAUSABLE (821)ErrorReturned by the 14.1 Set Pause Job SOAP API when the job is not in a valid status for setting the pause status.
SP_VWDL_COMBINATION_INVALID (822)Error

Returned by the 14.1 Book Appointment SOAP API when:

  • The vwdlLocationType value is set
  • and either:
    • The forceOptions structure's InTray value is set to true, or
    • The forceOptions structure's InTrayWithSkill value is set to true.

Returned by the 14.1 Book Dependency Group Job SOAP API14.1 Book Non-Appointment Job SOAP API and 14.1 Request Appointments SOAP API when:

  • The vwdlLocationType value is set
  • and either:
    • The forceOptions structure's InTray value is set to true, or
    • The forceOptions structure's InTrayWithSkill value is set to true.
  • if:
    • The reqUnit option has not been provided.

The InTray and InTrayWithSkill force options bypass constraint checking and allocate the work to the in-tray of an FRU mapped to the job's location. When the job designated as Virtual Work Dynamic Location, the location of the job depends on the allocated operative, therefore every FRU would need to be considered, which is not efficient.

Accordingly, these force options cannot be used with VWDL jobs, unless a reqUnit option is supported and supplied to limit the scope of allocation.

SP_VWDL_LOCATION_INVALID (823)ErrorReturned by the 14.1 Book Appointment SOAP API, 14.1 Book Dependency Group Job SOAP API14.1 Book Non-Appointment Job SOAP API and 14.1 Request Appointments SOAP API when the vwdlLocationType value supplied is not supported.
SP_VWDL_TRAVEL_INVALID (824)Error

Returned by the 14.1 Book Appointment SOAP API, 14.1 Book Dependency Group Job SOAP API14.1 Book Non-Appointment Job SOAP API and 14.1 Request Appointments SOAP API when:

  • The vwdlLocationType value is set to Home, and
  • The forceOptions structure's NoTravel value is set to true.  

The Virtual Work Dynamic Location feature does not permit virtual work which is expected to be carried out at the assigned operative's home location to ignore travel time. (However, where the schedule is able to place VWDL jobs at home for the same operative next to each other, the travel time between jobs will naturally be zero anyway, as they will all be taking place at the same operative's home location.)

(825) - (899)
Reserved.