Overview

Request Format

PwsSaveDocumentLink Request

PwsSaveDocumentLink
- serviceRequest: PwsSaveDocumentLinkRq
  - RequestId: Int32
  - SessionTicket: String
  - DocumentIdentity: PwsDocumentRef
  - DocumentName: String (260)
  - DocumentUri: String (2000)
  - FolderIdentity: PwsFolderRef

Request Elements

Element	Data Type	Required?	Description	Sample Data
RequestId	Int32	No	Click here for more information.
SessionTicket	String	Yes	Click here for more information.	Ae9v30fDNwFMx833f5Hesg==
DocumentIdentity	PwsDocumentRef
DocumentName	String (260)
DocumentUri	String (2000)
FolderIdentit	PwsFolderRef	Yes

Request Usage Example(s)

Example 01 - update an existing link

<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?x54120</doc:DocumentUri>
            <doc:FolderIdentity>
               <com:FolderUid>1152921504607342206</com:FolderUid>
            </doc:FolderIdentity>
         </pws:serviceRequest>
      </pws:PwsSaveDocumentLink>
   </soapenv:Body>
</soapenv:Envelope>

Response Format

PwsSetDocumentUri Response

PwsSetDocumentUriResponse
- PwsSetDocumentUriResult: PwsSetDocumentUriRs
  - Messages: PwsMessage
  - ResponseId: Int32
  - Status: RequestStatus
  - ServerTimestampUtc: DateTime

Response Elements

Element	Data Type	Description
Messages	PwsMessage	The web service response status and message. Click here for more information.
ResponseId	Int32	Click here for more information.
Status	RequestStatus	Click here for more information.
ServerTimestampUtc	DateTime	Click here for more information.

Response Usage Example(s)

Example 01 - update an existing link

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsSaveDocumentLinkResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsSaveDocumentLinkResult xmlns:a="http://projectorpsa.com/DataContracts/Shared/DocumentManagement/" 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-03-15T19:52:50.297197Z</ServerTimestampUtc>
            <a:DocumentIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
               <b:DocumentRefId i:nil="true"/>
               <b:DocumentRefUid>1152921504607653983</b:DocumentRefUid>
            </a:DocumentIdentity>
         </PwsSaveDocumentLinkResult>
      </PwsSaveDocumentLinkResponse>
   </s:Body>
</s:Envelope>

Common Errors and Warnings

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

ErrorNumber	ErrorCode	ErrorText
10106	InvalidUrl	The value specified in the field "DocumentUri" in the class "PwsSaveDocumentLinkRq"was not recognized as a proper URL.
10111	RequiredFieldMissing	A required field is missing: FolderIdentity
75199	DocumentNotFound	Document not found.