GET api/iXpert?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&RequestAreaBitMap={RequestAreaBitMap}&FindUsing={FindUsing}&CompanyKey={CompanyKey}&ResidentKey={ResidentKey}&ActiveRecords={ActiveRecords}
Get requested inforamtion for request
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
VendorID | string |
Required |
|
VendorPassword | string |
Required |
|
APIGUID | string |
Required |
|
RequestAreaBitMap |
1: Agenda (24) 2: Architectural (3) 4: Compliance (5) 8: Company Note (0) 16: Company Insurance (37) 32: Lease (35) 64: Payment Plan (33) 128: Account Notes (6) 256: Account Registration (1) 512: Vendor Insurance (2) 1024: Work Order (27) 2048: Work Order Tasks (36) 4096: Property Documents (25) 8192: Company Tasks (9) 16384: AR (29) 32768: Bank Transactions (38) 65536: ArchitecturalTask (8) 131072: Unused 262144: ResidentTask (7) 524288: Work Order Note (28) 1048576: AR Adjustment (13) 2097152: AR Financial (21) 4194304: AR Collection (12) 8388608: FAQ (23) 16777216: AP (4) 33554432: AP Note (26) 67108864: AP Task (11) 134217782: AP Financial (22) 268435456: GL (32) 536870912: GL Adjustment (16) 1073741824: GL Financial (20) 2147483648: Bank Statement (17) 4294967296: Web Documents (18) 8589934592: Vendor Web Documents (19) |
integer |
Required |
FindUsing |
Key elements to locate records, seperated by ; semicolon, example: architectural;form |
string |
Required |
CompanyKey |
CompanyKey to filter returned data |
integer |
Required |
ResidentKey |
Resident to filter |
integer |
Required |
ActiveRecords |
Resident to filter |
boolean |
Required |
Body Parameters
None.
Response Information
Resource Description
HttpResponseMessageName | 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. |