/
_API GetChangedEmpRequest Definition
Document toolboxDocument toolbox

_API GetChangedEmpRequest Definition

Owned by Andrew Hill (Deactivated)
Nov 19, 2018
 Click here to expand...

Web Service

Type

Description

Req?

Val?

<sp:GetChangedEmpRequest>

 

 

 

 

 

<lastExtractTime>?</lastExtractTime>

 

date/time to start the search for updates. If this is null, then ALL of the operatives in the database will be extracted.

 

 

 

<teams>?</teams>

 

select only operatives who have a posting to the specified Team(s) within the extract period (See note 1)

 

(tick)

 

<FRUs>?</FRUs>

 

select only operatives who have a posting to the specified FRU(s) within the extract period (See Note 1)

 

(tick)

 

<lastExtractedEmpID>?</lastExtractedEmpID>

EmpID

start the extract from the operative after this (for use after error)

 

(tick)

 

<requiredObjects>?</requiredObjects>

 

list of external data objects required in the return

(tick)

(tick)

 

<options>

 

currently unused but allows for future extensions to behaviour

 

 

 

 

<unused>?</unused>

 

 

 

 

 

</options>

 

 

 

 

</sp:GetChangedEmpRequest>

 

 

 

 

Notes:

  1. if both FRU and Team are null select all

The ‘added’ case will return all requested external objects that the operative has defined if the operative has been created since the lastExtractTime, or if an operative who previously had his/her final posting ended has been given () a new posting that means that operative is once again a ‘current’ posting.

‘Update’ records will only be sent if changes have been applied, to either the external data attributes themselves or to the ServiceOptimizer attributes they reference, since the lastExtractTime. For any requested object a change to any of the attributes will mean that all attributes will be returned, however each will have a ‘modified’ Boolean so that the caller knows which have been changed within the extract timeframe.

When an external data object is requested, if an operative has some of the external data attributes for that object defined, but not all of them, then only the attributes where the operative has a defined value will be returned.  If an operative has no attributes for a particular object defined then the object is not returned for that operative (but there may be other objects returned if the request specified multiple objects)

For deletion records, these will be sent when an operative’s final posting has an end date added, and that end date now falls inside the time period defined by lastExtractTime.