Versions Compared

Version Old Version 1 New Version Current
Changes made by

Min Zeng

Bettina Borces

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Overview


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


Info
titleRate 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


Panel
titlePwsAdjustTimeDescription PwsAdjustCostDescription Request


Request Elements


TimeCardDescriptionupdateDescriptionYes time cardThis structure represents the unique key fields associated with identifying a Time Card. Time Cards can be identified with a TimeCardUid. 
ElementData TypeRequired?DefaultDescriptionSample Data
RequestIdInt32No
Click here for more information
1
SessionTicket

String

Yes
Click here for more information
AWuKIeUvHQC5lNzuzE3UggAYqurzyaruwg84zm4AOdBA==
AdjustmentCodeIdentityPwsAdjustmentCodeRefNo
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. 
CostCardIdentitiesPwsVersionedCostCardRef [1..100]Yes
This structure represents the unique key fields associated with identifying a cost card.
Explanation

String (1024)

No
An explanation as to why this adjustment was applied.
Made 
a 
mistake 
earlier
NewDescriptionString (1000)No
The description to be added / updated to the 
Preliminary Client Meeting
TimeCardIdentitiesPwsVersionedTimeCardRefYescost card. If omitted, the cost card's description will be cleared.
2-night hotel stay


Request Usage Example(s)


Code Block
languagexml
titleExample 01
collapsetrue
<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>PwsAdjustCostDescription>
         <pws:serviceRequest>
            <req:RequestId>1</req:RequestId>
            <req:SessionTicket>AWuKIeUvHQC5lNzuzE3UggSessionTicket>AYqurzyaruwg84zm4AOdBA==</req:SessionTicket>
            <tim:Explanation>TimeCostCardIdentities>
Card Description update</tim:Explanation>             <tim:NewDescription>PreliminaryPwsVersionedCostCardRef>
Client Meeting</tim:NewDescription>             <tim:TimeCardIdentities>                <tim:PwsVersionedTimecardRef><com:CostCardUid>1152921504614703247</com:CostCardUid>
                  <com:TimecardType>T</com:TimecardType></tim:PwsVersionedCostCardRef>
                  <com:TimecardUid>1152921504652486584</com:TimecardUid></tim:CostCardIdentities>
            <tim:Explanation>Made a mistake <earlier</tim:PwsVersionedTimecardRef>Explanation>
            <tim:NewDescription>2-night hotel <stay</tim:TimeCardIdentities>NewDescription>
         </pws:serviceRequest>
      </pws:PwsAdjustTimeDescription>PwsAdjustCostDescription>
   </soapenv:Body>
</soapenv:Envelope>

Response Format


Panel
titlePwsAdjustTimeDescription PwsAdjustCostDescription response

Response Elements


ElementData TypeDescriptionSample Data
MessagesPwsMessage[]

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


ResponseIdInt32Click here for more information
1
StatusRequestStatusClick here for more information
Ok
ServerTimestampUtcDateTimeClick here for more information
2019-11-06T17:18:38.6934436Z
TimeCardIdentitiesPwsTimeCardRefCostCardIdentitiesPwsCostCardRef [1..100]The identities of the time cost cards that were updated.

Response Usage Example(s)

...

Code Block
languagexml
titleExample 01
collapsetrue
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsAdjustTimeDescriptionResponse<PwsAdjustCostDescriptionResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsAdjustTimeDescriptionResult<PwsAdjustCostDescriptionResult 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<>0</ResponseId>
            <Status xmlns="http://projectorpsa.com/CommonServices/">Ok</Status>
            <ServerTimestampUtc xmlns="http://projectorpsa.com/CommonServices/">2019-11-06T1706T16:1806:3859.6934436Z<6092232Z</ServerTimestampUtc>
            <a:TimeCardIdentitiesCostCardIdentities xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
               <b:PwsTimecardRef>PwsCostCardRef>
                  <b:ReferenceId i:nil="true"/>
                  <b:TimecardId>45639608</b:TimecardId>
        CostCardUid>1152921504614703247</b:CostCardUid>
         <b:TimecardType>T</b:TimecardType>                   <b:TimecardUid>1152921504652486584</b:TimecardUid>
               </b:PwsTimecardRef>PwsCostCardRef>
            </a:TimeCardIdentities>CostCardIdentities>
         </PwsAdjustTimeDescriptionResult>PwsAdjustCostDescriptionResult>
      </PwsAdjustTimeDescriptionResponse>PwsAdjustCostDescriptionResponse>
   </s:Body>
</s:Envelope>

...

PwsAdjustCostDescription - Common Errors and Warnings

...

The specified value for time card type is invalid. Valid values are T for Time Card and R for Reported Time Off.

ErrorNumber

ErrorCode

ErrorText

20051InvalidValueForTimeCardType

50024EntityNotFoundTime Cost Card was not found. Another user may have deleted it.64365OneOrMoreTimeCardsIneligibleForAdjustmentAdjustment cannot be completed because one or more cards has changed or is ineligible for adjustment.