PwsGetTimeCardHistory

Owned by Bettina Borces
Last updated: Apr 13, 2018 by Luke Wright
17 min read

Overview


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


PwsGetTimeCardHistory Request

Request Elements


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

PwsTimeCardRef

Yes

The unique key fields associated with identifying a time card or time off card.


Request Usage Example(s)


Example 01 
<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>


Response Format


PwsGetTimeCardHistory Response

Response Elements


Element

Data Type

Description

Sample Data

Messages

PwsMessage[]

The web service response status and message. Click here for more information.


ResponseId

Int32

Click here for more information.

1

Status

RequestStatus

Click here for more information.

Ok

ServerTimestampUtc

DateTime

Click here for more information.

2018-03-08T16:05:07.2635866Z

ResourceIdentity

PwsResourceRef

The resource associated with the time card.


TimeCardIdentity

PwsTimeCardRef

The time card identity.


TimeOffHistory

PwsTimeOffHistory[]

The time off time card history.


TimecardDeletedFlag

Boolean

If set to 'true', the time card has been deleted.

false

TimecardHistory

PwsTimeCardHistory[]

The time card history.


Response Usage Example(s)


Example 01 - time card 
<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:05:07.2635866Z</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>T</b:TimecardType>
               <b:TimecardUid>1152921504646141261</b:TimecardUid>
            </a:TimeCardIdentity>
            <a:TimeOffHistory/>
            <a:TimecardDeletedFlag>false</a:TimecardDeletedFlag>
            <a:TimecardHistory>
               <a:PwsTimecardHistory>
                  <a:AdjustedRevenueAmount>1600</a:AdjustedRevenueAmount>
                  <a:AdjustmentCodeIdentity i:nil="true" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                  <a:AdjustmentType>SS</a:AdjustmentType>
                  <a:ApprovalWorkflowStatus>S</a:ApprovalWorkflowStatus>
                  <a:BillingAdjustmentAmount>0</a:BillingAdjustmentAmount>
                  <a:ClientIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                     <b:ClientId i:nil="true"/>
                     <b:ClientNumber>PR-PSA</b:ClientNumber>
                     <b:ClientUid>1152921504606961482</b:ClientUid>
                  </a:ClientIdentity>
                  <a:ClientName>Projector PSA</a:ClientName>
                  <a:ContractRevenueAmount>1600</a:ContractRevenueAmount>
                  <a:DayFraction>1</a:DayFraction>
                  <a:Description>Initial research</a:Description>
                  <a:EngagementCurrencyIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                     <b:CurrencyCode>USD</b:CurrencyCode>
                     <b:CurrencyId i:nil="true"/>
                     <b:CurrencyUid>1152921504606851838</b:CurrencyUid>
                  </a:EngagementCurrencyIdentity>
                  <a:EngagementIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                     <b:EngagementCode>E001395</b:EngagementCode>
                     <b:EngagementId i:nil="true"/>
                     <b:EngagementUid>1152921504607324698</b:EngagementUid>
                  </a:EngagementIdentity>
                  <a:EngagementName>Web Services Engagement</a:EngagementName>
                  <a:EngagementTypeBillableFlag>true</a:EngagementTypeBillableFlag>
                  <a:EngagementTypeIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                     <b:EngagementTypeId i:nil="true"/>
                     <b:EngagementTypeName>Billable - Time and Materials</b:EngagementTypeName>
                     <b:EngagementTypeShortName>TandM</b:EngagementTypeShortName>
                     <b:EngagementTypeUid>1152921504606863884</b:EngagementTypeUid>
                  </a:EngagementTypeIdentity>
                  <a:Explanation i:nil="true"/>
                  <a:InvoiceIdentity i:nil="true" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                  <a:LocationIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                     <b:LocationId i:nil="true"/>
                     <b:LocationName>USA</b:LocationName>
                     <b:LocationUid>1152921504606855985</b:LocationUid>
                  </a:LocationIdentity>
                  <a:OldAdjustedRevenueAmount i:nil="true"/>
                  <a:OldBillingAdjustmentAmount i:nil="true"/>
                  <a:OldClientIdentity i:nil="true" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                  <a:OldClientName i:nil="true"/>
                  <a:OldContractRevenueAmount i:nil="true"/>
                  <a:OldDayFraction i:nil="true"/>
                  <a:OldDescription i:nil="true"/>
                  <a:OldEngagementCurrencyIdentity i:nil="true" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                  <a:OldEngagementIdentity i:nil="true" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                  <a:OldEngagementName i:nil="true"/>
                  <a:OldEngagementTypeIdentity i:nil="true" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                  <a:OldLocationIdentity i:nil="true" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                  <a:OldParentProjectTaskIdentity i:nil="true" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                  <a:OldParentProjectTaskName i:nil="true"/>
                  <a:OldParentProjectTaskWbsCode i:nil="true"/>
                  <a:OldProjectIdentity i:nil="true" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                  <a:OldProjectName i:nil="true"/>
                  <a:OldProjectRateTypeIdentity i:nil="true" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                  <a:OldProjectRateTypeName i:nil="true"/>
                  <a:OldProjectRoleIdentity i:nil="true" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                  <a:OldProjectRoleName i:nil="true"/>
                  <a:OldProjectTaskIdentity i:nil="true" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                  <a:OldProjectTaskName i:nil="true"/>
                  <a:OldProjectTaskTypeIdentity i:nil="true" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                  <a:OldProjectTaskTypeName i:nil="true"/>
                  <a:OldProjectTaskWbsCode i:nil="true"/>
                  <a:OldUdf1Value i:nil="true" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                  <a:OldUdf2Value i:nil="true" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                  <a:OldWorkMinutes i:nil="true"/>
                  <a:ParentProjectTaskIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                     <b:ExternalSystemIdentifier i:nil="true"/>
                     <b:ProjectTaskId i:nil="true"/>
                     <b:ProjectTaskUid>1152921504608637335</b:ProjectTaskUid>
                  </a:ParentProjectTaskIdentity>
                  <a:ParentProjectTaskName>Task A</a:ParentProjectTaskName>
                  <a:ParentProjectTaskWbsCode>1</a:ParentProjectTaskWbsCode>
                  <a:ProjectIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                     <b:ProjectCode>P001395-001</b:ProjectCode>
                     <b:ProjectId i:nil="true"/>
                     <b:ProjectUid>1152921504607412209</b:ProjectUid>
                  </a:ProjectIdentity>
                  <a:ProjectName>New Web Services Project (A)</a:ProjectName>
                  <a:ProjectRateTypeIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                     <b:ExternalSystemIdentifier i:nil="true"/>
                     <b:ProjectRateTypeId i:nil="true"/>
                     <b:ProjectRateTypeUid>1152921504607370460</b:ProjectRateTypeUid>
                  </a:ProjectRateTypeIdentity>
                  <a:ProjectRateTypeName>Regular</a:ProjectRateTypeName>
                  <a:ProjectRoleIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                     <b:ExternalSystemIdentifier i:nil="true"/>
                     <b:ProjectRoleId i:nil="true"/>
                     <b:ProjectRoleUid>1152921504609522500</b:ProjectRoleUid>
                  </a:ProjectRoleIdentity>
                  <a:ProjectRoleName>JS</a:ProjectRoleName>
                  <a:ProjectTaskIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                     <b:ExternalSystemIdentifier i:nil="true"/>
                     <b:ProjectTaskId i:nil="true"/>
                     <b:ProjectTaskUid>1152921504608644258</b:ProjectTaskUid>
                  </a:ProjectTaskIdentity>
                  <a:ProjectTaskName>Task A1</a:ProjectTaskName>
                  <a:ProjectTaskTypeIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                     <b:ExternalSystemIdentifier i:nil="true"/>
                     <b:ProjectTaskTypeId i:nil="true"/>
                     <b:ProjectTaskTypeUid>1152921504608115974</b:ProjectTaskTypeUid>
                  </a:ProjectTaskTypeIdentity>
                  <a:ProjectTaskTypeName>Task Type 01</a:ProjectTaskTypeName>
                  <a:ProjectTaskWbsCode>1.1</a:ProjectTaskWbsCode>
                  <a:RejectedReason i:nil="true"/>
                  <a:RelatedTimecardIdentity i:nil="true" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                  <a:SplitRatio i:nil="true"/>
                  <a:TransactionTimestamp>2018-03-06T19:21:15.64Z</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:Udf1Value xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                     <b:BooleanValue i:nil="true"/>
                     <b:DateValue i:nil="true"/>
                     <b:IntegerValue i:nil="true"/>
                     <b:TextValue i:nil="true"/>
                     <b:RelationValue>
                        <b:CodeValue>SD-23</b:CodeValue>
                        <b:TextValue>2 laptops for demo</b:TextValue>
                        <b:UidValue>10022</b:UidValue>
                     </b:RelationValue>
                     <b:NumericValue i:nil="true"/>
                  </a:Udf1Value>
                  <a:Udf2Value xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                     <b:BooleanValue i:nil="true"/>
                     <b:DateValue i:nil="true"/>
                     <b:IntegerValue i:nil="true"/>
                     <b:TextValue i:nil="true"/>
                     <b:RelationValue i:nil="true"/>
                     <b:NumericValue i:nil="true"/>
                  </a:Udf2Value>
                  <a:WorkDate>2018-03-05T00:00:00Z</a:WorkDate>
                  <a:WorkMinutes>480</a:WorkMinutes>
                  <a:WriteUpRatio i:nil="true"/>
               </a:PwsTimecardHistory>
            </a:TimecardHistory>
         </PwsGetTimeCardHistoryResult>
      </PwsGetTimeCardHistoryResponse>
   </s:Body>
</s:Envelope>
Example 02 - Time Off Time Card 
<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

ErrorNumber

ErrorCode

ErrorText

19093UnexpectedTimeCardTypeUnexpected value for TimeCardType. Valid values are T or R.
20035TimeCardIdentityRequiredA time card identity must be specified.
64219SpecifiedTimeoffCardDoesNotExistThe specified time off card does not exist.