Overview

This web service adds/updates the description on one or more existing time cards.

Rate Limiting

In order to protect our servers from inadvertent service overuse or intentional attack, and to fairly distribute services to all our customers, we have implemented a rate limiting algorithm. When fully deployed, this new algorithm will cause services to either succeed with new warnings or fail with new errors when services are consumed at too high a rate. Programs that consume Projector services should be enhanced to handle rate limiting errors so that they can continue functioning properly. For more information please visit: Projector Rate Limiting Behavior.

Request Format

PwsAdjustTimeDescription Request

PwsAdjustTimeDescription
- serviceRequest: PwsAdjustTimeDescriptionRq
  - RequestId: Int32
  - SessionTicket: String
  - AdjustmentCodeIdentity: PwsAdjustmentCodeRef
  - Explanation: String (1024)
  - Description: String (1000)
  - TimeCardIdentities: PwsVersionedTimeCardRef [1..100]

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	AWuKIeUvHQC5lNzuzE3Ugg==
AdjustmentCodeIdentity	PwsAdjustmentCodeRef	No	This structure represents the unique key fields associated with identifying an adjustment code. Adjustment codes are required whenever you make a monetary adjustment to a time or cost card. This is not applicable to this service.
Explanation	String (1024)	No	An explanation as to why this adjustment was applied.	Time Card Description update
Description	String (1000)	Yes	The description to be added / updated to the time card	Preliminary Client Meeting
TimeCardIdentities	PwsVersionedTimeCardRef [1..100]	Yes	This structure represents the unique key fields associated with identifying a Time Card. Time Cards can be identified with a TimeCardUid.

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:PwsAdjustTimeDescription>
         <pws:serviceRequest>
            <req:RequestId>1</req:RequestId>
            <req:SessionTicket>AWuKIeUvHQC5lNzuzE3Ugg==</req:SessionTicket>
            <tim:Explanation>Time Card Description update</tim:Explanation>
            <tim:NewDescription>Preliminary Client Meeting</tim:NewDescription>
            <tim:TimeCardIdentities>
               <tim:PwsVersionedTimecardRef>
                  <com:TimecardType>T</com:TimecardType>
                  <com:TimecardUid>1152921504652486584</com:TimecardUid>
               </tim:PwsVersionedTimecardRef>
            </tim:TimeCardIdentities>
         </pws:serviceRequest>
      </pws:PwsAdjustTimeDescription>
   </soapenv:Body>
</soapenv:Envelope>

Response Format

PwsAdjustTimeDescription Response

PwsAdjustTimeDescriptionResponse
- PwsAdjustTimeDescriptionResult: PwsAdjustTimeDescriptionRs
  - Messages: PwsMessage[]
  - ResponseId: Int32
  - Status: RequestStatus
  - ServerTimestampUtc: DateTime
  - TimeCardIdentities: PwsTimeCardRef [1..100]

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	2019-11-06T17:18:38.6934436Z
TimeCardIdentities	PwsTimeCardRef [1..100]	The identities of the time cards that were updated.

Response Usage Example(s)

Example 01

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsAdjustTimeDescriptionResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsAdjustTimeDescriptionResult 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/">2019-11-06T17:18:38.6934436Z</ServerTimestampUtc>
            <a:TimeCardIdentities xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
               <b:PwsTimecardRef>
                  <b:ReferenceId i:nil="true"/>
                  <b:TimecardId>45639608</b:TimecardId>
                  <b:TimecardType>T</b:TimecardType>
                  <b:TimecardUid>1152921504652486584</b:TimecardUid>
               </b:PwsTimecardRef>
            </a:TimeCardIdentities>
         </PwsAdjustTimeDescriptionResult>
      </PwsAdjustTimeDescriptionResponse>
   </s:Body>
</s:Envelope>

PwsAdjustTimeDescription - Common Errors and Warnings

For all errors and warnings please refer to the Complete List of Errors and Warnings

ErrorNumber	ErrorCode	ErrorText
20051	InvalidValueForTimeCardType	The specified value for time card type is invalid. Valid values are T for Time Card and R for Reported Time Off.
50024	EntityNotFound	Time Card was not found. Another user may have deleted it.
64365	OneOrMoreTimeCardsIneligibleForAdjustment	Adjustment cannot be completed because one or more cards has changed or is ineligible for adjustment.

API Documentation

PwsAdjustTimeDescription

Analytics

Overview

Request Format

Request Elements

Request Usage Example(s)

Response Format

Response Elements

Response Usage Example(s)

PwsAdjustTimeDescription - Common Errors and Warnings

Related content

PwsAdjustTimeDescription

[data-colorid=sx5evpq6mw]{color:#292a2e} html[data-color-mode=dark] [data-colorid=sx5evpq6mw]{color:#d1d2d6}[data-colorid=hi2hz7af83]{color:#292a2e} html[data-color-mode=dark] [data-colorid=hi2hz7af83]{color:#d1d2d6}Overview

Request Format

Request Elements

Request Usage Example(s)

Response Format

Response Elements

Response Usage Example(s)

PwsAdjustTimeDescription - Common Errors and Warnings

Related content

Overview