PwsRenameDocument
Overview
This web service renames a specified Projector document with a new name provided in the request.Â
Request Format
- PwsRenameDocument
- serviceRequest: PwsRenameDocumentRq
- RequestId: Int32
- SessionTicket: String
- DocumentIdentity: PwsDocumentRef
- NewDocumentName: String (260)
- serviceRequest: PwsRenameDocumentRq
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 that is to be renamed. Click here for more information. | |||
NewDocumentName | String (260) | Yes | This is the new name of the specified document. The file extension must be included. | Changed using WS.docx |
Request Usage Example(s)
Response Format
- PwsRenameDocumentResponse
- PwsRenameDocumentResult: PwsRenameDocumentRs
- Messages: PwsMessage[]
- ResponseId: Int32
- Status: RequestStatus
- ServerTimestampUtc: DateTime
- DocumentIdentity: PwsDocumentRef
- PwsRenameDocumentResult: PwsRenameDocumentRs
Response Elements
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 here for more information. | Ok | |
ServerTimestampUtc | DateTime | Click here for more information. | 2018-03-20T13:33:31.3991044Z |
DocumentIdentity | The identity of the document that has been renamed. Click here for more information. |
Response Usage Example(s)
PwsRenameDocument - 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. |