[PREVIEW] Get an existing private rent contract. Either reference or externalIdentifier must have a value. If both are given, both are used for retrieving the private rent contract.
Description
Retrieve the information currently known in the Bloxs database about a certain finalized private rent contract. Either reference or externalIdentifier must have a value. Please note that if both identifiers are given, both must match; otherwise, an error message will be generated. It is recommended that the user utilizes only one identifier, with a preference for the reference.
Private rent contracts concern the finalized contracts, which is essentially different from the 'ConceptPrivateRent' endpoints which relate to the concept contracts. Private rent contracts pertains to contracts concerning real estate objects in the private sector.
Please note that it is currently not possible to finalize a contract through the Bloxs api's. If a private rent contract is created using the POST operation, it will first need to be finalized in the Bloxs application before it can be retrieved through this GET operation.
Use Case
Upon finalizing the contract in the Bloxs application, the user wants to retrieve the most important details of the contract in a third party application.
Request fields
The request contains the following fields:
| Field | Description |
|---|---|
| reference | The reference of the contract as generated by Bloxs. |
| externalIdentifier | The unique identifier of the contract within the system of the requesting party. This identifier is not generated by the Bloxs system. |
Response fields
The 200 response contains the fields in the table below. For the GET operation it gives an up-to-date insight in the data that is currently registered in Bloxs.
| Field | Description |
|---|---|
| reference | The reference of the contract as generated by Bloxs. |
| externalIdentifier | The unique identifier of the contract within the system of the requesting party. This identifier is not generated by the Bloxs system. |
| ownerReference | This pertains to the reference of the owner of the object which is subject of the contract. Please note, a reference must be included here. |
| relationReference | This pertains to the primary tenant who is financially responsible. Please note, a reference must be included here. |
| extraRelationReferences | |
| startDate | |
| endDate | |
| automaticExtends | |
| noticeDate | |
| noticePeriod | |
| lastModified |
Please enter a valid token
The internal identifier of the model (i.e. Reference, Code, Name, depends on model).
The external API identifier of the model.
OK
The requested private rent contract was not found.