PwsAdjustCostUserDefinedField

Owned by Bettina Borces
Last updated: Nov 12, 2019
4 min read

Overview


This web service updates the user defined fields on one or more cost cards. 

Request Format


PwsAdjustCostUserDefinedField Request

Request Elements


Element

Data Type

Required?

Default

Description

Sample Data

RequestIdInt32No
Click here for more information
1
SessionTicket

String

Yes
Click here for more information
AZZLhIFhqIg+w/UlZKyCfg==
AdjustmentCodeIdentityPwsAdjustmentCodeRefNo
This structure represents the unique key fields associated with identifying an adjustment code.
AdjustmentOrdersPwsCostUdfAdjustmentOrder [1..100]Yes
This structure represents the fields associated with a cost card user defined field adjustment
Explanation

String (1024)

No
An explanation as to why this adjustment was applied.
Cost Card User Defined Field update
UdfSortOrderInt32No
This identifies which UDF is being updated, since cost cards can only have 2 User Defined Fields, this value must be 1 or 2.
1

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:PwsAdjustCostUserDefinedField>
         <pws:serviceRequest>
            <req:RequestId>1</req:RequestId>
            <req:SessionTicket>AZZLhIFhqIg+w/UlZKyCfg==</req:SessionTicket>
            <tim:AdjustmentCodeIdentity>
               <com:AdjustmentCodeName>Other</com:AdjustmentCodeName>
               <com:AdjustmentCodeUid>1152921504606858479</com:AdjustmentCodeUid>
            </tim:AdjustmentCodeIdentity>
            <tim:AdjustmentOrders>
               <tim:PwsCostUdfAdjustmentOrder>
                  <tim:CostCardIdentities>
                     <tim:PwsVersionedCostCardRef>
                        <com:CostCardUid>1152921504614693735</com:CostCardUid>
                     </tim:PwsVersionedCostCardRef>
                  </tim:CostCardIdentities>
                  <tim:NewValue>
                     <com:RelationValue>
                        <com:CodeValue>CC-Jira</com:CodeValue>
                        <com:TextValue>SD-23</com:TextValue>
                        <com:UidValue>1152921504606857618</com:UidValue>
                     </com:RelationValue>
                  </tim:NewValue>
               </tim:PwsCostUdfAdjustmentOrder>
            </tim:AdjustmentOrders>
            <tim:Explanation>Cost Card User Defined Field update</tim:Explanation>
            <tim:UdfSortOrder>1</tim:UdfSortOrder>
         </pws:serviceRequest>
      </pws:PwsAdjustCostUserDefinedField>
   </soapenv:Body>
</soapenv:Envelope>

Response Format


PwsAdjustCostUserDefinedField Response

Response Elements


Element

Data Type

Description

Sample 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
CostCardIdentitiesPwsCostCardRef [1..100]The identities of the cost cards that were updated.

Response Usage Example(s)


Example 01 
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsAdjustCostUserDefinedFieldResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsAdjustCostUserDefinedFieldResult 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-11T20:44:16.3017931Z</ServerTimestampUtc>
            <a:CostCardIdentities xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
               <b:PwsCostCardRef>
                  <b:CostCardId>7846759</b:CostCardId>
                  <b:CostCardUid>1152921504614693735</b:CostCardUid>
                  <b:ReferenceId i:nil="true"/>
               </b:PwsCostCardRef>
            </a:CostCardIdentities>
         </PwsAdjustCostUserDefinedFieldResult>
      </PwsAdjustCostUserDefinedFieldResponse>
   </s:Body>
</s:Envelope>

PwsAdjustCostUserDefinedField - Common Errors and Warnings


ErrorNumber

ErrorCode

ErrorText

10117ValueOutOfRangeThe value specified in the field "UdfSortOrder" in the class "PwsAdjustCostUserDefinedFieldRq" is out of range. The value must be between 1 and 2.
50024EntityNotFoundCost Card was not found. Another user may have deleted it.
64365OneOrMoreTimeCardsIneligibleForAdjustment

Adjustment cannot be completed because one or more cards has changed or is ineligible for adjustment.