/
PwsAddProjectNote

PwsAddProjectNote

Owned by Bettina Borces
Last updated: yesterday at 4:16 pm

Overview


This web service adds a note to a specified project (PwsProjectRef).

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


PwsAddProjectNote Request

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

AWYoWMBC/cjl/RFPrykteA==

Note

String (1024)

Yes


The note to be added to the project

To include additional or supporting information, 
you can add a note to a project.

ProjectIdentity

PwsProjectRef

Yes


The identity of the project to which the note will be added to


LocksToStealPwsEntityLockSummary[1..100]No
The detailed information of the locks that are to be stolen. If not specified, the request will fail if any requested locks are already held. If specified, the information supplied must exactly match the current state of existing locks or the attempt to steal the existing locks will fail. Typically, this service is invoked with LocksToSteal empty or null. If there are existing locks, they will be returned in the LockHolders member of PwsFault. This data can then be sent, as is, back to the server in a second invocation of this service, as LocksToSteal, if the caller desires to steal the locks.
ProjectTimestampStringNo
This is an optimistic locking timestamp that, if provided on update request, will cause the request to fail when the timestamp stored in the database does not match the provided value.
ProjectorLockSetIdInt32No
A projector lock set id is an identifier for a group of one or more locks held as a unit. If the session ticket owner for this request is also the holder of a lock in this set, the request can proceed and will not be blocked by the lock.

Request Usage Example(s)


Example 01 - no lock stolen 
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:pws="http://projectorpsa.com/PwsProjectorServices/" xmlns:req="http://projectorpsa.com/DataContracts/Requests/" xmlns:sch="http://projectorpsa.com/DataContracts/Shared/Scheduling/" xmlns:com="http://projectorpsa.com/DataContracts/Shared/Common/">
   <soapenv:Header/>
   <soapenv:Body>
      <pws:PwsAddProjectNote>
         <pws:serviceRequest>
            <req:RequestId>1</req:RequestId>
            <req:SessionTicket>AWYoWMBC/cjl/RFPrykteA==</req:SessionTicket>
            <sch:Note>To include additional or supporting information, you can add a note to a task, resource, assignment, or the entire project.</sch:Note>
            <sch:ProjectIdentity>
               <com:ProjectCode>P001320-001</com:ProjectCode>
            </sch:ProjectIdentity>
         </pws:serviceRequest>
      </pws:PwsAddProjectNote>
   </soapenv:Body>
</soapenv:Envelope>
Example 02 - lock stolen 
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:pws="http://projectorpsa.com/PwsProjectorServices/" xmlns:req="http://projectorpsa.com/DataContracts/Requests/" xmlns:sch="http://projectorpsa.com/DataContracts/Shared/Scheduling/" xmlns:com="http://projectorpsa.com/DataContracts/Shared/Common/">
   <soapenv:Header/>
   <soapenv:Body>
      <pws:PwsAddProjectNote>
         <pws:serviceRequest>
            <req:SessionTicket>Ade8vXDjCIr0kcDpdVTbCw==</req:SessionTicket>
            <sch:Note>1st note</sch:Note>
            <sch:ProjectIdentity>
               <com:ProjectCode>P001125-001</com:ProjectCode>
            </sch:ProjectIdentity>
            <sch:LocksToSteal>
               <com:PwsEntityLockSummary>
                  <com:EntityIdentity>
                     <com:EntityCode>P001125-001</com:EntityCode>
                     <com:LockType>P</com:LockType>
                  </com:EntityIdentity>
                  <com:EntityLockSummary>
                     <com:PwsEntityLockSummaryItem>
                        <com:LockCount>1</com:LockCount>
                        <com:LockHolderUserIdentity>
                           <com:UserDisplayName>Krakauer, Larry</com:UserDisplayName>
                        </com:LockHolderUserIdentity>
                        <com:MostRecentLockAcquisitionTimestamp>2018-11-13T20:31:20.647Z</com:MostRecentLockAcquisitionTimestamp>
                     </com:PwsEntityLockSummaryItem>
                  </com:EntityLockSummary>
               </com:PwsEntityLockSummary>
            </sch:LocksToSteal>
         </pws:serviceRequest>
      </pws:PwsAddProjectNote>
   </soapenv:Body>
</soapenv:Envelope>

Response Format


PwsAddProjectNote Response

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-01-19T21:53:15.0569601Z 
ProjectTimestampStringThis is an optimistic locking timestamp that, if provided on update request, will cause the request to fail when the timestamp stored in the database does not match the provided value.AAAAABFFCOw=
StolenLocksPwsEntityLockSummaryThe locks that have been stolen during the project note creation or update.

Response Usage Example(s)


Example 01 - no lock stolen 
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsAddProjectNoteResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsAddProjectNoteResult xmlns:a="http://projectorpsa.com/DataContracts/Shared/Scheduling/" 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-01-19T21:53:15.0569601Z</ServerTimestampUtc>
         </PwsAddProjectNoteResult>
      </PwsAddProjectNoteResponse>
   </s:Body>
</s:Envelope>
Example 02 - lock stolen 
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsAddProjectNoteResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsAddProjectNoteResult xmlns:a="http://projectorpsa.com/DataContracts/Shared/Scheduling/" 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/">0</ResponseId>
            <Status xmlns="http://projectorpsa.com/CommonServices/">Ok</Status>
            <ServerTimestampUtc xmlns="http://projectorpsa.com/CommonServices/">2018-11-13T20:37:37.6214694Z</ServerTimestampUtc>
            <a:ProjectTimestamp>AAAAABFFCOw=</a:ProjectTimestamp>
            <a:StolenLocks xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
               <b:EntityIdentity>
                  <b:EntityCode>P001125-001</b:EntityCode>
                  <b:EntityId i:nil="true"/>
                  <b:EntityUid>1152921504607425735</b:EntityUid>
                  <b:LockType>P</b:LockType>
               </b:EntityIdentity>
               <b:EntityLockSummary>
                  <b:PwsEntityLockSummaryItem>
                     <b:LockCount>1</b:LockCount>
                     <b:LockHolderUserIdentity>
                        <b:UserDisplayName>Krakauer, Larry</b:UserDisplayName>
                        <b:UserId i:nil="true"/>
                        <b:UserReferenceSystemId>097</b:UserReferenceSystemId>
                        <b:UserUid>1152921504606944254</b:UserUid>
                     </b:LockHolderUserIdentity>
                     <b:MostRecentLockAcquisitionTimestamp>2018-11-13T20:31:20.647Z</b:MostRecentLockAcquisitionTimestamp>
                  </b:PwsEntityLockSummaryItem>
               </b:EntityLockSummary>
            </a:StolenLocks>
         </PwsAddProjectNoteResult>
      </PwsAddProjectNoteResponse>
   </s:Body>
</s:Envelope>

PwsAddProjectNote - Common Errors and Warnings


ErrorNumber

ErrorCode

ErrorText

165ProjectNoteTruncatedThe project note exceeded the maximum length of 1024 characters and was truncated.
50220WebServicesPermissionDeniedThe specified user does not have permission to execute web services, or web services is not enabled for this account.
50472LockReleasedLock xxxxx of type P  has been released.
50473InvalidLockInvalid lock specified.