POST api/tenantreferencing/addguarantor/{caseId}/{tenancyRoleId}/{personId}
Adds a Guarantor to a tenancy referencing application for a case using the details supplied
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
caseId |
The id of the case to add the Guarantor to. |
string |
Required |
tenancyRoleId |
The role id of the tenancy the case is linked to. |
integer |
Required |
personId |
The id of the individual the application is for. |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
HomeLetApplicationDataContract
Dezrez.Core.DataContracts.External.Api.TenantReferencing.HomeLetApplicationDataContractName | Description | Type | Additional information |
---|---|---|---|
applicationId | string |
None. |
|
productId | integer |
None. |
|
title | string |
None. |
|
firstName | string |
None. |
|
lastName | string |
None. |
|
string |
None. |
||
birthDate | string |
None. |
|
employmentStatus | integer |
None. |
|
residentialStatus | integer |
None. |
|
grossIncome | decimal number |
None. |
|
hasCCJ | boolean |
None. |
|
bankAccount | Dezrez.Core.DataContracts.External.Api.TenantReferencing.HomeLetBankAccountDataContract |
None. |
|
isRentPaidInAdvance | boolean |
None. |
|
rentShare | decimal number |
None. |
|
completionMethod | integer |
None. |
|
signaturePreference | integer |
None. |
|
canEmploymentChange | boolean |
None. |
|
canContactApplicantByPhoneAndPost | boolean |
None. |
|
canContactApplicantBySMSAndEmail | boolean |
None. |
|
channel | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "applicationId": "sample string 1", "productId": 2, "title": "sample string 3", "firstName": "sample string 4", "lastName": "sample string 5", "email": "sample string 6", "birthDate": "sample string 7", "employmentStatus": 8, "residentialStatus": 9, "grossIncome": 10.1, "hasCCJ": true, "bankAccount": { "accountNumber": "sample string 1", "accountSortcode": "sample string 2" }, "isRentPaidInAdvance": true, "rentShare": 13.1, "completionMethod": 14, "signaturePreference": 15, "canEmploymentChange": true, "canContactApplicantByPhoneAndPost": true, "canContactApplicantBySMSAndEmail": true, "channel": "sample string 19" }