...
This web service adds/updates the description on one or more existing time cost cards.
Request Format
| Panel | ||
|---|---|---|
| ||
|
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 | 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. | ||||||||
| Description | String (1000) | Yes | The description to be added / updated to the cost card | Preliminary Client Meeting | |||||||
| CostCardIdentities | PwsVersionedCostCardRef | 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. | Timemade | Carda | Descriptionmistake | updateearlier | Description||||
| NewDescription | String (1000) | Yes | The description to be added / updated to the | timecost card | Preliminary2-night | Client MeetingTimeCardIdentities | PwsVersionedTimeCardRef | Yes | This structure represents the unique key fields associated with identifying a Time Card. Time Cards can be identified with a TimeCardUid. | hotel stay |
Request Usage Example(s)
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<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 | ||
|---|---|---|
| ||
|
...
| 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 |
| TimeCardIdentitiesCostCardIdentities | PwsTimeCardRefPwsCostCardRef | The identities of the time cost cards that were updated. |
Response Usage Example(s)
...
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<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:ReferenceIdCostCardId i:nil="true"/>
<b:TimecardId>45639608<CostCardUid>1152921504614703247</b:TimecardId>CostCardUid>
<b:TimecardType>T</b:TimecardType>
<b:TimecardUid>1152921504652486584</b:TimecardUid>ReferenceId i:nil="true"/>
</b:PwsTimecardRef>PwsCostCardRef>
</a:TimeCardIdentities>CostCardIdentities>
</PwsAdjustTimeDescriptionResult>PwsAdjustCostDescriptionResult>
</PwsAdjustTimeDescriptionResponse>PwsAdjustCostDescriptionResponse>
</s:Body>
</s:Envelope> |
...
PwsAdjustCostDescription - 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.