Versions Compared

Key

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

...

Panel
titlePwsSaveDocumentLink Request

Request Elements


Element

Data Type

Required?

Default

Description

Sample Data

RequestId

Int32

No


Click here for more information.


SessionTicket

String

Yes


Click here for more information.

Ae9v30fDNwFMx833f5Hesg==

DocumentIdentity

PwsDocumentRefNo
If document identity is provided, this document is replaced with a new linked document using specified name and uri. If not provided, a new linked document is created using the specified name and URI. Note that the specified document identity must refer to a document link. A physical document cannot be converted into a document link. Click here for more information.
DocumentNameString (260)Yes
The name of the new linked document.Linked invoice #1
DocumentUriString (2000)Yes
The URI of the new linked document.
https://www.accountexnetwork.com/blog/wp-content/uploads/2013/08/image33.png
FolderIdentityPwsFolderRefYes
The identity of the folder where this linked document should resides.Click here for more information. The folder is linked to the Projector entity (e.g. Project, Resource, Issue or Invoice) that the link is to be associated with. See PwsGetFolder for details on how to obtain the proper folder identity to pass in here.
OverrideLockFlagBooleanNo
For update, if set to 'true', save can proceed even when the document link is locked.false

Request Usage Example(s)


Code Block
languagexml
titleExample 01 - replacing an existing linked document
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:doc="http://projectorpsa.com/DataContracts/Shared/DocumentManagement/" xmlns:com="http://projectorpsa.com/DataContracts/Shared/Common/">
   <soapenv:Header/>
   <soapenv:Body>
      <pws:PwsSaveDocumentLink>
         <pws:serviceRequest>
            <req:SessionTicket>ATtU220EvBSE2+GCN9U58g==</req:SessionTicket>
            <doc:DocumentIdentity>
               <com:DocumentRefUid>1152921504607653980</com:DocumentRefUid>
            </doc:DocumentIdentity>
            <doc:DocumentName>Invoice link only</doc:DocumentName>
            <doc:DocumentUri>https://www.accountexnetwork.com/blog/wp-content/uploads/2013/08/image33.png</doc:DocumentUri>
            <doc:FolderIdentity>
               <com:FolderUid>1152921504607342206</com:FolderUid>
            </doc:FolderIdentity>
         </pws:serviceRequest>
      </pws:PwsSaveDocumentLink>
   </soapenv:Body>
</soapenv:Envelope>

...