Overview

This web service renames a Projector document.

Request Format

PwsRenameDocument Request

PwsRenameDocument
- serviceRequest: PwsRenameDocumentRq
  - RequestId: Int32
  - SessionTicket: String
  - DocumentIdentity: PwsDocumentRef
  - NewDocumentName: String

Request Elements

Element	Data Type	Description
RequestId	Int32	Click here for more information.
SessionTicket	String	Click here for more information.
DocumentIdentity	PwsDocumentRef
NewDocumentName	String

Request Usage Example(s)

Example 01

<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:PwsRenameDocument>
         <pws:serviceRequest>
            <req:SessionTicket>AftyRXSTlnMPzozuKwq0kQ==</req:SessionTicket>
            <doc:DocumentIdentity>
               <com:DocumentRefUid>1152921504607655598</com:DocumentRefUid>
            </doc:DocumentIdentity>
            <doc:NewDocumentName>Changed using WS.docx</doc:NewDocumentName>
         </pws:serviceRequest>
      </pws:PwsRenameDocument>
   </soapenv:Body>
</soapenv:Envelope>

Response Format

PwsRenameDocument Response

PwsRenameDocumentResponse
- PwsRenameDocumentResult: PwsRenameDocumentRs
  - Messages: PwsMessage
  - ResponseId: Int32
  - Status: RequestStatus
  - ServerTimestampUtc: DateTime
  - DocumentIdentity: PwsDocumentRef

Response Elements

Element	Data Type	Description
Messages	PwsMessage
ResponseId	Int32	Click here for more information.
Status	RequestStatus	Click here for more information.
ServerTimestampUtc	DateTime	Click here for more information.
DocumentIdentity	PwsDocumentRef

Response Usage Example(s)

Example 01

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsRenameDocumentResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsRenameDocumentResult 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-20T13:33:31.3991044Z</ServerTimestampUtc>
            <a:DocumentIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
               <b:DocumentRefId i:nil="true"/>
               <b:DocumentRefUid>1152921504607655598</b:DocumentRefUid>
            </a:DocumentIdentity>
         </PwsRenameDocumentResult>
      </PwsRenameDocumentResponse>
   </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
21009	DocumentRequiredForRenameDocument	A document identity must be specified.
75087	DocumentNameContainsInvalidCharacters	The document name is missing or contains invalid characters.
75100	CannotChangeDocumentExtension	You cannot change the extension associated with a document.
75199	DocumentNotFound	Document not found.