# 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://<span style="color: rgb(241, 196, 15);">***{{instancia}}***</span>.arrendasoft.co/service/v2/public/masters/properties/states

**<span style="color: rgb(241, 196, 15);">{{instancia}}</span>:** Hace referencia a la instancia de cada inmobiliaria.

#### **Petición**

<table border="1" id="bkmrk-m%C3%A9todo-get-content-t" style="border-collapse: collapse; width: 100%; height: 124.781px;"><colgroup><col style="width: 50%;"></col><col style="width: 50%;"></col></colgroup><tbody><tr style="height: 29.7969px;"><td style="height: 29.7969px;">**Método**</td><td style="height: 29.7969px;">GET</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;">**Content-Type**</td><td style="height: 29.7969px;">application/json</td></tr><tr style="height: 35.3906px;"><td style="height: 35.3906px;">****Authorization****</td><td style="height: 35.3906px;">**Bearer token,** Token obtenido al consumir el servicio [Login](https://docs.arrendasoft.co/books/api-arrendasoft-v2/page/login "Login")</td></tr></tbody></table>

#### **Respuesta**

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

```json
[
    {
        "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

<table id="bkmrk-clave-descripci%C3%B3n-id"><thead><tr><th>Clave</th><th>Descripción</th></tr></thead><tbody><tr><td>id</td><td>Identificador único del estado</td></tr><tr><td>estado</td><td>Descripción del estado</td></tr></tbody></table>

# 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://<span style="color: rgb(241, 196, 15);">***{{instancia}}***</span>.arrendasoft.co/service/v2/public/masters/properties/property-classes

**<span style="color: rgb(241, 196, 15);">{{instancia}}</span>:** Hace referencia a la instancia de cada inmobiliaria.

#### **Petición**

<table border="1" id="bkmrk-m%C3%A9todo-get-content-t" style="border-collapse: collapse; width: 100%; height: 124.781px;"><colgroup><col style="width: 50%;"></col><col style="width: 50%;"></col></colgroup><tbody><tr style="height: 29.7969px;"><td style="height: 29.7969px;">**Método**</td><td style="height: 29.7969px;">GET</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;">**Content-Type**</td><td style="height: 29.7969px;">application/json</td></tr><tr style="height: 35.3906px;"><td style="height: 35.3906px;">****Authorization****</td><td style="height: 35.3906px;">**Bearer token,** Token obtenido al consumir el servicio [Login](https://docs.arrendasoft.co/books/api-arrendasoft-v2/page/login "Login")</td></tr></tbody></table>

#### **Respuesta**

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

```json
[
    {
        "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

<table id="bkmrk-clave-descripci%C3%B3n-id"><thead><tr><th>Clave</th><th>Descripción</th></tr></thead><tbody><tr><td>id</td><td>Identificador único de la clase de inmueble</td></tr><tr><td>clase</td><td>Descripción de la clase de inmueble</td></tr></tbody></table>

# 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://<span style="color: rgb(241, 196, 15);">***{{instancia}}***</span>.arrendasoft.co/service/v2/public/masters/properties/service-types

**<span style="color: rgb(241, 196, 15);">{{instancia}}</span>:** Hace referencia a la instancia de cada inmobiliaria.

#### **Petición**

<table border="1" id="bkmrk-m%C3%A9todo-get-content-t" style="border-collapse: collapse; width: 100%; height: 124.781px;"><colgroup><col style="width: 50%;"></col><col style="width: 50%;"></col></colgroup><tbody><tr style="height: 29.7969px;"><td style="height: 29.7969px;">**Método**</td><td style="height: 29.7969px;">GET</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;">**Content-Type**</td><td style="height: 29.7969px;">application/json</td></tr><tr style="height: 35.3906px;"><td style="height: 35.3906px;">****Authorization****</td><td style="height: 35.3906px;">**Bearer token,** Token obtenido al consumir el servicio [Login](https://docs.arrendasoft.co/books/api-arrendasoft-v2/page/login "Login")</td></tr></tbody></table>

#### **Respuesta**

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

```json
[
    {
        "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

<table id="bkmrk-clave-descripci%C3%B3n-id"><thead><tr><th>Clave</th><th>Descripción</th></tr></thead><tbody><tr><td>id</td><td>Identificador único del servicio</td></tr><tr><td>servicio</td><td>Descripción del servicio</td></tr></tbody></table>

# 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://<span style="color: rgb(241, 196, 15);">***{{instancia}}***</span>.arrendasoft.co/service/v2/public/masters/properties/features

**<span style="color: rgb(241, 196, 15);">{{instancia}}</span>:** Hace referencia a la instancia de cada inmobiliaria.

#### **Petición**

<table border="1" id="bkmrk-m%C3%A9todo-get-content-t" style="border-collapse: collapse; width: 100%; height: 124.781px;"><colgroup><col style="width: 50%;"></col><col style="width: 50%;"></col></colgroup><tbody><tr style="height: 29.7969px;"><td style="height: 29.7969px;">**Método**</td><td style="height: 29.7969px;">GET</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;">**Content-Type**</td><td style="height: 29.7969px;">application/json</td></tr><tr style="height: 35.3906px;"><td style="height: 35.3906px;">****Authorization****</td><td style="height: 35.3906px;">**Bearer token,** Token obtenido al consumir el servicio [Login](https://docs.arrendasoft.co/books/api-arrendasoft-v2/page/login "Login")</td></tr></tbody></table>

#### **Respuesta**

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

```json
[
    {
        "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

<table id="bkmrk-clave-descripci%C3%B3n-id"><thead><tr><th>Clave</th><th>Descripción</th></tr></thead><tbody><tr><td>`id`</td><td>Identificador único de la característica</td></tr><tr><td>`descripcion`</td><td>Descripción de la característica</td></tr><tr><td>`tipo_campo`</td><td>Tipo de campo (ej. select, checkbox, numeric, etc.)</td></tr><tr><td>`opciones_valores`</td><td>Valores posibles para el campo, separados por coma</td></tr><tr><td>`opciones_descripciones`</td><td>Descripciones de las opciones, separadas por coma</td></tr><tr><td>`orden`</td><td>Orden en que aparece el campo</td></tr><tr><td>`grupo`</td><td>Grupo al que pertenece el campo</td></tr><tr><td>`clase_inmueble_id`</td><td>Identificador de la clase de inmueble</td></tr><tr><td>`clase_inmueble`</td><td>Tipo o clase de inmueble</td></tr></tbody></table>

# 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://<span style="color: rgb(241, 196, 15);">***{{instancia}}***</span>.arrendasoft.co/service/v2/public/masters/properties/features/property-class/{{id}}

**<span style="color: rgb(241, 196, 15);">{{instancia}}</span>:** Hace referencia a la instancia de cada inmobiliaria.

#### **Petición**

<table border="1" id="bkmrk-m%C3%A9todo-get-content-t" style="border-collapse: collapse; width: 100%; height: 124.781px;"><colgroup><col style="width: 50.0596%;"></col><col style="width: 50.0596%;"></col></colgroup><tbody><tr style="height: 29.7969px;"><td style="height: 29.7969px;">**Método**</td><td style="height: 29.7969px;">GET</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;">**Content-Type**</td><td style="height: 29.7969px;">application/json</td></tr><tr style="height: 35.3906px;"><td style="height: 35.3906px;">****Authorization****</td><td style="height: 35.3906px;">**Bearer token,** Token obtenido al consumir el servicio [Login](https://docs.arrendasoft.co/books/api-arrendasoft-v2/page/login "Login")</td></tr><tr><td style="height: 29.7969px;">**Parámetro**</td><td style="height: 29.7969px;">{{id}}, corresponde al Identificador único de la clase de inmueble</td></tr></tbody></table>

#### **Respuesta**

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

```json
[
    {
        "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

<table id="bkmrk-clave-descripci%C3%B3n-id"><thead><tr><th>Clave</th><th>Descripción</th></tr></thead><tbody><tr><td>`id`</td><td>Identificador único de la característica</td></tr><tr><td>`descripcion`</td><td>Descripción de la característica</td></tr><tr><td>`tipo_campo`</td><td>Tipo de campo (ej. select, checkbox, numeric, etc.)</td></tr><tr><td>`opciones_valores`</td><td>Valores posibles para el campo, separados por coma</td></tr><tr><td>`opciones_descripciones`</td><td>Descripciones de las opciones, separadas por coma</td></tr><tr><td>`orden`</td><td>Orden en que aparece el campo</td></tr><tr><td>`grupo`</td><td>Grupo al que pertenece el campo</td></tr><tr><td>`clase_inmueble_id`</td><td>Identificador de la clase de inmueble</td></tr><tr><td>`clase_inmueble`</td><td>Tipo o clase de inmueble</td></tr></tbody></table>