Overview

This web service updates one or more user defined fields for one or more specified entities.

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

PwsSaveUserDefinedFieldsRq

PwsSaveUserDefinedFieldsRq
- RequestId: Int32
- SessionTicket: String
- ProjectorLockSetId: Int32
- SaveOrders: PwsSaveUserDefinedFieldsOrder[1..100]
- UdfType: String (1)

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.	AVqwYHFUvUT/fJlt22N2DA==
ProjectorLockSetId	Int32	No	Click here for more information.	3884
SaveOrders	PwsSaveUserDefinedFieldsOrder[1..100]	Yes	One or more "instructions" to modify user defined field values.
UdfType	String (1)	Yes	The user defined field type: "C" for Client "E" for Engagement "P" for Project "A" for Role "K" for Task "S" for Issue "R" for Resource "T" for Time Card "X" for Cost Card	P

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:com="http://projectorpsa.com/DataContracts/Shared/Common/">
   <soapenv:Header/>
   <soapenv:Body>
      <pws:PwsSaveUserDefinedFields>
         <pws:serviceRequest>
            <req:RequestId>1</req:RequestId>
            <req:SessionTicket>AVqwYHFUvUT/fJlt22N2DA==</req:SessionTicket>
            <req:ProjectorLockSetId>3884</req:ProjectorLockSetId>
            <req:SaveOrders>
               <com:PwsSaveUserDefinedFieldsOrder>
                  <com:EntityCode>P001468-001</com:EntityCode>
                  <com:UserDefinedFields>
                     <com:PwsUserDefinedFieldDetail>
                        <com:UdfName>PR-Assigned Resource</com:UdfName>
                        <com:ResourceIdentityValue>
                           <com:ResourceReferenceSystemId>IT Manager</com:ResourceReferenceSystemId>
                        </com:ResourceIdentityValue>
                     </com:PwsUserDefinedFieldDetail>
                  </com:UserDefinedFields>
               </com:PwsSaveUserDefinedFieldsOrder>
            </req:SaveOrders>
            <req:UdfType>P</req:UdfType>
         </pws:serviceRequest>
      </pws:PwsSaveUserDefinedFields>
   </soapenv:Body>
</soapenv:Envelope>

Response Format

PwsSaveUserDefinedFieldsRs

PwsSaveUserDefinedFieldsRs
- Messages: PwsMessage[]
- ResponseId: Int32
- Status: RequestStatus
- ServerTimestampUtc: DateTime

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.	2018-11-06T22:29:22.7960743Z

Response Usage Example(s)

Example 01

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsSaveUserDefinedFieldsResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsSaveUserDefinedFieldsResult xmlns:a="http://projectorpsa.com/DataContracts/Responses/" 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/">2018-11-06T22:29:22.7960743Z</ServerTimestampUtc>
         </PwsSaveUserDefinedFieldsResult>
      </PwsSaveUserDefinedFieldsResponse>
   </s:Body>
</s:Envelope>

PwsSaveUserDefinedFields - Common Errors and Warnings

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

ErrorNumber	ErrorCode	ErrorText
10126	InvalidEnumerationValueSpecified	An invalid value was specified for UdfType. Valid values are C, E, P, A, K, S, R, T, X.
50024	EntityNotFound	Error 50024, State 3: Entity not found ### [refStructureName:PwsProjectRef]
50469	EntityAlreadyLocked	Error 50469, State 1: One or more existing locks prevent acquisition of requested lock.
50471	LockStolen	Error 50471, State 1: Lock has been stolen. ### [referenceId1:3891]
62438	UdfValueUnexpected	When specifying user defined field values, be sure to only populate the proper type-specific value, based on the UDF data type.

API Documentation

PwsSaveUserDefinedFields

Analytics

Overview

Request Format

Request Elements

Request Usage Example(s)

Response Format

Response Elements

Response Usage Example(s)

PwsSaveUserDefinedFields - Common Errors and Warnings

Related content

PwsSaveUserDefinedFields

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

Request Format

Request Elements

Request Usage Example(s)

Response Format

Response Elements

Response Usage Example(s)

PwsSaveUserDefinedFields - Common Errors and Warnings

Related content

Overview