ImmobiNet
ImmobiNet API Docs - Properties

Residences (a hotel, a residence, a building...). A residence collects the properties (units) that belong to the same structure: property_ids lists them, and each of them gives its residence in residence_id. A property can belong to no residence. A residence has its own type, address, descriptions, attachments and facilities, those of the structure as a whole: read them here once instead of repeating them on every property.


Get list of residences

GET
/api/v1/residences
basic

Returns a paginated list of residences, ordered by id ascending (follow _pagination.next_cursor). Requires the API key scope properties:read.

Get list of residences › query Parameters

search_name
​string

Search residences by name

codes
​string[] · style: form

Only the residences with these codes, the ones shown as code (exact match, case-insensitive), comma-separated (codes=A1,B2). At most 50 values, more returns 400. No match gives an empty list; an empty value is the same as no filter. The code is not guaranteed to be unique, so a code can match more than one residence.

Example: ["ALFA"]
paging_limit
​integer · min: 1 · max: 50

Limit items returned in response. Must be between 1 and 50

Default: 20
next_cursor
​string | null

Get list of residences › Responses

Get residences list

​object
​Residence[]

Get a residence

GET
/api/v1/residences/{residenceId}
basic

Requires the API key scope properties:read.

Get a residence › path Parameters

residenceId
​integer · required

Get a residence › Responses

Get a residence

id
​integer

Name of the residence to show. Residences are not translated yet, so it has one entry, in Italian (it); more languages will be added when they are. Always present.

code
​string

Code of the residence, always present. It is not guaranteed to be unique, so use id to refer to a residence. Use the codes query parameter of the list to find the residences with a code.

type
​string

Code of the type of the residence, as listed by GET /api/v1/residence-types (which also gives its name). Omitted when the residence has no type.

Example: residence
​object

Address. Every field can be null when it is not set (or not visible to the API user); depending on the resource a field without a value is null or left out of the response.

property_ids
​integer[]

Ids of the properties of the residence visible to the API user, in ascending order. Always present, empty when none is visible.

​object

Reserved for custom fields (key → value). Custom fields are not available for residences yet, so it is always an empty object.


Get descriptions of a residence

GET
/api/v1/residences/{residenceId}/descriptions
basic

Requires the API key scope properties:read.

Get descriptions of a residence › path Parameters

residenceId
​integer · required

Get descriptions of a residence › Responses

Get descriptions of a residence

language
​string · pattern: ^[a-z]{2}$

Language, as an ISO 639-1 code of two lowercase letters (it, en). It names the language only, with no region.

Example: it
text
​string

Get all attachments of a residence

GET
/api/v1/residences/{residenceId}/attachments
basic

Requires the API key scope properties:read.

Get all attachments of a residence › path Parameters

residenceId
​integer · required

Get all attachments of a residence › query Parameters

type
​string · enum

Only the attachments of this type: images (images that are not panoramic), panoramic_images or file (anything that is not an image). Omit to get all of them. Any other value returns 400.

Enum values:
images
panoramic_images
file

Get all attachments of a residence › Responses

Get all attachments of a residence

oneOf
Exactly one variant must match.

Decision Table

VariantMatching Criteria
type = object · attachment_type="file" · requires: id, mime_type, url
type = object · requires: id, mime_type, url +1 more
Properties for Variant 1:
id
​integer · required
mime_type
​string · required
url
​string · uri · required
attachment_type
​string · enum · required
Enum values:
file

Add an attachment to a residence

POST
/api/v1/residences/{residenceId}/attachments
basic

Needs the privilege to create and edit properties (immobili_crea) as well as the one to read them; without it 403. Requires the API key scope properties:write.

Add an attachment to a residence › path Parameters

residenceId
​integer · required

Add an attachment to a residence › Request Body

file
​binary · application/octet-stream · required
type
​string · required

Attachment type. Must be the code of an attachment type

visibility
​string[]
Enum values:
main
private
panoramic
note
​string

Add an attachment to a residence › Responses

Upload an attachment of a residence

oneOf
Exactly one variant must match.

Decision Table

VariantMatching Criteria
type = object · attachment_type="file" · requires: id, mime_type, url
type = object · requires: id, mime_type, url +1 more
Properties for Variant 1:
id
​integer · required
mime_type
​string · required
url
​string · uri · required
attachment_type
​string · enum · required
Enum values:
file

Get an attachment of a residence

GET
/api/v1/residences/{residenceId}/attachments/{attachmentId}
basic

Requires the API key scope properties:read.

Get an attachment of a residence › path Parameters

residenceId
​integer · required
attachmentId
​integer · required

Get an attachment of a residence › Responses

Get an attachment of a residence

oneOf
Exactly one variant must match.

Decision Table

VariantMatching Criteria
type = object · attachment_type="file" · requires: id, mime_type, url
type = object · requires: id, mime_type, url +1 more
Properties for Variant 1:
id
​integer · required
mime_type
​string · required
url
​string · uri · required
attachment_type
​string · enum · required
Enum values:
file

Delete an attachment of a residence

DELETE
/api/v1/residences/{residenceId}/attachments/{attachmentId}
basic

Needs the privilege to create and edit properties (immobili_crea) as well as the one to read them; without it 403. Requires the API key scope properties:delete.

Delete an attachment of a residence › path Parameters

residenceId
​integer · required
attachmentId
​integer · required

Delete an attachment of a residence › Responses

Attachment deleted


Get facilities of a residence

GET
/api/v1/residences/{residenceId}/facilities
basic

Requires the API key scope properties:read.

Get facilities of a residence › path Parameters

residenceId
​integer · required

Get facilities of a residence › Responses

Get facilities of a residence

A facility of a residence or of a property. It refers to the catalog `GET /api/v1/facilities` by `facility`, which also gives its name in every language.
facility
​string

Code of the facility in the catalog GET /api/v1/facilities (e.g. adatto_disabili).

status
​string · enum

Whether the facility is included (included), to be paid for (paid) or not allowed (prohibited).

Enum values:
included
paid
prohibited