Overview

This web service saves changes to time cards. This service should be used to save changes to existing time cards or insert new time cards or to delete time cards.

The service is written such that a failure to save or update a time card or time off card, will not prevent the saving of other changes, however any failure to save will prevent the submit from occurring, even if the service requests it. Individual errors processing time cards or time off cards are reported in the response.

Request Format

PwsSaveTimeCardsAndRto Request

PwsSaveTimeCardsAndRto
- serviceRequest: PwsSaveTimeCardsAndRtoRq
  - RequestId: Int32
  - SessionTicket: String
  - AdministratorComments: String
  - CalculateApproverFlag: Boolean *** deprecated ***
  - CalculateRevalueValuesFlag: Boolean *** deprecated ***
  - InsertIfNotFoundOnUpdateFlag: Boolean
  - PreserveTimeCardStatusFlag: Boolean *** deprecated ***
  - SaveTimeCards: PwsResourceTimeCard [???]
  - SaveTimeOffCards: PwsResourceTimeOffCard [???]
  - SendNotificationEmailFlag: Boolean
  - AbortOnFailureFlag: Boolean

Request Elements

Element	Data Type	Required?	Default	Description	Sample Data
RequestId	Int32			Click here for more information.	1
SessionTicket	String			Click here for more information.	AdASLLZalvehjm71D72agw==
AdministratorComments	String			Administrator comments for entering time on behalf of others	Save Time Cards or Reported Time Off
CalculateApproverFlag	Boolean	* deprecated *		* deprecated *
CalculateRevalueValuesFlag	Boolean	* deprecated *		* deprecated *
InsertIfNotFoundOnUpdateFlag	Boolean		false	If set to 'true', the specified time card or time off time card details will be inserted as a new time card or time off time card if it does not currently exist	false
PreserveTimeCardStatusFlag	Boolean	* deprecated *		* deprecated *
SaveTimeCards	PwsResourceTimecard [???]			The details of the time card to be saved / updated
SaveTimeOffCards	PwsResourceTimeOffCard [???]			The details of the time off time card to be saved / updated
SendNotificationEmailFlag	Boolean			If set to 'true', a notification email will be sent to the resource associated with the time card. This is applicable only when entering time on behalf of others.	false
AbortOnFailureFlag	Boolean			If set to 'true' a failure to save or update a time card or time off card, will prevent the saving of other changes	true

Request Usage Example(s)

Example 01 - time card

<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:PwsSaveTimeCardsAndRto>
         <pws:serviceRequest>
            <req:RequestId>1</req:RequestId>
            <req:SessionTicket>AdASLLZalvehjm71D72agw==</req:SessionTicket>
            <tim:AdministratorComments>Save Time Cards or Reported Time Off</tim:AdministratorComments>
            <tim:InsertIfNotFoundOnUpdateFlag>false</tim:InsertIfNotFoundOnUpdateFlag>
            <tim:SaveTimeCards>
               <tim:PwsResourceTimecard>
                  <tim:Description>Time Card Insert</tim:Description>
                  <tim:DescriptionClearFlag>false</tim:DescriptionClearFlag>
                  <tim:Status>Submitted</tim:Status>
                  <tim:WorkDate>2018-03-14T00:00:00.000Z</tim:WorkDate>
                  <tim:WorkMinutes>120</tim:WorkMinutes>
                  <tim:CardStatus>S</tim:CardStatus>
                  <tim:LocationClearFlag>false</tim:LocationClearFlag>
                  <tim:LocationIdentity>
                     <com:LocationName>USA</com:LocationName>
                  </tim:LocationIdentity>
                  <tim:ProjectIdentity>
                     <com:ProjectCode>P001396-001</com:ProjectCode>
                  </tim:ProjectIdentity>
                  <tim:ProjectRateTypeIdentity>
                     <com:ProjectRateTypeUid>1152921504607370468</com:ProjectRateTypeUid>
                  </tim:ProjectRateTypeIdentity>
                  <tim:ProjectTaskIdentity>
                     <com:ProjectTaskUid>1152921504608637344</com:ProjectTaskUid>
                  </tim:ProjectTaskIdentity>
                  <tim:RoleClearFlag>false</tim:RoleClearFlag>
                  <tim:RoleIdentity>
                     <com:ProjectRoleUid>1152921504609525049</com:ProjectRoleUid>
                  </tim:RoleIdentity>
                  <tim:Udf1>
                     <com:UdfName>TC-Jira</com:UdfName>
                     <com:RelationValue>
                        <com:CodeValue>SD-23</com:CodeValue>
                     </com:RelationValue>
                  </tim:Udf1>
                  <tim:Udf1ClearFlag>false</tim:Udf1ClearFlag>
                  <tim:Udf2ClearFlag>false</tim:Udf2ClearFlag>
                  <tim:ExternalGroupingIdentifier>1</tim:ExternalGroupingIdentifier>
                  <tim:ExternalGroupingIdentifierClearFlag>false</tim:ExternalGroupingIdentifierClearFlag>
                  <tim:ResourceIdentity>
                     <com:ResourceReferenceSystemId>E123</com:ResourceReferenceSystemId>
                  </tim:ResourceIdentity>
               </tim:PwsResourceTimecard>
            </tim:SaveTimeCards>
            <tim:SendNotificationEmailFlag>false</tim:SendNotificationEmailFlag>
            <tim:AbortOnFailureFlag>true</tim:AbortOnFailureFlag>
         </pws:serviceRequest>
      </pws:PwsSaveTimeCardsAndRto>
   </soapenv:Body>
</soapenv:Envelope>

Example 02 - time off card

<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:PwsSaveTimeCardsAndRto>
         <pws:serviceRequest>
            <req:RequestId>1</req:RequestId>
            <req:SessionTicket>AdASLLZalvehjm71D72agw==</req:SessionTicket>
            <tim:AdministratorComments>Save Time Cards or Reported Time Off</tim:AdministratorComments>
            <tim:InsertIfNotFoundOnUpdateFlag>false</tim:InsertIfNotFoundOnUpdateFlag>
            <tim:SaveTimeOffCards>
               <tim:PwsResourceTimeOffCard>
                  <com:TimecardType>T</com:TimecardType>
                  <tim:Description>Spring Vacation</tim:Description>
                  <tim:DescriptionClearFlag>false</tim:DescriptionClearFlag>
                  <tim:Status>Submitted</tim:Status>
                  <tim:WorkDate>2018-03-15T00:00:00.000Z</tim:WorkDate>
                  <tim:WorkMinutes>480</tim:WorkMinutes>
                  <tim:CardStatus>S</tim:CardStatus>
                  <tim:TimeOffReasonIdentity>
                     <com:TimeOffReasonName>Vacation</com:TimeOffReasonName>
                  </tim:TimeOffReasonIdentity>
                  <tim:ResourceIdentity>
                     <com:ResourceReferenceSystemId>E123</com:ResourceReferenceSystemId>
                  </tim:ResourceIdentity>
               </tim:PwsResourceTimeOffCard>
            </tim:SaveTimeOffCards>
            <tim:SendNotificationEmailFlag>false</tim:SendNotificationEmailFlag>
            <tim:AbortOnFailureFlag>true</tim:AbortOnFailureFlag>
         </pws:serviceRequest>
      </pws:PwsSaveTimeCardsAndRto>
   </soapenv:Body>
</soapenv:Envelope>

Response Format

PwsSaveTimeCardsAndRto Response

PwsSaveTimeCardsAndRtoResponse
- PwsSaveTimeCardsAndRtoResult: PwsSaveTimeCardsAndRtoRs
  - Messages: PwsMessage
  - ResponseId: Int32
  - Status: RequestStatus
  - ServerTimestampUtc: DateTime
  - TimeOffCardResults: PwsSaveTimeOffCardItemResult [???]
  - TimecardResults: PwsSaveTimecardItemResult [???]

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-14T14:42:01.0557418Z
TimeOffCardResults	PwsSaveTimeOffCardItemResult [???]	The results from saving a time off card
TimecardResults	PwsSaveTimecardItemResult [???]	The results from saving a time off card

Response Usage Example(s)

Example 01 - time card

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsSaveTimeCardsAndRtoResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsSaveTimeCardsAndRtoResult 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-14T14:42:01.0557418Z</ServerTimestampUtc>
            <a:TimeOffCardResults/>
            <a:TimecardResults>
               <a:PwsSaveTimecardItemResult>
                  <a:ErrorDetail i:nil="true" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                  <a:ReferenceId i:nil="true"/>
               </a:PwsSaveTimecardItemResult>
            </a:TimecardResults>
         </PwsSaveTimeCardsAndRtoResult>
      </PwsSaveTimeCardsAndRtoResponse>
   </s:Body>
</s:Envelope>

Example 02 - time off card

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsSaveTimeCardsAndRtoResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsSaveTimeCardsAndRtoResult 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-14T15:49:53.1049514Z</ServerTimestampUtc>
            <a:TimeOffCardResults>
               <a:PwsSaveTimeOffCardItemResult>
                  <a:ErrorDetail i:nil="true" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                  <a:ReferenceId i:nil="true"/>
               </a:PwsSaveTimeOffCardItemResult>
            </a:TimeOffCardResults>
            <a:TimecardResults/>
         </PwsSaveTimeCardsAndRtoResult>
      </PwsSaveTimeCardsAndRtoResponse>
   </s:Body>
</s:Envelope>

PwsSaveTimeCardsAndRto - 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.