Overview
Request Format
PwsSetArchiveStatus Request
- PwsSetArchiveStatus
- serviceRequest: PwsSetArchiveStatusRq
- RequestId: Int32
- SessionTicket: String
- ArchiveStatus: String
- DocumentArchiveIdentity: PwsDocumentArchiveRef
- serviceRequest: PwsSetArchiveStatusRq
Request Elements
Element | Data Type | Required? | Default | Description | Sample Data |
|---|---|---|---|---|---|
RequestId | Int32 |
|
| Click here for more information. |
|
SessionTicket | String |
|
| Click here for more information. |
|
ArchiveStatus | String |
|
| Valid values are A for Accepted, D for Downloaded, E for Expired and X for Deleted. |
|
DocumentArchiveIdentity |
|
|
|
|
Request Usage Example(s)
Response Format
Response Elements
Response Usage Example(s)
Common Errors and Warnings
- For all errors and warnings please refer to the Complete List of Errors and Warnings
| ErrorNumber | ErrorCode | ErrorText |
|---|---|---|
| 21028 | DocumentArchiveRequiredForSetArchiveStatus | A document archive identity must be specified. |
| 21029 | DocumentArchiveStatusInvalid | The specified document archive status is invalid. Valid values are A for Accepted, D for Downloaded, E for Expired and X for Deleted. |