Maestras

En esta sección, detallaremos los servicios disponibles para consultar información de las entidades maestras en la API REST de Arrendasoft®

Propiedades / Listar Estados

Permite obtener una lista de elementos, donde cada elemento contiene la información de cada estado posible que puede tener una propiedad.

Endpoint: https://{{instancia}}.arrendasoft.co/service/v2/public/masters/properties/states

{{instancia}}: Hace referencia a la instancia de cada inmobiliaria.

Petición

Método GET
Content-Type application/json
Authorization Bearer token, Token obtenido al consumir el servicio Login

Respuesta

Lista de elementos, donde cada elemento contiene la información de cada uno de los estados.

[
    {
        "id": 1,
        "estado": "Activa"
    },
    {
        "id": 0,
        "estado": "Arrendada"
    },
    {
        "id": 2,
        "estado": "Inactiva"
    },
    {
        "id": 3,
        "estado": "Vendida"
    }
]

Tabla con la descripción de cada campo del JSON

Clave Descripción
id Identificador único del estado
estado Descripción del estado

Propiedades / Listar Clases de Inmueble

Permite obtener una lista de elementos, donde cada elemento contiene la información de cada clase de inmueble posible que puede tener una propiedad.

Endpoint: https://{{instancia}}.arrendasoft.co/service/v2/public/masters/properties/property-classes

{{instancia}}: Hace referencia a la instancia de cada inmobiliaria.

Petición

Método GET
Content-Type application/json
Authorization Bearer token, Token obtenido al consumir el servicio Login

Respuesta

Lista de elementos, donde cada elemento contiene la información de cada una de las clases de inmueble.

[
    {
        "id": "1367",
        "clase": "Amoblados"
    },
    {
        "id": "1253",
        "clase": "Apartaestudio"
    },
    {
        "id": "1247",
        "clase": "Apartamento"
    },
    {
        "id": "1248",
        "clase": "Bodega"
    },
    {
        "id": "1249",
        "clase": "Casa"
    },
]

Tabla con la descripción de cada campo del JSON

Clave Descripción
id Identificador único de la clase de inmueble
clase Descripción de la clase de inmueble

Propiedades / Listar Tipos de Servicios

Permite obtener una lista de elementos, donde cada elemento contiene la información de cada tipo de servicio que puede tener una propiedad.

Endpoint: https://{{instancia}}.arrendasoft.co/service/v2/public/masters/properties/service-types

{{instancia}}: Hace referencia a la instancia de cada inmobiliaria.

Petición

Método GET
Content-Type application/json
Authorization Bearer token, Token obtenido al consumir el servicio Login

Respuesta

Lista de elementos, donde cada elemento contiene la información de cada uno de los tipos de servicios.

[
    {
        "id": "arriendo",
        "servicio": "Arriendo"
    },
    {
        "id": "venta",
        "servicio": "Venta"
    },
    {
        "id": "venta y arriendo",
        "servicio": "Venta y Arriendo"
    }
]

Tabla con la descripción de cada campo del JSON

Clave Descripción
id Identificador único del servicio
servicio Descripción del servicio

Propiedades / Listar Características

Permite obtener una lista de elementos, donde cada elemento contiene la información de cada característica que puede tener una propiedad.

Endpoint: https://{{instancia}}.arrendasoft.co/service/v2/public/masters/properties/features

{{instancia}}: Hace referencia a la instancia de cada inmobiliaria.

Petición

Método GET
Content-Type application/json
Authorization Bearer token, Token obtenido al consumir el servicio Login

Respuesta

Lista de elementos, donde cada elemento contiene la información de cada una de las características.

[
    {
        "id": "1",
        "descripcion": "Nº De Habitaciones",
        "tipo_campo": "numeric",
        "opciones_valores": null,
        "opciones_descripciones": null,
        "orden": "1",
        "grupo": "Características del inmueble",
        "clase_inmueble_id": "1367",
        "clase_inmueble": "Amoblados"
    },
    {
        "id": "2",
        "descripcion": "Nº De Baños",
        "tipo_campo": "numeric",
        "opciones_valores": null,
        "opciones_descripciones": null,
        "orden": "2",
        "grupo": "Características del inmueble",
        "clase_inmueble_id": "1367",
        "clase_inmueble": "Amoblados"
    },
    {
        "id": "54",
        "descripcion": "Oficina",
        "tipo_campo": "checkbox",
        "opciones_valores": "",
        "opciones_descripciones": "",
        "orden": "3",
        "grupo": "Características del Inmueble",
        "clase_inmueble_id": "1248",
        "clase_inmueble": "Bodega"
    },
    {
        "id": "13",
        "descripcion": "Baño Auxiliar",
        "tipo_campo": "checkbox",
        "opciones_valores": null,
        "opciones_descripciones": null,
        "orden": "4",
        "grupo": "Características del Inmueble",
        "clase_inmueble_id": "1249",
        "clase_inmueble": "Casa"
    },
    {
        "id": "38",
        "descripcion": "Parqueadero",
        "tipo_campo": "select",
        "opciones_valores": "propio,visitantes",
        "opciones_descripciones": "Propio,Visitantes",
        "orden": "12",
        "grupo": "Características del Inmueble",
        "clase_inmueble_id": "1249",
        "clase_inmueble": "Casa"
    },
]

Tabla con la descripción de cada campo del JSON

Clave Descripción
id Identificador único de la característica
descripcion Descripción de la característica
tipo_campo Tipo de campo (ej. select, checkbox, numeric, etc.)
opciones_valores Valores posibles para el campo, separados por coma
opciones_descripciones Descripciones de las opciones, separadas por coma
orden Orden en que aparece el campo
grupo Grupo al que pertenece el campo
clase_inmueble_id Identificador de la clase de inmueble
clase_inmueble Tipo o clase de inmueble

Propiedades / Listar Características por Clase de Inmueble

Permite obtener una lista de elementos, donde cada elemento contiene la información de cada característica que puede tener una propiedad, filtrado por clase de inmueble.

Endpoint: https://{{instancia}}.arrendasoft.co/service/v2/public/masters/properties/features/property-class/{{id}}

{{instancia}}: Hace referencia a la instancia de cada inmobiliaria.

Petición

Método GET
Content-Type application/json
Authorization Bearer token, Token obtenido al consumir el servicio Login
Parámetro {{id}}, corresponde al Identificador único de la clase de inmueble

Respuesta

Lista de elementos, donde cada elemento contiene la información de cada una de las características.

[
    {
        "id": "1",
        "descripcion": "Nº De Habitaciones",
        "tipo_campo": "numeric",
        "opciones_valores": null,
        "opciones_descripciones": null,
        "orden": "1",
        "grupo": "Características del Inmueble",
        "clase_inmueble_id": "1249",
        "clase_inmueble": "Casa"
    },
    {
        "id": "31",
        "descripcion": "Red de gas",
        "tipo_campo": "select",
        "opciones_valores": "si,no",
        "opciones_descripciones": "Si,No",
        "orden": "5",
        "grupo": "Características del Inmueble",
        "clase_inmueble_id": "1249",
        "clase_inmueble": "Casa"
    },
    {
        "id": "22",
        "descripcion": "Balcón",
        "tipo_campo": "checkbox",
        "opciones_valores": null,
        "opciones_descripciones": null,
        "orden": "10",
        "grupo": "Características del Inmueble",
        "clase_inmueble_id": "1249",
        "clase_inmueble": "Casa"
    },
    {
        "id": "38",
        "descripcion": "Parqueadero",
        "tipo_campo": "select",
        "opciones_valores": "propio,visitantes",
        "opciones_descripciones": "Propio,Visitantes",
        "orden": "12",
        "grupo": "Características del Inmueble",
        "clase_inmueble_id": "1249",
        "clase_inmueble": "Casa"
    }
]

Tabla con la descripción de cada campo del JSON

Clave Descripción
id Identificador único de la característica
descripcion Descripción de la característica
tipo_campo Tipo de campo (ej. select, checkbox, numeric, etc.)
opciones_valores Valores posibles para el campo, separados por coma
opciones_descripciones Descripciones de las opciones, separadas por coma
orden Orden en que aparece el campo
grupo Grupo al que pertenece el campo
clase_inmueble_id Identificador de la clase de inmueble
clase_inmueble Tipo o clase de inmueble