> ## Documentation Index
> Fetch the complete documentation index at: https://www.bloxs.io/llms.txt
> Use this file to discover all available pages before exploring further.
# Get real estate objects of a private rent contracts
> Get all non-removed real estate objects used in the requested private rent contract. Either reference or externalIdentifier must have a value. If both are given, both are used for retrieving the real estate objects of the private rent contract.
## OpenAPI
````json GET /api/v1/contracts/privaterent/realestateobjects
{
"openapi": "3.0.4",
"info": {
"title": "Concept SalesContracts V1",
"description": "Welcome to BETA version of the new Sales Concept Contracts API - intended for client public testing before the launch of the final version. During this BETA phase, we'll be improving the API based on specific client's feedbacks.",
"version": "v1"
},
"security": [
{}
],
"tags": [
{
"name": "CommercialRentContracts"
},
{
"name": "Concept CommercialRent"
},
{
"name": "Concept PrivateRent"
},
{
"name": "GeneralSalesContracts"
},
{
"name": "Metadata"
},
{
"name": "PrivateRentContracts"
},
{
"name": "SupplierContracts"
}
],
"paths": {
"/api/v1/contracts/privaterent/realestateobjects": {
"get": {
"tags": [
"PrivateRentContracts"
],
"summary": "Get real estate objects of a private rent contracts",
"description": "Get all non-removed real estate objects used in the requested private rent contract. Either reference or externalIdentifier must have a value. If both are given, both are used for retrieving the real estate objects of the private rent contract.",
"operationId": "GetPrivateRentContractRealEstateObjects",
"parameters": [
{
"name": "reference",
"in": "query",
"description": "The internal identifier of the model (i.e. Reference, Code, Name, depends on model).",
"schema": {
"type": "string"
}
},
{
"name": "externalIdentifier",
"in": "query",
"description": "The external API identifier of the model.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SalesContractRealEstateObject"
}
}
}
}
}
},
"x-d360-narrative-url": "Get real estate objects of a private rent contracts
Retrieves all real estate objects currently linked to a finalized residential lease contract, excluding any objects that have been removed from the contract.
A developer calls this endpoint to see which objects a contract applies to, for example when a single contract covers more than one unit.
Either the contract's reference or its external identifier must be supplied to identify the contract.
Request Fields
Field | Type | Required | Description |
|---|
reference | string | No | The reference of the residential lease contract, as generated by Bloxs. |
externalIdentifier | string | No | The external identifier of the residential lease contract, assigned by the requesting party. This identifier is not generated by Bloxs. |
Response Fields
Field | Type | Required | Description |
|---|
salesContractReference | string | No | The reference of the residential lease contract, as generated by Bloxs. Maximum length 100 characters. |
salesContractExternalIdentifier | string | No | The external identifier of the residential lease contract, assigned by the requesting party. Maximum length 100 characters. |
realEstateObjectReference | string | No | The reference of the real estate object linked to the contract, as generated by Bloxs. Maximum length 100 characters. |
startDate | string (date-time) | Yes | The date from which this real estate object is linked to the contract. May fall within the contract's overall period, since an object can be active for the full contract period or only part of it. ISO 8601 date-time format. |
endDate | string (date-time) | No | The date until which this real estate object is linked to the contract. Empty when the object remains linked for the remainder of the contract. ISO 8601 date-time format. |