Overview
Insert or update PTO balances on a per time off reason.
This web service inserts or updates available time off records given a resource and time off reason (PwsResourceAvailableTimeOffDetail(PwsResourceAvailableTimeoffDetail). The service returns the results of the insert or update (PwsSaveResourceAvailableTimeOffResult).
Request Format
| Panel | ||
|---|---|---|
| ||
|
Request Elements
Element | Data Type | Required? | Default | Description | Sample Data |
|---|---|---|---|---|---|
RequestId | Int32 | No | Click here for more information. | 1 | |
SessionTicket | String | Yes | Click here for more information. | AV7pfLYHuvIjk5rCwGgoiQ== | |
AbortOnFailureFlag | Boolean | No | false | If set to 'true', the request will be aborted once the service encounters a record it cannot process. If set to 'false', it will process all the records that can be process processed and , fails fail the ones it cannot. | false |
AvailableTimeOffDetail | PwsResourceAvailableTimeOffDetail PwsResourceAvailableTimeoffDetail[???] | false | The detailed resource available time off information to be inserted or updated |
...
| Panel | ||
|---|---|---|
| ||
|
Response Elements
Element | Data Type | Description | Sample Data |
|---|---|---|---|
Messages | The web service response status and message. Click here for more information. | ||
ResponseId | Int32 | Click here for more information. | |
Status | Click here for more information. | ||
ServerTimestampUtc | DateTime | Click here for more information. | |
Results | If AbortOnFailureFlag is 'true', this will contain details for records that failed, including the identity of the failed record and the reason for failure. |
Response Usage Example(s)
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body>
<PwsSaveResourceAvailableTimeOffResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
<PwsSaveResourceAvailableTimeOffResult xmlns:a="http://projectorpsa.com/DataContracts/Responses/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<Messages xmlns="http://projectorpsa.com/CommonServices/" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
<ResponseId xmlns="http://projectorpsa.com/CommonServices/">1</ResponseId>
<Status xmlns="http://projectorpsa.com/CommonServices/">Ok</Status>
<ServerTimestampUtc xmlns="http://projectorpsa.com/CommonServices/">2018-03-02T21:31:35.5223547Z</ServerTimestampUtc>
<a:Results xmlns:b="http://projectorpsa.com/DataContracts/Shared/DataAdministration/"/>
</PwsSaveResourceAvailableTimeOffResult>
</PwsSaveResourceAvailableTimeOffResponse>
</s:Body>
</s:Envelope> |
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body>
<PwsSaveResourceAvailableTimeOffResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
<PwsSaveResourceAvailableTimeOffResult xmlns:a="http://projectorpsa.com/DataContracts/Responses/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<Messages xmlns="http://projectorpsa.com/CommonServices/" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
<ResponseId xmlns="http://projectorpsa.com/CommonServices/">1</ResponseId>
<Status xmlns="http://projectorpsa.com/CommonServices/">Ok</Status>
<ServerTimestampUtc xmlns="http://projectorpsa.com/CommonServices/">2018-03-05T15:08:20.9777785Z</ServerTimestampUtc>
<a:Results xmlns:b="http://projectorpsa.com/DataContracts/Shared/DataAdministration/">
<b:PwsSaveResourceAvailableTimeOffResult>
<b:AsOfDate>2018-01-01T00:00:00Z</b:AsOfDate>
<b:ErrorDetail xmlns:c="http://projectorpsa.com/DataContracts/Shared/Common/">
<c:ErrorCode>SpecifiedTimeOffReasonDoesNotExist</c:ErrorCode>
<c:ErrorNumber>57567</c:ErrorNumber>
<c:ErrorText>The specified time off reason does not exist.</c:ErrorText>
</b:ErrorDetail>
<b:ResourceIdentity xmlns:c="http://projectorpsa.com/DataContracts/Shared/Common/">
<c:ResourceDisplayName i:nil="true"/>
<c:ResourceId i:nil="true"/>
<c:ResourceReferenceSystemId>E123</c:ResourceReferenceSystemId>
<c:ResourceUid i:nil="true"/>
</b:ResourceIdentity>
<b:TimeOffReasonIdentity xmlns:c="http://projectorpsa.com/DataContracts/Shared/Common/">
<c:TimeOffReasonId i:nil="true"/>
<c:TimeOffReasonName>Summer Vacation</c:TimeOffReasonName>
<c:TimeOffReasonUid i:nil="true"/>
</b:TimeOffReasonIdentity>
</b:PwsSaveResourceAvailableTimeOffResult>
</a:Results>
</PwsSaveResourceAvailableTimeOffResult>
</PwsSaveResourceAvailableTimeOffResponse>
</s:Body>
</s:Envelope> |
PwsSaveResourceAvailableTimeOff - Common Errors and Warnings
- For all errors and warnings please refer to the Complete List of Errors and Warnings
| ErrorNumber | ErrorCode | ErrorText |
|---|---|---|
| 31001 | TimeOffBeginDateRequired | Please specify a begin date. |
| 31002 | TimeOffEndDateRequired | Please specify an end date. |
| 31003 | TimeOffEndDatePriorToBeginDate | The specified end date may not be prior to the the specified begin date. |
| 31004 | TimeOffReasonRequired | Please specify a time off reason. |
| 31005 | InvalidValueForTimeOffBeginDate | The specified begin date must be expressed as midnight UTC on the desired date. |
| 31006 | InvalidValueForTimeOffEndDate | The specified end date must be expressed as midnight UTC on the desired date. |
| 57565 | InvalidTimeOffReason | A specified time off reason identity was incomplete. Each tmie off reason identity must specify either a time off reason id, time off reason uid or time off reason name. |
| 57567 | SpecifiedTimeOffReasonDoesNotExist | The specified time off reason does not exist. |
| 64357 | TimeOffReasonInactiveOverRange | Time off reason is inactive for at least part of the specified range. |