PwsSubmitTimeCards

Overview


This web service submits draft and rejected time cards and/or time off time cards within a specified date range for a specified resource (PwsResourceRef)

Request Format


PwsSubmitTimeCards Request
  • PwsSubmitTimeCards

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.

AeR4Dk0NH4DfgEc+0+wdKA==

AdministratorComments

String

No 


Comments applied if time is being submitted on behalf of the specified resource by another user.

mid-March Submission

ResourceIdentity

PwsResourceRef

No


The resource associated with the time cards when acting on behalf of another resource. If a resource identity is not specified the time cards of the authenticated user will be submitted.


SendNotificationEmailFlag

Boolean

No 

false

If set to 'true', a notification e-mail will be sent to the resource associated with the time card(s), applicable only when acting on behalf of another user.

false

SubmitEndDate

DateTime

Yes


The SubmitEndDate (in midnight UTC format) and the SubmitStartDate (in midnight UTC format) defines the period in which the time cards should be submitted, leaving either field null will result in all eligible time cards being submitted.

2018-03-16T00:00:00.000Z

SubmitStartDate

DateTime

Yes 


See SubmitEndDate.

2018-03-12T00:00:00.000Z
SubmitTimeCardIdentityPwsTimeCardRefNo
User can only submit one of the three set of time card criteria: time card identity, time-off card identity, and time card date range. This data structure is used to supply time card identity or time-off card identity.

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:PwsSubmitTimeCards>
         <pws:rq>
            <req:RequestId>1</req:RequestId>
            <req:SessionTicket>AeR4Dk0NH4DfgEc+0+wdKA==</req:SessionTicket>
            <tim:AdministratorComments>mid-March Submission</tim:AdministratorComments>
            <tim:SendNotificationEmailFlag>false</tim:SendNotificationEmailFlag>
            <tim:SubmitEndDate>2018-03-16T00:00:00.000Z</tim:SubmitEndDate>
            <tim:SubmitStartDate>2018-03-12T00:00:00.000Z</tim:SubmitStartDate>
         </pws:rq>
      </pws:PwsSubmitTimeCards>
   </soapenv:Body>
</soapenv:Envelope>

Response Format


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


ServerTimestampUtc

DateTime

Click here for more information.

2018-03-21T14:01:59.5726193Z

Response Usage Example(s)


Example 01
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsSubmitTimeCardsResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsSubmitTimeCardsResult 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-21T14:01:59.5726193Z</ServerTimestampUtc>
         </PwsSubmitTimeCardsResult>
      </PwsSubmitTimeCardsResponse>
   </s:Body>
</s:Envelope>

PwsSubmitTimeCards - Common Errors and Warnings


ErrorNumber

ErrorCode

ErrorText

10116InvalidDateValueSpecifiedThe date specified in the field "StartDate" in the class "PwsGetResourceWorkingScheduleRq" is invalid or out of range. The time component of the specified date must be midnight UTC.
20051InvalidValueForTimeCardTypeThe specified value for time card type is invalid. Valid values are T for Time Card and R for Reported Time Off.
50223NoPermissionToActOnBehalfOfResourceThe specified user does not have permission to act on behalf of this resource.
57545ResourceNotFoundThe specified resource does not exist.
64269InvalidParametersToSubmitTimeWhen submitting time, please specify only a date range, only a time card identity or only a time off card identity.