Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 5 Next »

Overview


This structure represents the results of a time off card insert or update. Multiple time off cards can be submitted for insert or update in a single request to PwsSaveTimeCards. This operation can partially succeed, meaning some cards were successfully saved while others triggered errors and could not be saved. The web service will report back details about each failure by returning a collection of these structures.

Format


PwsSaveTimeOffCardResult

Elements


Element

Data Type

Description

Sample Data

ErrorDetail

PwsErrorDetail

The error detail regarding the failed time card off insert or update.


ReferenceId

String

Reference id (used to affiliate PwsSaveTimeOffCardResult records with associated PwsTimeCardDetail records). This is especially useful when inserting new cards.


TimeOffCard

PwsTimeOffCardDetail

This structure contains the complete set of information about the time off card.


Usage Example(s)


Example 01 - successful response 
            <a:TimeOffCardResults>
               <a:PwsSaveTimeOffCardResult>
                  <a:ErrorDetail i:nil="true" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                  <a:ReferenceId i:nil="true"/>
                  <a:TimeOffCard>
                     <ReferenceId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                     <TimecardId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                     <TimecardType xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">R</TimecardType>
                     <TimecardUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504608460887</TimecardUid>
                     <a:Description>Vacation Day</a:Description>
                     <a:DescriptionClearFlag>false</a:DescriptionClearFlag>
                     <a:RejectedByUser i:nil="true" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                     <a:RejectedReason i:nil="true"/>
                     <a:RejectedTimestamp i:nil="true"/>
                     <a:Status>Submitted</a:Status>
                     <a:WorkDate>2018-03-21T00:00:00Z</a:WorkDate>
                     <a:WorkMinutes>480</a:WorkMinutes>
                     <a:Timestamp>AAAAAA64QjU=</a:Timestamp>
                     <a:CardStatus>S</a:CardStatus>
                     <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:TimeOffCard>
               </a:PwsSaveTimeOffCardResult>
            </a:TimeOffCardResults>
Example 02 - unsuccessful response 
            <a:TimeOffCardResults>
               <a:PwsSaveTimeOffCardResult>
                  <a:ErrorDetail xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                     <b:ErrorCode>SpecifiedTimeOffReasonDoesNotExist</b:ErrorCode>
                     <b:ErrorNumber>57567</b:ErrorNumber>
                     <b:ErrorText>The specified time off reason does not exist.</b:ErrorText>
                  </a:ErrorDetail>
                  <a:ReferenceId i:nil="true"/>
                  <a:TimeOffCard i:nil="true"/>
               </a:PwsSaveTimeOffCardResult>
            </a:TimeOffCardResults>
  • No labels