OpsUpdateResourceTimeoff
- Thomas Sherman (Deactivated)
- Bettina Borces
- Stephan Golux
This service is used to both schedule future time off and to report time-off.
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 |
|---|---|---|---|---|
ResourceTimeOffList | list | yes | Each list item is defined in the ResourceTimeOff section described below | |
ApprovedFlag | boolean | no | false | Scheduling: omit this Reporting: Mark entered time as approved |
ResourceTimeOffList
Name | Data Type | Required? | Default Value | Discussion |
|---|---|---|---|---|
ReferenceSystemId | string | yes | The employee's EmployeeId. You can use ExportResources to retrieve resources and their id numbers. Or look in the resource editor. | |
TimeOffDate | date | yes | Scheduling: Date that the resource has off Reporting: The date that the resource took time-off. | |
TimeOffMinutes | int | yes | Scheduling: You can enter a full day of minutes, 1440 to block off the entire day. If the person is scheduled for a half-day off then you will need to know their working schedule. For example, eight hours a day. If they work half a day then enter 4 * 60 = 240 minutes. Reporting: The number of hours the resource took off for today. | |
TimeOffReason | string | yes | This is a string that must exactly match a list defined in Projector. The list is defined on a per installation basis through the Time Off Reason Editor. | |
| Narrative | string | no | Scheduling: omit this Reporting: Creates a description on the time card | |
ScheduledFlag | boolean | no | false | Set to true if you are scheduling this time. False if you are reporting the time. |
Response
The following data is returned:
Name | Data Type | Discussion |
|---|---|---|
ResourceTimeOffErrors | list of ResourceTimeoffError items | see below |
ResourceTimeOffErrors
Name | Data Type | Discussion |
|---|---|---|
Index | int | Index of the timeoff record (position in ResourceTimeoffList) that failed. |
OpsError | OpsWebError | See Responses |