Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 5 Next »

Overview

This web service sets the status of existing document archive. 

Request Format

PwsSetArchiveStatus Request

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

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.


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:PwsSetArchiveStatus>
         <pws:serviceRequest>
            <req:SessionTicket>AftyRXSTlnMPzozuKwq0kQ==</req:SessionTicket>
            <doc:ArchiveStatus>D</doc:ArchiveStatus>
            <doc:DocumentArchiveIdentity>
               <com:DocumentArchiveUid>1152921504606847217</com:DocumentArchiveUid>
            </doc:DocumentArchiveIdentity>
         </pws:serviceRequest>
      </pws:PwsSetArchiveStatus>
   </soapenv:Body>
</soapenv:Envelope>


Response Format

PwsSetArchiveStatus Response

Response Elements

Element

Data Type

Description

Sample Data

Messages

PwsMessage

The web service response status and message. Click here for more information.


ResponseId

Int32

Click here for more information.

0

Status

RequestStatus

Click here for more information.

Ok

ServerTimestampUtc

DateTime

Click here for more information.

2018-03-20T13:33:31.3991044Z

Response Usage Example(s)


Example 01
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsSetArchiveStatusResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsSetArchiveStatusResult 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-21T17:26:11.0042256Z</ServerTimestampUtc>
         </PwsSetArchiveStatusResult>
      </PwsSetArchiveStatusResponse>
   </s:Body>
</s:Envelope>


Common Errors and Warnings

ErrorNumberErrorCodeErrorText
21028DocumentArchiveRequiredForSetArchiveStatusA document archive identity must be specified.
21029DocumentArchiveStatusInvalidThe specified document archive status is invalid. Valid values are A for Accepted, D for Downloaded, E for Expired and X for Deleted.
  • No labels