Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

This web service sets the status of existing document archiveĀ (PwsDocumentArchiveRef).

Request Format

Panel
titlePwsSetArchiveStatus Request

...

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==

ArchiveStatus

String

Yes


The new status of the archive:

"A" for Accepted

"D" for Downloaded

"E" for Expired"X" for Deleted

D

DocumentArchiveIdentity

PwsDocumentArchiveRef

Yes


The identity of the document archive. Click here for more information.


...

ErrorNumberErrorCodeErrorText
21028DocumentArchiveRequiredForSetArchiveStatusA document archive identity must be specified.
21029DocumentArchiveStatusInvalidThe specified document archive status is invalid. Valid values are A for Accepted, D for Downloaded, and E for Expired and X for Deleted.
75238DocumentArchiveNotFoundSpecified document archive not found.
75242InvalidValueForArchiveStatusInvalid value specified for archive status. Valid values are A for accepted, D for downloaded or E for expired.