GET api/ResidentSummary?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&SSOPosition={SSOPosition}&SSOGUID={SSOGUID}
Retrieves resident data. If no SSO passed, then use only the ResidentContact key for the resident APIGUID
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| VendorID | string |
Required |
|
| VendorPassword | string |
Required |
|
| APIGUID | string |
Required |
|
| SSOPosition |
SSO field position for validation, pass 0 for primary SSO field, or 1-6 if client gives a specific SSO field position |
integer |
Required |
| SSOGUID |
SSO GUID to retrieve resident contact summary data |
string |
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. |