# API Arrendasoft V2

# Autenticación

En esta sección, explicaremos los servicios que se ofrecen para la gestión de autenticación en la API REST de Arrendasoft®.

# Login

Permite realizar el login en la API, para obtener el token necesario a usar en los demás servicios.

**Endpoint:** https://<span style="color: rgb(241, 196, 15);">**{{instancia}}**</span>.arrendasoft.co/service/v2/public/auth/login

**<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-post-content-" style="border-collapse: collapse; width: 100%; height: 172.141px;"><colgroup><col style="width: 18.3929%;"></col><col style="width: 81.7263%;"></col></colgroup><tbody><tr style="height: 29.7969px;"><td style="height: 29.7969px;">**Método**</td><td style="height: 29.7969px;">POST</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: 112.547px;"><td style="height: 112.547px;">**Body**</td><td style="height: 112.547px;">```json
{
    "username": "Aquí va el username dado por la inmobiliaria",
    "password": "Aquí va el password dado por la inmobiliaria"
}
```

  
</td></tr></tbody></table>

#### **Respuesta**

```json
{
  "message": null,
  "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2OTA0OTc1OTAsImV4cCI6MTY5MDU0MDc5MCwiZGF0YSI6eyJ0ZXJjZXJvX2lkIjoiNjQ4MiIsImRvY3VtZW50byI6InVzZXJfYXZhbnRvIn19.5OlAA_hg1NZ3xfjVqaDaf-j46JqiBcOUdHC1dwwUK38",
  "expiration": 1690540790
}
```

<table border="1" id="bkmrk-message-mensaje-de-u" style="border-collapse: collapse; width: 100%;"><colgroup><col style="width: 14.5834%;"></col><col style="width: 85.5358%;"></col></colgroup><tbody><tr><td>**message**</td><td>Mensaje de un posible error por si se presenta.</td></tr><tr><td>**token**</td><td>Token bearer para poder realizar la petición de contratos.</td></tr><tr><td>**expiration**</td><td>Timestamp de expiración del token, su duración es de 1 hora.</td></tr></tbody></table>

<span style="color: rgb(224, 62, 45);">**Importante:**</span> Es importante tener en cuenta que al realizar solicitudes a otros servicios, es posible que el token expire. En tales casos, será necesario volver a autenticarse utilizando el servicio de login.

```json
{
    "statusCode": 401,
    "error": {
        "type": "SERVER_ERROR",
        "description": "JWT Token expired."
    }
}
```

# 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>

# Propiedades

En esta sección, explicaremos los servicios que se ofrecen para la gestión de propiedades en la API REST de Arrendasoft®.

# Listar Propiedades

Permite obtener una lista de elementos, donde cada elemento contiene la información de cada una de las propiedades registradas en la inmobiliaria.

**Endpoint:** https://<span style="color: rgb(241, 196, 15);">***{{instancia}}***</span>.arrendasoft.co/service/v2/public/properties

**<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: 89.3907px;"><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: 29.7969px;"><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>

<table border="1" id="bkmrk-par%C3%A1metro-tipo-oblig" style="border-collapse: collapse; width: 100%;"><colgroup><col style="width: 19.7826%;"></col><col style="width: 12.8753%;"></col><col style="width: 20.143%;"></col><col style="width: 18.9511%;"></col><col style="width: 28.3671%;"></col></colgroup><tbody><tr><td class="align-center" colspan="5">**Parámetros**</td></tr><tr><td class="align-center">**Parámetro**</td><td class="align-center">**Tipo**</td><td class="align-center">**Obligatorio**</td><td class="align-center">**Valor por defecto**

</td><td class="align-center">**Descripción**</td></tr><tr><td>page</td><td>integer</td><td class="align-center">No</td><td class="align-center">1</td><td>Especifica la página de resultados que se desea recuperar al realizar la solicitud.</td></tr><tr><td>limit</td><td>integer</td><td class="align-center">No</td><td class="align-center">10</td><td>Especifica el número máximo de elementos que se deben devolver en la solicitud, el límite máximo es de 50.</td></tr><tr><td>listing\_start\_date</td><td>string</td><td class="align-center">No</td><td>  
</td><td>Representa la fecha de inicio del rango de fechas en el que un inmueble ha sido captado/consignado para su venta o alquiler.

  
Formato: YYYY/mm/dd</td></tr><tr><td>listing\_end\_date</td><td>string</td><td class="align-center">No</td><td>  
</td><td>Representa la fecha de fin del rango de fechas en el que un inmueble ha sido captado/consignado para su venta o alquiler.

Formato: YYYY/mm/dd

</td></tr><tr><td><div><div>created_start_date</div></div></td><td>string</td><td class="align-center">No</td><td>  
</td><td>Representa la fecha de inicio del rango de fechas en el que un inmueble ha sido creado en el sistema.

  
Formato: YYYY/mm/dd

</td></tr><tr><td><div><div><div><div>created_end_date</div></div></div></div></td><td>string</td><td class="align-center">No</td><td>  
</td><td>Representa la fecha de fin del rango de fechas en el que un inmueble ha sido creado en el sistema.

Formato: YYYY/mm/dd

</td></tr><tr><td><div><div><div><div>last_modified_start_date</div></div></div></div></td><td>string</td><td class="align-center">No</td><td>  
</td><td>Representa la fecha de inicio del rango de fechas en el que un inmueble ha sido actualizado por ultima vez.

  
Formato: YYYY/mm/dd

</td></tr><tr><td><div><div><div><div>last_modified_end_date</div></div></div></div></td><td>string</td><td class="align-center">No</td><td>  
</td><td>Representa la fecha de fin del rango de fechas en el que un inmueble ha sido actualizado por ultima vez.

Formato: YYYY/mm/dd

</td></tr></tbody></table>

<span style="color: rgb(230, 126, 35);">**Nota:** <span style="color: rgb(0, 0, 0);">Para los parámetros de tipo fecha que se compongan de un rango, como <span style="color: rgb(230, 126, 35);">listing\_start\_date</span> y <span style="color: rgb(230, 126, 35);">listing\_end\_date</span>, se debe tener en cuenta que si se envía solo el <span style="color: rgb(230, 126, 35);">start\_date</span>, se retornarán registros donde la condición es “<span style="color: rgb(230, 126, 35);">&gt;= (mayor o igual)</span>”. Si solo se envía el <span style="color: rgb(230, 126, 35);">end\_date</span>, se retornarán registros donde la condición es “<span style="color: rgb(230, 126, 35);">&lt;= (menos o igual)</span>”, y si se envían ambas, entonces se retornarán registros dentro de ese rango de fechas.</span></span>

<span style="color: rgb(230, 126, 35);"><span style="color: rgb(0, 0, 0);">**Ejemplos de peticiones**</span></span>

```
https://{{instancia}}.arrendasoft.co/service/v2/public/properties
```

```
https://{{instancia}}.arrendasoft.co/service/v2/public/properties/
```

```
https://{{instancia}}.arrendasoft.co/service/v2/public/properties?page=1&limit=10
```

```
https://{{instancia}}.arrendasoft.co/service/v2/public/properties?page=1&limit=10&listing_start_date=2024-03-26
```

```
https://{{instancia}}.arrendasoft.co/service/v2/public/properties?page=1&limit=10&listing_start_date=2024-03-26&listing_end_date=2024-03-26
```

#### **Respuesta**

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

```json
[
    {
        "codigo": "137",
        "titulo": "Apartamento cerca del estadio y la cuarta brigada",
        "clase_id": "1247",
        "clase_inmueble": "Apartamento",
        "tipo_servicio_id": "arriendo",
        "tipo_servicio": "Arriendo",
        "estrato": "1258",
        "estrato_texto": "Cuatro",
        "fecha_consignacion": "2024-04-26",
        "asesor_id": "5",
        "asesor": "InterServicios",
        "pais_id": "1",
        "pais": "COLOMBIA",
        "departamento_id": "5",
        "departamento": "Antioquia",
        "municipio_id": "1",
        "municipio": "Medellin",
        "barrio_id": "3",
        "barrio": "Estadio",
        "direccion": "CALLE 50 # 74 - 12",
        "coordenadas": "6.21505012838972:-75.57529436962885",
        "valor_arriendo1": "1600000",
        "valor_arriendo2": "0",
        "valor_venta1": "0",
        "valor_venta2": "0",
        "valor_administracion": "0",
        "avaluo_catastral": "0",
        "impuesto_predial": "0.00",
        "area": "75.00",
        "observaciones": null,
        "propiedad_destacada": "No",
        "llaves_en": "oficina",
        "llaves_otro": null,
        "paga_cuota_sost": "propietario",
        "folio_matricula": null,
        "referencia_catastral": null,
        "edificio_unidad": "urbanizacion",
        "estado": "1",
        "estado_texto": "Activa",
        "cantidad_images": "3",
        "cantidad_videos": "1",
        "caracteristicas": [
            {
                "id": "1",
                "descripcion": "Nº De Habitaciones",
                "tipo_campo": "numeric",
                "orden": "1",
                "grupo": "Características del inmueble",
                "valor": "4"
            },
            {
                "id": "2",
                "descripcion": "Nº De Baños",
                "tipo_campo": "numeric",
                "orden": "2",
                "grupo": "Características del inmueble",
                "valor": "3"
            },
            {
                "id": "5",
                "descripcion": "Nº De Piso",
                "tipo_campo": "numeric",
                "orden": "3",
                "grupo": "Características del inmueble",
                "valor": "1"
            },
            {
                "id": "4",
                "descripcion": " Antigüedad del Inmueble",
                "tipo_campo": "numeric",
                "orden": "5",
                "grupo": "Características del Inmueble",
                "valor": "3"
            },
            {
                "id": "14",
                "descripcion": "Cocina Integral",
                "tipo_campo": "checkbox",
                "orden": "5",
                "grupo": "Características Internas",
                "valor": "1"
            },
            {
                "id": "34",
                "descripcion": "Sala",
                "tipo_campo": "checkbox",
                "orden": "6",
                "grupo": "Características del Inmueble",
                "valor": "1"
            },
            {
                "id": "31",
                "descripcion": "Red de gas",
                "tipo_campo": "select",
                "orden": "5",
                "grupo": "Características del Inmueble",
                "valor": "si",
                "valor_texto": "Si"
            },
            {
                "id": "63",
                "descripcion": "Garaje",
                "tipo_campo": "checkbox",
                "orden": "10",
                "grupo": "Características Internas",
                "valor": "1"
            }
        ],
        "propietarios": [
            {
                "id": "272",
                "documento": "4207050496",
                "nombres": "CRISTINA GUERRERO",
                "apellidos": ""
            }
        ],
        "imagenes": [
            {
                "posicion": "1",
                "size": "19201080",
                "imagen": "https://qa.arrendasoft.co/img/fotos/1920x1080_66ae4cfba9aa891473fe8f78a0c7e6f6.jpeg"
            },
            {
                "posicion": "2",
                "size": "19201080",
                "imagen": "https://qa.arrendasoft.co/img/fotos/1920x1080_660ae9fb29a0ff3c0e47cf13cde4740e.jpeg"
            },
            {
                "posicion": "3",
                "size": "19201080",
                "imagen": "https://qa.arrendasoft.co/img/fotos/1920x1080_83883a0f75ddae325f41eafce4066631.jpeg"
            }
        ],
        "videos": [
            {
                "url": "608AV8w6gL0",
                "tipo": "youtube",
                "descripcion": null,
                "posicion": "1"
            }
        ]
    },
    {
        "codigo": "136",
        "titulo": "FINCA",
        "clase_id": "1254",
        "clase_inmueble": "Finca",
        "tipo_servicio_id": "venta y arriendo",
        "tipo_servicio": "Venta y Arriendo",
        "estrato": "1258",
        "estrato_texto": "Cuatro",
        "fecha_consignacion": "2021-04-16",
        "asesor_id": "6",
        "asesor": "KAREN CANO",
        "pais_id": "1",
        "pais": "COLOMBIA",
        "departamento_id": "11",
        "departamento": "Bogota D.c.",
        "municipio_id": "150",
        "municipio": "Bogota",
        "barrio_id": "838",
        "barrio": "Bosa",
        "direccion": "CR 145 # 85 - 9",
        "coordenadas": "4.875468815048683:-73.62556445019526",
        "valor_arriendo1": "6050000",
        "valor_arriendo2": "0",
        "valor_venta1": "500000000",
        "valor_venta2": "0",
        "valor_administracion": "0",
        "avaluo_catastral": "0",
        "impuesto_predial": "0.00",
        "area": "1200.00",
        "observaciones": "Esta finca ofrece una experiencia rural única con comodidades modernas. La espaciosa casa principal cuenta con encantadoras habitaciones, cuenta con una reluciente piscina y áreas verdes bien cuidadas.",
        "propiedad_destacada": "No",
        "llaves_en": "oficina",
        "llaves_otro": null,
        "paga_cuota_sost": null,
        "folio_matricula": "0",
        "referencia_catastral": "0",
        "edificio_unidad": "urbanizacion",
        "estado": "1",
        "estado_texto": "Activa",
        "cantidad_images": "2",
        "cantidad_videos": "0",
        "caracteristicas": [
            {
                "id": "1",
                "descripcion": "Nº De Habitaciones",
                "tipo_campo": "numeric",
                "orden": "1",
                "grupo": "Características del inmueble",
                "valor": "9"
            },
            {
                "id": "2",
                "descripcion": "Nº De Baños",
                "tipo_campo": "numeric",
                "orden": "2",
                "grupo": "Características del inmueble",
                "valor": "4"
            },
            {
                "id": "11",
                "descripcion": "Zona de lavandería",
                "tipo_campo": "checkbox",
                "orden": "14",
                "grupo": "Características del inmueble",
                "valor": "1"
            },
            {
                "id": "9",
                "descripcion": "Cuarto de servicio",
                "tipo_campo": "checkbox",
                "orden": "5",
                "grupo": "Características del Inmueble",
                "valor": "1"
            },
            {
                "id": "26",
                "descripcion": "Sauna / Turco / Jacuzzi",
                "tipo_campo": "checkbox",
                "orden": "6",
                "grupo": "Características del Inmueble",
                "valor": "1"
            }
        ],
        "propietarios": [
            {
                "id": "83",
                "documento": "2830863285",
                "nombres": "LILIA MARLEN",
                "apellidos": "LOPEZ CASTELLANOS"
            }
        ],
        "imagenes": [
            {
                "posicion": "1",
                "size": "19201080",
                "imagen": "https://qa.arrendasoft.co/img/fotos/1920x1080_431b70772304a609c280036305f66ac4.jpeg"
            },
            {
                "posicion": "2",
                "size": "19201080",
                "imagen": "https://qa.arrendasoft.co/img/fotos/1920x1080_209e299b845c8bdf9479f5fb055461fe.jpeg"
            }
        ],
        "videos": []
    }
]
```

##### Claves y Descripciones del JSON de Propiedades

Esta tabla enumera las claves presentes en el JSON de una propiedad y proporciona una breve descripción de cada una, explicando su propósito y el tipo de información que contienen.

<table id="bkmrk-clave-descripci%C3%B3n-co"><thead><tr><th>**Clave**</th><th>**Descripción**</th></tr></thead><tbody><tr><td>`codigo`</td><td>Código del inmueble</td></tr><tr><td>`titulo`</td><td>Título del anuncio del inmueble</td></tr><tr><td>`clase_id`</td><td>ID de la clase del inmueble</td></tr><tr><td>`clase_inmueble`</td><td>Clase del inmueble</td></tr><tr><td>`tipo_servicio_id`</td><td>ID del tipo de servicio</td></tr><tr><td>`tipo_servicio`</td><td>Tipo de servicio (arriendo/venta)</td></tr><tr><td>`estrato`</td><td>ID del estrato del inmueble</td></tr><tr><td>`estrato_texto`</td><td>Texto descriptivo del estrato</td></tr><tr><td>`fecha_consignacion`</td><td>Fecha de consignación del inmueble</td></tr><tr><td>`asesor_id`</td><td>ID del asesor</td></tr><tr><td>`asesor`</td><td>Nombre del asesor</td></tr><tr><td>`pais_id`</td><td>ID del país</td></tr><tr><td>`pais`</td><td>Nombre del país</td></tr><tr><td>`departamento_id`</td><td>ID del departamento</td></tr><tr><td>`departamento`</td><td>Nombre del departamento</td></tr><tr><td>`municipio_id`</td><td>ID del municipio</td></tr><tr><td>`municipio`</td><td>Nombre del municipio</td></tr><tr><td>`barrio_id`</td><td>ID del barrio</td></tr><tr><td>`barrio`</td><td>Nombre del barrio</td></tr><tr><td>`direccion`</td><td>Dirección del inmueble</td></tr><tr><td>`coordenadas`</td><td>Coordenadas geográficas del inmueble</td></tr><tr><td>`valor_arriendo1`</td><td>Valor principal de arriendo</td></tr><tr><td>`valor_arriendo2`</td><td>Valor secundario de arriendo</td></tr><tr><td>`valor_venta1`</td><td>Valor principal de venta</td></tr><tr><td>`valor_venta2`</td><td>Valor secundario de venta</td></tr><tr><td>`valor_administracion`</td><td>Valor de administración</td></tr><tr><td>`avaluo_catastral`</td><td>Avalúo catastral del inmueble</td></tr><tr><td>`impuesto_predial`</td><td>Impuesto predial</td></tr><tr><td>`area`</td><td>Área del inmueble</td></tr><tr><td>`observaciones`</td><td>Observaciones adicionales</td></tr><tr><td>`propiedad_destacada`</td><td>Indicador de propiedad destacada</td></tr><tr><td>`llaves_en`</td><td>Lugar donde están las llaves</td></tr><tr><td>`llaves_otro`</td><td>Otro lugar donde están las llaves</td></tr><tr><td>`paga_cuota_sost`</td><td>Quién paga la cuota de sostenimiento</td></tr><tr><td>`folio_matricula`</td><td>Folio de matrícula</td></tr><tr><td>`referencia_catastral`</td><td>Referencia catastral</td></tr><tr><td>`edificio_unidad`</td><td>Nombre del edificio o unidad</td></tr><tr><td>`estado`</td><td>ID del estado del inmueble</td></tr><tr><td>`estado_texto`</td><td>Texto descriptivo del estado</td></tr><tr><td>`cantidad_images`</td><td>Cantidad de imágenes del inmueble</td></tr><tr><td>`cantidad_videos`</td><td>Cantidad de videos del inmueble</td></tr><tr><td>`caracteristicas`</td><td>Lista de características del inmueble</td></tr><tr><td>`propietarios`</td><td>Lista de propietarios</td></tr><tr><td>`imagenes`</td><td>Lista de imágenes del inmueble</td></tr><tr><td>`videos`</td><td>Lista de videos del inmueble</td></tr></tbody></table>

##### Características

Cada elemento dentro de la lista `caracteristicas` tiene las siguientes claves:

<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>ID 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 de la característica</td></tr><tr><td>`orden`</td><td>Orden de la característica</td></tr><tr><td>`grupo`</td><td>Grupo al que pertenece la característica</td></tr><tr><td>`valor`</td><td>Valor de la característica</td></tr><tr><td>`valor_texto`</td><td>Texto descriptivo del valor (si aplica)</td></tr></tbody></table>

##### Propietarios

Cada elemento dentro de la lista `propietarios` tiene las siguientes claves:

<table id="bkmrk-clave-descripci%C3%B3n-id-1"><thead><tr><th>**Clave**</th><th>**Descripción**</th></tr></thead><tbody><tr><td>`id`</td><td>ID del propietario</td></tr><tr><td>`documento`</td><td>Documento de identificación</td></tr><tr><td>`nombres`</td><td>Nombres del propietario</td></tr><tr><td>`apellidos`</td><td>Apellidos del propietario</td></tr></tbody></table>

##### Imágenes

Cada elemento dentro de la lista `imagenes` tiene las siguientes claves:

<table id="bkmrk-clave-descripci%C3%B3n-po"><thead><tr><th>**Clave**</th><th>**Descripción**</th></tr></thead><tbody><tr><td>`posicion`</td><td>Posición de la imagen</td></tr><tr><td>`size`</td><td>Tamaño de la imagen</td></tr><tr><td>`imagen`</td><td>URL de la imagen</td></tr></tbody></table>

##### Videos

Cada elemento dentro de la lista `videos` tiene las siguientes claves:

<table id="bkmrk-clave-descripci%C3%B3n-ur"><thead><tr><th>**Clave**</th><th>**Descripción**</th></tr></thead><tbody><tr><td>`url`</td><td>URL del video</td></tr><tr><td>`tipo`</td><td>Tipo de video (e.g., YouTube)</td></tr><tr><td>`descripcion`</td><td>Descripción del video</td></tr><tr><td>`posicion`</td><td>Posición del video</td></tr></tbody></table>

# Buscar Propiedad por Código

Permite obtener un elemento que contiene la información de la propiedad.

**Endpoint:** https://<span style="color: rgb(241, 196, 15);">***{{instancia}}***</span>.arrendasoft.co/service/v2/public/properties/{{code}}

**<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 style="height: 29.7969px;"><td style="height: 29.7969px;">**Parámetro**</td><td style="height: 29.7969px;">{{code}}, corresponde al código de la propiedad a consultar</td></tr></tbody></table>

<span style="color: rgb(230, 126, 35);"><span style="color: rgb(0, 0, 0);">**Ejemplo de petición**</span></span>

```
https://{{instancia}}.arrendasoft.co/service/v2/public/properties/137
```

#### **Respuesta**

Elemento con la información de la propiedad.

```json
{
    "codigo": "137",
    "titulo": "Apartamento cerca del estadio y la cuarta brigada",
    "clase_id": "1247",
    "clase_inmueble": "Apartamento",
    "tipo_servicio_id": "arriendo",
    "tipo_servicio": "Arriendo",
    "estrato": "1258",
    "estrato_texto": "Cuatro",
    "fecha_consignacion": "2024-04-26",
    "asesor_id": "5",
    "asesor": "InterServicios",
    "pais_id": "1",
    "pais": "COLOMBIA",
    "departamento_id": "5",
    "departamento": "Antioquia",
    "municipio_id": "1",
    "municipio": "Medellin",
    "barrio_id": "3",
    "barrio": "Estadio",
    "direccion": "CALLE 50 # 74 - 12",
    "coordenadas": "6.21505012838972:-75.57529436962885",
    "valor_arriendo1": "1600000",
    "valor_arriendo2": "0",
    "valor_venta1": "0",
    "valor_venta2": "0",
    "valor_administracion": "0",
    "avaluo_catastral": "0",
    "impuesto_predial": "0.00",
    "area": "75.00",
    "observaciones": null,
    "propiedad_destacada": "No",
    "llaves_en": "oficina",
    "llaves_otro": null,
    "paga_cuota_sost": "propietario",
    "folio_matricula": null,
    "referencia_catastral": null,
    "edificio_unidad": "urbanizacion",
    "estado": "1",
    "estado_texto": "Activa",
    "cantidad_images": "3",
    "cantidad_videos": "1",
    "caracteristicas": [
        {
            "id": "1",
            "descripcion": "Nº De Habitaciones",
            "tipo_campo": "numeric",
            "orden": "1",
            "grupo": "Características del inmueble",
            "valor": "4"
        },
        {
            "id": "2",
            "descripcion": "Nº De Baños",
            "tipo_campo": "numeric",
            "orden": "2",
            "grupo": "Características del inmueble",
            "valor": "3"
        },
        {
            "id": "5",
            "descripcion": "Nº De Piso",
            "tipo_campo": "numeric",
            "orden": "3",
            "grupo": "Características del inmueble",
            "valor": "1"
        },
        {
            "id": "4",
            "descripcion": " Antigüedad del Inmueble",
            "tipo_campo": "numeric",
            "orden": "5",
            "grupo": "Características del Inmueble",
            "valor": "3"
        },
        {
            "id": "14",
            "descripcion": "Cocina Integral",
            "tipo_campo": "checkbox",
            "orden": "5",
            "grupo": "Características Internas",
            "valor": "1"
        },
        {
            "id": "34",
            "descripcion": "Sala",
            "tipo_campo": "checkbox",
            "orden": "6",
            "grupo": "Características del Inmueble",
            "valor": "1"
        },
        {
            "id": "31",
            "descripcion": "Red de gas",
            "tipo_campo": "select",
            "orden": "5",
            "grupo": "Características del Inmueble",
            "valor": "si",
            "valor_texto": "Si"
        },
        {
            "id": "63",
            "descripcion": "Garaje",
            "tipo_campo": "checkbox",
            "orden": "10",
            "grupo": "Características Internas",
            "valor": "1"
        }
    ],
    "propietarios": [
        {
            "id": "272",
            "documento": "4207050496",
            "nombres": "CRISTINA GUERRERO",
            "apellidos": ""
        }
    ],
    "imagenes": [
        {
            "posicion": "1",
            "size": "19201080",
            "imagen": "https://qa.arrendasoft.co/img/fotos/1920x1080_66ae4cfba9aa891473fe8f78a0c7e6f6.jpeg"
        },
        {
            "posicion": "2",
            "size": "19201080",
            "imagen": "https://qa.arrendasoft.co/img/fotos/1920x1080_660ae9fb29a0ff3c0e47cf13cde4740e.jpeg"
        },
        {
            "posicion": "3",
            "size": "19201080",
            "imagen": "https://qa.arrendasoft.co/img/fotos/1920x1080_83883a0f75ddae325f41eafce4066631.jpeg"
        }
    ],
    "videos": [
        {
            "url": "608AV8w6gL0",
            "tipo": "youtube",
            "descripcion": null,
            "posicion": "1"
        }
    ]
}
```

##### Claves y Descripciones del JSON de Propiedad

Esta tabla enumera las claves presentes en el JSON de una propiedad y proporciona una breve descripción de cada una, explicando su propósito y el tipo de información que contienen.

<table id="bkmrk-clave-descripci%C3%B3n-co"><thead><tr><th>**Clave**</th><th>**Descripción**</th></tr></thead><tbody><tr><td>`codigo`</td><td>Código del inmueble</td></tr><tr><td>`titulo`</td><td>Título del anuncio del inmueble</td></tr><tr><td>`clase_id`</td><td>ID de la clase del inmueble</td></tr><tr><td>`clase_inmueble`</td><td>Clase del inmueble</td></tr><tr><td>`tipo_servicio_id`</td><td>ID del tipo de servicio</td></tr><tr><td>`tipo_servicio`</td><td>Tipo de servicio (arriendo/venta)</td></tr><tr><td>`estrato`</td><td>ID del estrato del inmueble</td></tr><tr><td>`estrato_texto`</td><td>Texto descriptivo del estrato</td></tr><tr><td>`fecha_consignacion`</td><td>Fecha de consignación del inmueble</td></tr><tr><td>`asesor_id`</td><td>ID del asesor</td></tr><tr><td>`asesor`</td><td>Nombre del asesor</td></tr><tr><td>`pais_id`</td><td>ID del país</td></tr><tr><td>`pais`</td><td>Nombre del país</td></tr><tr><td>`departamento_id`</td><td>ID del departamento</td></tr><tr><td>`departamento`</td><td>Nombre del departamento</td></tr><tr><td>`municipio_id`</td><td>ID del municipio</td></tr><tr><td>`municipio`</td><td>Nombre del municipio</td></tr><tr><td>`barrio_id`</td><td>ID del barrio</td></tr><tr><td>`barrio`</td><td>Nombre del barrio</td></tr><tr><td>`direccion`</td><td>Dirección del inmueble</td></tr><tr><td>`coordenadas`</td><td>Coordenadas geográficas del inmueble</td></tr><tr><td>`valor_arriendo1`</td><td>Valor principal de arriendo</td></tr><tr><td>`valor_arriendo2`</td><td>Valor secundario de arriendo</td></tr><tr><td>`valor_venta1`</td><td>Valor principal de venta</td></tr><tr><td>`valor_venta2`</td><td>Valor secundario de venta</td></tr><tr><td>`valor_administracion`</td><td>Valor de administración</td></tr><tr><td>`avaluo_catastral`</td><td>Avalúo catastral del inmueble</td></tr><tr><td>`impuesto_predial`</td><td>Impuesto predial</td></tr><tr><td>`area`</td><td>Área del inmueble</td></tr><tr><td>`observaciones`</td><td>Observaciones adicionales</td></tr><tr><td>`propiedad_destacada`</td><td>Indicador de propiedad destacada</td></tr><tr><td>`llaves_en`</td><td>Lugar donde están las llaves</td></tr><tr><td>`llaves_otro`</td><td>Otro lugar donde están las llaves</td></tr><tr><td>`paga_cuota_sost`</td><td>Quién paga la cuota de sostenimiento</td></tr><tr><td>`folio_matricula`</td><td>Folio de matrícula</td></tr><tr><td>`referencia_catastral`</td><td>Referencia catastral</td></tr><tr><td>`edificio_unidad`</td><td>Nombre del edificio o unidad</td></tr><tr><td>`estado`</td><td>ID del estado del inmueble</td></tr><tr><td>`estado_texto`</td><td>Texto descriptivo del estado</td></tr><tr><td>`cantidad_images`</td><td>Cantidad de imágenes del inmueble</td></tr><tr><td>`cantidad_videos`</td><td>Cantidad de videos del inmueble</td></tr><tr><td>`caracteristicas`</td><td>Lista de características del inmueble</td></tr><tr><td>`propietarios`</td><td>Lista de propietarios</td></tr><tr><td>`imagenes`</td><td>Lista de imágenes del inmueble</td></tr><tr><td>`videos`</td><td>Lista de videos del inmueble</td></tr></tbody></table>

##### Características

Cada elemento dentro de la lista `caracteristicas` tiene las siguientes claves:

<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>ID 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 de la característica</td></tr><tr><td>`orden`</td><td>Orden de la característica</td></tr><tr><td>`grupo`</td><td>Grupo al que pertenece la característica</td></tr><tr><td>`valor`</td><td>Valor de la característica</td></tr><tr><td>`valor_texto`</td><td>Texto descriptivo del valor (si aplica)</td></tr></tbody></table>

##### Propietarios

Cada elemento dentro de la lista `propietarios` tiene las siguientes claves:

<table id="bkmrk-clave-descripci%C3%B3n-id-1"><thead><tr><th>**Clave**</th><th>**Descripción**</th></tr></thead><tbody><tr><td>`id`</td><td>ID del propietario</td></tr><tr><td>`documento`</td><td>Documento de identificación</td></tr><tr><td>`nombres`</td><td>Nombres del propietario</td></tr><tr><td>`apellidos`</td><td>Apellidos del propietario</td></tr></tbody></table>

##### Imágenes

Cada elemento dentro de la lista `imagenes` tiene las siguientes claves:

<table id="bkmrk-clave-descripci%C3%B3n-po"><thead><tr><th>**Clave**</th><th>**Descripción**</th></tr></thead><tbody><tr><td>`posicion`</td><td>Posición de la imagen</td></tr><tr><td>`size`</td><td>Tamaño de la imagen</td></tr><tr><td>`imagen`</td><td>URL de la imagen</td></tr></tbody></table>

##### Videos

Cada elemento dentro de la lista `videos` tiene las siguientes claves:

<table id="bkmrk-clave-descripci%C3%B3n-ur"><thead><tr><th>**Clave**</th><th>**Descripción**</th></tr></thead><tbody><tr><td>`url`</td><td>URL del video</td></tr><tr><td>`tipo`</td><td>Tipo de video (e.g., YouTube)</td></tr><tr><td>`descripcion`</td><td>Descripción del video</td></tr><tr><td>`posicion`</td><td>Posición del video</td></tr></tbody></table>

# Actualizar Estado de la Propiedad

Permite actualizar el estado de la propiedad.

**Endpoint:** https://<span style="color: rgb(241, 196, 15);">***{{instancia}}***</span>.arrendasoft.co/service/v2/public/properties/{{code}}/status

**<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: 218.14px;"><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;">PATCH</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 style="height: 29.7969px;"><td style="height: 29.7969px;">**Parámetro**</td><td style="height: 29.7969px;">{{code}}, corresponde al código de la propiedad a consultar</td></tr><tr style="height: 93.359px;"><td style="height: 93.359px;">**Body**</td><td style="height: 93.359px;">```json
{
    "status": Estado por el que se desea actualizar
}
```

  
</td></tr></tbody></table>

<span style="color: rgb(230, 126, 35);"><span style="color: rgb(0, 0, 0);">**Ejemplo de petición**</span></span>

```
https://{{instancia}}.arrendasoft.co/service/v2/public/properties/137/status
```

**Body**

```json
{
    "status": 2
}
```

#### **Respuesta**

Mensaje que indica si el estado se actualizó correctamente o si se presentó algún error, junto con su respectivo código de respuesta HTTP.

```json
{
    "message": "Se actualizo el estado de la propiedad correctamente"
}
```

<table border="1" id="bkmrk-message-mensaje-de-u" style="border-collapse: collapse; width: 100%;"><colgroup><col style="width: 14.5834%;"></col><col style="width: 85.5358%;"></col></colgroup><tbody><tr><td>**message**</td><td>Mensaje indicando que se actualizo el estado o de un posible error por si se presenta.</td></tr></tbody></table>

<p class="callout info">El cambio de estado depende del estado actual de la propiedad. Por ejemplo, si la propiedad se encuentra actualmente en el estado 'Arrendada', el sistema no permitirá la actualización del estado.</p>

# Asesores

En esta sección, explicaremos los servicios que se ofrecen para la gestión de asesores en la API REST de Arrendasoft®.

# Listar Asesores

Permite obtener una lista de elementos, donde cada elemento contiene la información de cada uno de los asesores registrados en el sistema.

**Endpoint:** https://<span style="color: rgb(241, 196, 15);">***{{instancia}}***</span>.arrendasoft.co/service/v2/public/agents

**<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 asesores.

```json
[
    {
        "id": "8",
        "documento": "12164587200",
        "nombre": "DANIEL RESTREPO",
        "telefono": "789456123",
        "email": "daniel.restrepo@interservicios.com",
        "path_photo": "https://localhost/arrendasoft/pic/iconos/user_photo.png"
    },
    {
        "id": "6",
        "documento": "1216727504",
        "nombre": "KAREN CANO",
        "telefono": "4447417",
        "email": "karen.cano@interservicios.com",
        "path_photo": "https://localhost/arrendasoft/pic/iconos/user_photo.png"
    }
]
```

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 usuario</td></tr><tr><td>`documento`</td><td>Número de documento de identificación del usuario</td></tr><tr><td>`nombre`</td><td>Nombre completo del usuario</td></tr><tr><td>`telefono`</td><td>Número de teléfono del usuario</td></tr><tr><td>`email`</td><td>Dirección de correo electrónico del usuario</td></tr><tr><td>`path_photo`</td><td>URL a la foto del usuario</td></tr></tbody></table>

# Buscar Asesor por Documento

Permite obtener un elemento que contiene la información del asesor.

**Endpoint:** https://<span style="color: rgb(241, 196, 15);">***{{instancia}}***</span>.arrendasoft.co/service/v2/public/agents/{{document}}

**<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 style="height: 29.7969px;"><td style="height: 29.7969px;">**Parámetro**</td><td style="height: 29.7969px;">{{document}}, corresponde al número de documento del asesor a consultar</td></tr></tbody></table>

<span style="color: rgb(230, 126, 35);"><span style="color: rgb(0, 0, 0);">**Ejemplo de petición**</span></span>

```
https://{{instancia}}.arrendasoft.co/service/v2/public/agents/1216727504
```

#### **Respuesta**

Elemento con la información de la propiedad.

```json
{
    "id": "6",
    "documento": "1216727504",
    "nombre": "KAREN CANO",
    "telefono": "4447417",
    "email": "karen.cano@interservicios.com",
    "path_photo": "https://localhost/arrendasoft/pic/iconos/user_photo.png"
}
```

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 usuario</td></tr><tr><td>`documento`</td><td>Número de documento de identificación del usuario</td></tr><tr><td>`nombre`</td><td>Nombre completo del usuario</td></tr><tr><td>`telefono`</td><td>Número de teléfono del usuario</td></tr><tr><td>`email`</td><td>Dirección de correo electrónico del usuario</td></tr><tr><td>`path_photo`</td><td>URL a la foto del usuario</td></tr></tbody></table>