...
This web service retrieves the history of a specified time card (PwsTimeCardRef). The history of a time card or time off card will include information about each event that affected the card (creation, submission, approval, etc).
Request Format
| Panel | ||
|---|---|---|
| ||
|
...
Element | Data Type | Required? | Description | Sample Data |
|---|---|---|---|---|
RequestId | Int32 | No | Click here for more information. | 1 |
SessionTicket | String | Yes | Click here for more information. | Aecd96YCuEmLGBw8W8ML/g== |
TimeCardIdentity | Yes | The unique key fields associated with identifying a time card or time off card. |
Request Usage Example(s)
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:pws="http://projectorpsa.com/PwsProjectorServices/" xmlns:req="http://projectorpsa.com/DataContracts/Requests/" xmlns:tim="http://projectorpsa.com/DataContracts/Shared/TimeAndCost/" xmlns:com="http://projectorpsa.com/DataContracts/Shared/Common/">
<soapenv:Header/>
<soapenv:Body>
<pws:PwsGetTimeCardHistory>
<pws:serviceRequest>
<req:RequestId>1</req:RequestId>
<req:SessionTicket>Aecd96YCuEmLGBw8W8ML/g==</req:SessionTicket>
<tim:TimeCardIdentity>
<com:TimecardType>T</com:TimecardType>
<com:TimecardUid>1152921504646141261</com:TimecardUid>
</tim:TimeCardIdentity>
</pws:serviceRequest>
</pws:PwsGetTimeCardHistory>
</soapenv:Body>
</soapenv:Envelope> |
...
| 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. | 1 |
Status | Click here for more information. | Ok | |
ServerTimestampUtc | DateTime | Click here for more information. | 2018-03-08T16:05:07.2635866Z |
ResourceIdentity | The resource associated withthe with the time card. | ||
TimeCardIdentity | The time card identity. | ||
TimeOffHistory | The time off time card history. | ||
TimecardDeletedFlag | Boolean | If set to 'true', the time card has been deleted. | false |
TimecardHistory | The time card history. |
Response Usage Example(s)
...
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body>
<PwsGetTimeCardHistoryResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
<PwsGetTimeCardHistoryResult xmlns:a="http://projectorpsa.com/DataContracts/Shared/TimeAndCost/" 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-08T16:12:19.1854271Z</ServerTimestampUtc>
<a:ResourceIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
<b:ResourceDisplayName>Jack Spratt</b:ResourceDisplayName>
<b:ResourceId i:nil="true"/>
<b:ResourceReferenceSystemId>E123</b:ResourceReferenceSystemId>
<b:ResourceUid>1152921504607111573</b:ResourceUid>
</a:ResourceIdentity>
<a:TimeCardIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
<b:ReferenceId i:nil="true"/>
<b:TimecardId i:nil="true"/>
<b:TimecardType>R</b:TimecardType>
<b:TimecardUid>1152921504608460883</b:TimecardUid>
</a:TimeCardIdentity>
<a:TimeOffHistory>
<a:PwsTimeOffHistory>
<a:AdjustmentType>SS</a:AdjustmentType>
<a:ApprovalWorkflowStatus>S</a:ApprovalWorkflowStatus>
<a:Date>2018-03-06T00:00:00Z</a:Date>
<a:RejectedReason i:nil="true"/>
<a:TimeOffMinutes>480</a:TimeOffMinutes>
<a:TimeOffReasonIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
<b:TimeOffReasonId i:nil="true"/>
<b:TimeOffReasonName>Vacation</b:TimeOffReasonName>
<b:TimeOffReasonUid>1152921504606858293</b:TimeOffReasonUid>
</a:TimeOffReasonIdentity>
<a:TransactionTimestamp>2018-03-07T20:33:16.677Z</a:TransactionTimestamp>
<a:TransactionUser xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
<b:UserDisplayName>Jack Spratt</b:UserDisplayName>
<b:UserId i:nil="true"/>
<b:UserReferenceSystemId>E123</b:UserReferenceSystemId>
<b:UserUid>1152921504607112369</b:UserUid>
<b:EmailAddress>jack@revcorp.bb</b:EmailAddress>
<b:FirstName>Jack</b:FirstName>
<b:LastName>Spratt</b:LastName>
<b:MiddleName i:nil="true"/>
</a:TransactionUser>
</a:PwsTimeOffHistory>
</a:TimeOffHistory>
<a:TimecardDeletedFlag>false</a:TimecardDeletedFlag>
<a:TimecardHistory/>
</PwsGetTimeCardHistoryResult>
</PwsGetTimeCardHistoryResponse>
</s:Body>
</s:Envelope> |
PwsGetTimeCardHistory - Common Errors and Warnings
- For all errors and warnings please refer to the Complete List of Errors and Warnings
ErrorNumber | ErrorCode | ErrorText |
|---|---|---|
| 19093 | UnexpectedTimeCardType | Unexpected value for TimeCardType. Valid values are T or R. |
| 20035 | TimeCardIdentityRequired | A time card identity must be specified. |
| 64219 | SpecifiedTimeoffCardDoesNotExist | The specified time off card does not exist. |