GET api/progression/lettings/{tenantRoleId}/getguarantors
Get Guarantors. Processes this lettings progression API request. The parameter and response sections describe the data exchanged with the API.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| tenantRoleId |
The unique identifier of the tenant role resource. |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
The response returned after the operation completes.
Collection of GuarantorDataContract| Name | Description | Type | Additional information |
|---|---|---|---|
| GroupMembers |
The collection of group members. |
Collection of PersonDataContract |
None. |
| TenantIds |
The unique identifiers of the related tenant resources. |
Collection of integer |
None. |
| References |
The collection of references. |
Collection of ReferenceDataContract |
None. |
| DeedSigned |
Indicates whether deed signed is true. |
boolean |
None. |
| Relationship |
The relationship value. |
string |
None. |
| Documents |
The collection of documents. |
Collection of DocumentDataContract |
None. |
| GroupId |
The unique identifier of the related group resource. |
integer |
None. |
| Group |
The group value. |
PeopleGroupDataContract |
None. |
| GroupRoleId |
The unique identifier of the related group role resource. |
integer |
None. |
| Id |
The unique identifier of this resource. |
integer |
None. |
Response Formats
application/json
Sample:
Sample not available.
text/json
Sample:
Sample not available.