You are viewing an old version of this content. View the current version.
Compare with Current
View Version History
« Previous
Version 55
Next »
On This Page:
Related Pages:
The sp:GetEmpsRequest
API method can be used to get the employees for a responsibility unit.
Description
The sp:GetEmpsRequest
API method returns a set of employees who are posted to the specified responsibility unit on the specified date.
Definition
The definition of this API is:
Click here to expand...
Web Service | Type | Description | Req? | Val? |
<sp:GetEmpsRequest>
|
| | | |
| <RespUnit>?</RespUnit>
| RUID
| is the identifier of the Responsibility Unit in which the employees work | 
| 
|
| <Date>?</Date>
| spDate
| only employees who are posted to this RespUnit on this Date will be returned | 
| |
| <PrevEmp>?</PrevEmp>
| EmpID
| the start point for each batch; omit for 1st batch or if all are wanted | 
| 
|
| <EmpCount>?</EmpCount>
| int
| is the number of EmpIDs which should be returned in each batch | 
| |
</sp:GetEmpsRequest>
|
| | | |
The value of the Date field is local to the employee’s home region’s timezone, or, if a timezone is not set for the employee, local to the default timezone
Return Structure
The API returns a non-standard return structure.
Web Service | Type | Description | Req? | Val? |
<sp:GetEmpsResponse>
|
| | | |
| <PrevEmp>?</PrevEmp>
| EmpID
| The last Emp to be returned from the previous batch | | |
| <EmpCount>?</EmpCount>
| int
| The number of Employees returned | | |
| <Emps>?</Emps>
| EmpID
| The set of EmpIDs | | |
</sp:GetEmpsResponse>
|
| | | |
Return Codes
In addition to the Standard Return Codes, the possible Return Codes from this API are:
Click here to expand...
SP_OK (0)
SP_EMPID_INVALID (5)
SP_DATE_INVALID (14)
SP_UNIT_INVALID (28)
SP_OUTSIDE_HORIZON (53)
SP_EMPID_DOES_NOT_EXIST (231)