Overview
This web service updates the user defined fields on one or more time cards.
...
| Panel | ||
|---|---|---|
| ||
|
...
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. | ||
| PwsTimeUdfAdjustmentOrder | PwsTimeUdfAdjustmentOrder | Yes | This structure represents the fields associated with a time card user defined field adjustment | ||
| Explanation | String (1024) | No | An explanation as to why this adjustment was applied. | Time Card UDF update | |
| UdfSortOrder | Int32 | No | This identifies which UDF is being updated, since time cards can only have 2 User Defined Fields, this value must be 1 or 2. | 1 |
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:PwsAdjustTimeUserDefinedField>
<pws:serviceRequest>
<req:RequestId>1</req:RequestId>
<req:SessionTicket>AWuKIeUvHQC5lNzuzE3Ugg==</req:SessionTicket>
<tim:AdjustmentCodeIdentity>
<com:AdjustmentCodeId>11503</com:AdjustmentCodeId>
<com:AdjustmentCodeName>Other</com:AdjustmentCodeName>
<com:AdjustmentCodeUid>1152921504606858479</com:AdjustmentCodeUid>
</tim:AdjustmentCodeIdentity>
<tim:AdjustmentOrders>
<tim:PwsTimeUdfAdjustmentOrder>
<tim:NewValue>
<com:RelationValue>
<com:CodeValue>TC-Jira</com:CodeValue>
<com:TextValue>SD-23</com:TextValue>
<com:UidValue>1152921504606857618</com:UidValue>
</com:RelationValue>
</tim:NewValue>
<tim:TimeCardIdentities>
<tim:PwsVersionedTimecardRef>
<com:TimecardId>45639608</com:TimecardId>
<com:TimecardType>T</com:TimecardType>
<com:TimecardUid>1152921504652486584</com:TimecardUid>
</tim:PwsVersionedTimecardRef>
</tim:TimeCardIdentities>
</tim:PwsTimeUdfAdjustmentOrder>
</tim:AdjustmentOrders>
<tim:Explanation>Time Card UDF update</tim:Explanation>
<tim:UdfSortOrder>1</tim:UdfSortOrder>
</pws:serviceRequest>
</pws:PwsAdjustTimeUserDefinedField>
</soapenv:Body>
</soapenv:Envelope> |
Response Format
| Panel | ||
|---|---|---|
| ||
|
Response Usage Example(s)
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <PwsAdjustTimeUserDefinedFieldResponse xmlns="http://projectorpsa.com/PwsProjectorServices/"> <PwsAdjustTimeUserDefinedFieldResult 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-07T18:49:15.1180888Z</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> </PwsAdjustTimeUserDefinedFieldResult> </PwsAdjustTimeUserDefinedFieldResponse> </s:Body> </s:Envelope> |
PwsAdjustTimeUserDefinedField - Common Errors and Warnings
- For all errors and warnings please refer to the Complete List of Errors and Warnings
ErrorNumber | ErrorCode | ErrorText |
|---|---|---|
| 10117 | ValueOutOfRange | The value specified in the field "UdfSortOrder" in the class "PwsAdjustTimeUserDefinedFieldRq" is out of range. The value must be between 1 and 2. |
| 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. |