Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Panel
titlePwsAddProjectNote Request

...

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.

...

Code Block
languagexml
titleExample 02 - lock stolen
collapsetrue
<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>
         <!--Optional:-->
         <pws:serviceRequest>
            <req:SessionTicket>Ade8vXDjCIr0kcDpdVTbCw==</req:SessionTicket>
            <sch:Note>1st note</sch:Note>
            <sch:ProjectIdentity>
               <!--Optional:-->
               <com:ProjectCode>P001125-001</com:ProjectCode>
            </sch:ProjectIdentity>
            <!--Optional:--><sch:LocksToSteal>
             <sch:LocksToSteal>
               <!--Zero or more repetitions:-->
               <com:PwsEntityLockSummary>
                  <!--Optional:-->
                  <com:EntityIdentity>
                     <!--Optional:-->
                     <com:EntityCode>P001125-001</com:EntityCode>
                     <com:LockType>P</com:LockType>
                  </com:EntityIdentity>
                  <!--Optional:-->
                  <com:EntityLockSummary>
                     <!--Zero or more repetitions:--><com:PwsEntityLockSummary>
                     <com:PwsEntityLockSummaryItem>EntityIdentity>
                        <!--Optional:-->
  <com:EntityCode>P001125-001</com:EntityCode>
                     <com:LockCount>1<LockType>P</com:LockCount>LockType>
                  </com:EntityIdentity>
        <!--Optional:-->          <com:EntityLockSummary>
               <com:LockHolderUserIdentity>      <com:PwsEntityLockSummaryItem>
                     <!--Optional:-->   <com:LockCount>1</com:LockCount>
                        <com:UserDisplayName>Krakauer, Larry</com:UserDisplayName>LockHolderUserIdentity>
                           <com:UserDisplayName>Krakauer, <Larry</com:LockHolderUserIdentity>UserDisplayName>
                        <!--Optional:-->/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>

...