POST FilingsApi/DocumentsList
Request Information
URI Parameters
None.
Body Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| SessionId |
Session GUID |
string |
Required |
| Id |
Id |
long |
Optional |
| FilingId |
Filing Id |
long |
Required |
| FilerEmailAddress |
Filer Email address |
string |
Required |
| FilterMember |
Sort Filter Member |
string |
Optional |
| FilterOperator |
Sort Filter Operator like StartsWith, Contians, IsEqualTo etc., |
string |
Optional |
| FilterValue |
Sort Filter Value |
string |
Optional |
| OrderBy |
Order By column name |
string |
Optional |
| OrderByDirection |
Order By Direction like Asc or Desc |
string |
Optional |
| PageNumber |
Page Number |
integer |
Optional |
| PageSize |
Page Size |
integer |
Optional |
| FilterMember |
Sort Filter Member |
string |
Optional |
| FilterOperator |
Sort Filter Operator like StartsWith, Contians, IsEqualTo etc., |
string |
Optional |
| FilterValue |
Sort Filter Value |
string |
Optional |
| OrderBy |
Order By column name |
string |
Optional |
| OrderByDirection |
Order By Direction like Asc or Desc |
string |
Optional |
| PageNumber |
Page Number |
integer |
Optional |
| PageSize |
Page Size |
integer |
Optional |
Request Formats
application/json, text/json
Sample:
{
"SessionId":"11d0fe6b-c9da-432a-91ea-34606c36e29d",
"FilingId":17523
}
Response Information
Response Formats
application/json, text/json
Sample:
[
{
"Id": 33728,
"IsRequired": true,
"IsLeadDocument": false,
"Category": "Lead Document",
"DocumentName": "",
"DocumentDescription": null,
"Pages": 0,
"Size": 0,
"Path": null,
"IsGoodPDF": false,
"IsSearchablePDF": false,
"CreateDate": "2018-02-19T09:21:43",
"DocumentId": 0,
"DocumentTypeCode": "10074",
"FilingComponentCode": "332",
"FilingComponentName": "Lead Document",
"FilingCode": null,
"FilingId": 0,
"SubmissionId": 0,
"EnvelopeId": null,
"DocumentTypeName": "Does not contain sensitive data",
"EncodedDocumentName": "",
"Display_DocCatNType": "Lead Document/ Does not contain sensitive data",
"HasInvalidFonts": false,
"HasSecurity": false,
"HasCorrectedFonts": false,
"PageWidth": 0,
"PageHeight": 0,
"WebUrl": null,
"ReturnWebUrl": null,
"ClioClientId": null,
"ClioAppSecert": null,
"ClioRedirectUrl": null
}
]