...
| Panel | ||
|---|---|---|
| ||
|
Request Elements
Element | Data Type | Required? | Default | Description | Sample Data |
|---|---|---|---|---|---|
RequestId | Int32 | No |
Click here for more information. | 1 | |
SessionTicket | String | Yes |
Click here for more information. | AZZNMfO8vxeYuc3WXDkixw== | ||
FolderIdentity | Yes |
The folder identity |
IncludeDeletedDocumentsFlag | Boolean | No | false | If set to 'true', documents that have been deleted will be included in the response | true |
IncludeNotesFlag | Boolean | No | false | If set to 'true', |
notes will be included in the response |
true |
Request Usage Example(s)
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<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:PwsGetFolderContents>
<pws:serviceRequest>
<req:RequestId>1</req:RequestId>
<req:SessionTicket>AZZNMfO8vxeYuc3WXDkixw==</req:SessionTicket>
<doc:FolderIdentity>
<com:FolderUid>1152921504607349085</com:FolderUid>
</doc:FolderIdentity>
<doc:IncludeDeletedDocumentsFlag>true</doc:IncludeDeletedDocumentsFlag>
<doc:IncludeNotesFlag>true</doc:IncludeNotesFlag>
</pws:serviceRequest>
</pws:PwsGetFolderContents>
</soapenv:Body>
</soapenv:Envelope> |
...
| Panel | ||
|---|---|---|
| ||
|
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 | 1 |
Status | Click here for more information |
ServerTimestampUtc | DateTime | Click here for more information | 2018-03-16T17:37:44.8271491Z |
Folder | The complete details of the folder and the folder contents |
Response Usage Example(s)
...
- For all errors and warnings please refer to the Complete List of Errors and Warnings
ErrorNumber | ErrorCode | ErrorText |
|---|---|---|
| 21001 | FolderRequiredForGetFolderContents | A folder identity must be specified. |
| 75205 | FolderNotFound | Folder not found. |