ExportScheduledTimeoff
Rate Limiting
In order to protect our servers from inadvertent service overuse or intentional attack, and to fairly distribute services to all our customers, we have implemented a rate limiting algorithm. When fully deployed, this new algorithm will cause services to either succeed with new warnings or fail with new errors when services are consumed at too high a rate. Programs that consume Projector services should be enhanced to handle rate limiting errors so that they can continue functioning properly. For more information please visit: Projector Rate Limiting Behavior.
Request
The service request contains:
Name | Data Type | Required? | Default Value | Discussion |
---|---|---|---|---|
IncludeRequestsFlag | boolean | no | false | Set to true to include unnapproved vacation requests. |
MaxRowsToReturn | int | no | 1000 | The maximum number of cards to be exported. Values greater than 1000 may fail due to system-enforced transaction time limits. |
DateBookmark | date | no | Export is limited to timeoff whose date comes after this bookmark. To avoid skipping or duplicating exported timeoff set this to the last DateBookmark from the previous result set. or must all be set. | |
DisplayNameBookmark | string(50) | no | Export is limited to timeoff whose display name comes after this bookmark. To avoid skipping or duplicating exported timeoff set this to the last DisplayName from the previous result set. | |
TimeoffReasonBookmark | string(50) | no | Export is limited to timeoff whose timeoff reason comes after this period start date. To avoid skipping or duplicating exported timeoff set this to the last TimeoffReason from the previous result set. | |
OnlyCountRows | boolean | no | false | If true, then only the RowCount is returned. |
Response
For each project in the result set the following data is returned:
Name | Data Type | Discussion |
---|---|---|
Date | date | Date of the timeoff |
DisplayName | string | |
EmployeeId | string | This is the resource's reference system ID. |
TimeoffReasonName | string | |
TimeoffMinutes | int | |
ApprovalStatus | string | "Requested" or "Approved" |