Overview
This web service service updates the uri of a specified document that resides in a invoice, project workspace, issue and resource resume folders. The specified document must be a document link. This service cannot be used to convert a document physically stored in Projector into a document link.
Request Format
| Panel | ||
|---|---|---|
| ||
|
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. | AftyRXSTlnMPzozuKwq0kQ== | |
DocumentIdentity | Yes | The identity of the document whose uri is to be updated. Click here for more information. | |||
NewDocumentUri | String | Yes (2000) | The new uri of the specified document | www.projectorpsa.com |
Request Usage Example(s)
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<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:PwsSetDocumentUri>
<pws:serviceRequest>
<req:SessionTicket>AftyRXSTlnMPzozuKwq0kQ==</req:SessionTicket>
<doc:DocumentIdentity>
<com:DocumentRefUid>1152921504607653988</com:DocumentRefUid>
</doc:DocumentIdentity>
<doc:NewDocumentUri>www.projectorpsa.com</doc:NewDocumentUri>
</pws:serviceRequest>
</pws:PwsSetDocumentUri>
</soapenv:Body>
</soapenv:Envelope> |
...
| Panel | ||
|---|---|---|
| ||
|
...
Element | Data Type | Description | Sample Data |
|---|---|---|---|
Messages | The web service response status and message. Click here for more information. | ||
ResponseId | Int32 | Click here for more information. | 0 |
Status | Click Click here for for more information. | Ok | |
ServerTimestampUtc | DateTime | Click here for more information. | 2018-03-20T15:38:08.0062496Z |
Response Usage Example(s)
...
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body>
<PwsSetDocumentUriResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
<PwsSetDocumentUriResult 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-20T15:38:08.0062496Z</ServerTimestampUtc>
</PwsSetDocumentUriResult>
</PwsSetDocumentUriResponse>
</s:Body>
</s:Envelope> |
PwsSetDocumentUri - Common Errors and Warnings
- For all errors and warnings please refer to the Complete List of Errors and Warnings
ErrorNumber | ErrorCode | ErrorText |
|---|---|---|
| 21010 | DocumentRequiredForSetDocumentUri | A document identity must be specified. |
| 75199 | DocumentNotFound | Document not found. |
| 75218 | NewUriRequiredForSetDocumentUri | New document URI must be specified. |
| 75220 | DocumentIsNotALink | Document is not a link-type document. |