/
PwsGetDocumentManagementParameters

PwsGetDocumentManagementParameters

Owned by Bettina Borces
Last updated: Jan 30, 2025

Overview


This web service retrieves an installation's document management parameters (PwsDocumentManagementParameters).


Rate Limiting

In order to protect our servers from inadvertent service overuse or intentional attack, and to fairly distribute services to all our customers, we have implemented a rate limiting algorithm.  When fully deployed, this new algorithm will cause services to either succeed with new warnings or fail with new errors when services are consumed at too high a rate.  Programs that consume Projector services should be enhanced to handle rate limiting errors so that they can continue functioning properly.  For more information please visit: Projector Rate Limiting Behavior.


Request Format


PwsGetDocumentManagementParameters Request
  • PwsGetDocumentManagementParameters

Request Elements


Element

Data Type

Required?

Description

Sample Data

RequestId

Int32

No

Click here for more information

1

SessionTicket

String

Yes 

Click here for more information

AZZNMfO8vxeYuc3WXDkixw==

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/">
   <soapenv:Header/>
   <soapenv:Body>
      <pws:PwsGetDocumentManagementParameters>
         <pws:serviceRequest>
            <req:RequestId>1</req:RequestId>
            <req:SessionTicket>AZZNMfO8vxeYuc3WXDkixw==</req:SessionTicket>
         </pws:serviceRequest>
      </pws:PwsGetDocumentManagementParameters>
   </soapenv:Body>
</soapenv:Envelope>

Response Format


PwsGetDocumentManagementParameters 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

1 

Status

RequestStatus

Click here for more information

Ok

ServerTimestampUtc

DateTime

Click here for more information

2018-03-16T14:24:21.9532919Z

Parameters

PwsDocumentManagementParameters

The document management parameters for this installation


Response Usage Example(s)


Example 01 
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsGetDocumentManagementParametersResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsGetDocumentManagementParametersResult 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/">1</ResponseId>
            <Status xmlns="http://projectorpsa.com/CommonServices/">Ok</Status>
            <ServerTimestampUtc xmlns="http://projectorpsa.com/CommonServices/">2018-03-16T14:24:21.9532919Z</ServerTimestampUtc>
            <a:Parameters>
               <a:DocumentServerUrl>https://docqa.projectorpsa.com/1</a:DocumentServerUrl>
               <a:InstanceIdentifier>1</a:InstanceIdentifier>
            </a:Parameters>
         </PwsGetDocumentManagementParametersResult>
      </PwsGetDocumentManagementParametersResponse>
   </s:Body>
</s:Envelope>

PwsGetDocumentManagementParameters - Common Errors and Warnings