> ## 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 supplier contracts
> Get all non-removed real estate objects used in the requested supplier contract. Either reference or externalIdentifier must have a value. If both are given, both are used for retrieving the real estate objects of the supplier contract.
## OpenAPI
````json GET /api/v1/contracts/supplier/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/supplier/realestateobjects": {
"get": {
"tags": [
"SupplierContracts"
],
"summary": "Get real estate objects of a supplier contracts",
"description": "Get all non-removed real estate objects used in the requested supplier contract. Either reference or externalIdentifier must have a value. If both are given, both are used for retrieving the real estate objects of the supplier contract.",
"operationId": "GetSupplierContractRealEstateObjects",
"parameters": [
{
"name": "reference",
"in": "query",
"description": "The internal identifier of the model (i.e. Reference, Code, Name, depends on model). When given 'relationReference' should also be given",
"schema": {
"type": "string"
}
},
{
"name": "relationReference",
"in": "query",
"description": "The internal identifier of the contract's relation. Required when 'reference' is given.",
"schema": {
"maxLength": 100,
"minLength": 0,
"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/PurchaseContractRealEstateObject"
}
}
}
}
}
},
"x-d360-narrative-url": "Get real estate objects of a supplier contracts
This endpoint retrieves the real estate objects currently linked to a finalised supplier contract, excluding any objects that have since been removed from the contract.
A developer calls this endpoint to find out which real estate objects are covered by a specific finalised supplier contract, for example to check which properties a security or maintenance agreement applies to.
Request Fields
Field | Type | Required | Description |
|---|
reference | string | No | The reference of the contract as generated by Bloxs. Either reference or externalIdentifier must be given. When reference is given, relationReference must also be given. Passed as a query parameter. |
relationReference | string | No | The reference of the supplier the contract belongs to. Required when reference is given. Maximum length 100 characters. Passed as a query parameter. |
externalIdentifier | string | No | The identifier of the contract within the system of the requesting party. This identifier is not generated by Bloxs. Either reference or externalIdentifier must be given. Passed as a query parameter. |
Response Fields
Field | Type | Required | Description |
|---|
purchaseContractReference | string | No | The reference of the contract as generated by Bloxs. Maximum length 100 characters. |
purchaseContractExternalIdentifier | string | No | The identifier of the contract within the system of 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. |