GET api/tenantreferencing/products

Gets the available products for tenant referencing Processes this tenant referencing API request. The parameter and response sections describe the data exchanged with the API.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

HomeLetProductDataContract

Collection of HomeLetProductDataContract

Name	Description	Type	Additional information
productId	The unique identifier of the related product resource.	integer	None.
name	The name value.	string	None.
description	The description value.	string	None.
hasRentGuarantee	Indicates whether this item has rend guarantee.	boolean	None.
productCode	The product code value.	string	None.
hasFinancialReference	Indicates whether this item has financial reference.	boolean	None.
hasLettingReference	Indicates whether this item has lettings reference.	boolean	None.
hasUnknownResidentialStatus	Indicates whether this item has unknown residential status.	boolean	None.
hasUnknownEmploymentStatus	Indicates whether this item has unknown employment status.	boolean	None.
international	Indicates whether international is true.	boolean	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "productId": 1,
    "name": "sample string 2",
    "description": "sample string 3",
    "hasRentGuarantee": true,
    "productCode": "sample string 5",
    "hasFinancialReference": true,
    "hasLettingReference": true,
    "hasUnknownResidentialStatus": true,
    "hasUnknownEmploymentStatus": true,
    "international": true
  },
  {
    "productId": 1,
    "name": "sample string 2",
    "description": "sample string 3",
    "hasRentGuarantee": true,
    "productCode": "sample string 5",
    "hasFinancialReference": true,
    "hasLettingReference": true,
    "hasUnknownResidentialStatus": true,
    "hasUnknownEmploymentStatus": true,
    "international": true
  }
]