GET api/Documents?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&DocumentArea={DocumentArea}&DocumentKey={DocumentKey}&ResidentContactKey={ResidentContactKey}&Imagebit={Imagebit}
Get
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| VendorID | string |
Required |
|
| VendorPassword | string |
Required |
|
| APIGUID | string |
Required |
|
| DocumentArea |
Requested document area Architectural = 1 Compliance = 2 |
integer |
Required |
| DocumentKey |
Parent key of document |
integer |
Required |
| ResidentContactKey | integer |
Required |
|
| Imagebit |
Use imagebit to determine types of thumbnailes to include in returned base64 1: Image types of BMP|GIF|JPG|JPEG|PNG|TIFF 2: MP3|WAV 4: MP4 8: PDF 16: Office types of EML|MSG|XLS|PPT|DOC 32: Standard documents of TXT|RTF |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
HttpResponseMessage| Name | Description | Type | Additional information |
|---|---|---|---|
| Version | Version |
None. |
|
| Content | HttpContent |
None. |
|
| StatusCode | HttpStatusCode |
None. |
|
| ReasonPhrase | string |
None. |
|
| Headers | Collection of Object |
None. |
|
| RequestMessage | HttpRequestMessage |
None. |
|
| IsSuccessStatusCode | boolean |
None. |