> ## Documentation Index
> Fetch the complete documentation index at: https://tech.sedierp.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Consultar inmuebles

El servicio permite a los usuarios del portal de clientes consultar el listado de inmuebles de los que son propietarios, en línea en formato JSON.

El método de solicitud es POST y se requiere un encabezado "Authorization" para la autenticación, que debe contener el **AccessToken** (JWT) obtenido previamente del servicio de [inicio de sesión](https://tech.sedierp.com/inicio-de-sesion.md).

## Prerequisitos

Antes de realizar la consulta de inmuebles, se debe contar con los siguientes datos:

* AccessToken solicitado mediante el servicio de [inicio de sesión](https://tech.sedierp.com/inicio-de-sesion.md)
* Código único del cliente (TerceroID) obtenido del servicio de [datos del cliente](https://tech.sedierp.com/datos-del-cliente.md)

## Consultar inmuebles

**Request URL:** [https://portal.sedierp.com/API/api/Inmobiliaria/InmueblesConsultar](https://portal.sedierp.com/API/api/Inmobiliaria/InmueblesConsultar)\
**Tipo:** POST \
**Content Type:** application/json

**TerceroID** `int` *required*

Código único del cliente (ID) propietario de los inmuebles.

**Page** `int`

Página de consulta, por defecto (1).

**Rows** `int`

Cantidad de registros por página de consulta, por defecto (10). Si se envía 0, se retornan todos los registros sin paginar.

**SortColumn** `string`

Nombre de la columna de la respuesta por la cual se ordenan los registros (ej. `Direccion`). Por defecto se ordena por el consecutivo del inmueble de forma ascendente.

**SortDirection** `string`

Dirección del ordenamiento: `ASC` (ascendente) o `DESC` (descendente). Es obligatorio cuando se envía `SortColumn`.

**FullSearch** `string`

Campo de consulta múltiple. Busca el texto enviado en cualquier parte del consecutivo o de la dirección del inmueble.

```bash theme={null}
curl --location 'https://portal.sedierp.com/API/api/Inmobiliaria/InmueblesConsultar' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <ACCESS_TOKEN>' \
--data '{
	"TerceroID": 48213,
	"Page": 1,
	"Rows": 10,
	"SortColumn": null,
	"SortDirection": null,
	"FullSearch": null
}'
```

> [!NOTE]
>
> Solo se retornan inmuebles activos de la empresa en los que el cliente figura como propietario activo. Se incluyen los inmuebles con tipo de oferta 1, y los de tipo de oferta 2 siempre que el último proceso registrado del inmueble no se encuentre en estado 2. Si no se envía `TerceroID`, o si se envía `SortColumn` sin `SortDirection`, el servicio no retorna error: responde `rows` vacío.

### Respuesta

El servicio retorna el listado de inmuebles del cliente sin repetir. El campo `total` corresponde a la cantidad de registros retornados en la página consultada. Cada registro de `rows` contiene los siguientes campos:

**InmuebleID** `int`

Código único del inmueble (ID).

**Consecutivo** `int`

Consecutivo (número) del inmueble.

**Direccion** `string`

Dirección del inmueble.

**UniqueID** `GUID`

Identificador único del inmueble.

**ContratoRuta** `string`

Ruta del documento asociado al inmueble, tal como está almacenada en la plataforma (puede ser una referencia `cdn://`). Es null cuando el inmueble no tiene documento cargado.

**TipoInmuebleNombre** `string`

Nombre del tipo de inmueble.

Si `SortColumn` no corresponde a una columna de la respuesta, el servicio responde HTTP 400 con el error de base de datos en `Message`.

Si el AccessToken no se envía, es inválido o expiró, el servicio responde HTTP 401 (`{"Code": 401, "Message": "El TokenAcceso no es valido"}`).

```json Request theme={null}
{
  "TerceroID": 48213,
  "Page": 1,
  "Rows": 10,
  "SortColumn": null,
  "SortDirection": null,
  "FullSearch": null
}
```

```json Exitosa theme={null}
{
    "total": 2,
    "rows": [
        {
            "InmuebleID": 932,
            "Consecutivo": 412,
            "Direccion": "CL 45 # 12 - 30 AP 501",
            "UniqueID": "6d2a8f13-b4c7-4e90-9a25-3f1e7c8b0d64",
            "ContratoRuta": "cdn://9b4e7d21-3a6c-4f85-b0d2-e17c5a9f3e48",
            "TipoInmuebleNombre": "Apartamento"
        },
        {
            "InmuebleID": 1047,
            "Consecutivo": 538,
            "Direccion": "KR 15 # 93 - 47 LC 2",
            "UniqueID": "e3c95b70-1f2d-4a68-8c4e-7b0a6d2f9153",
            "ContratoRuta": null,
            "TipoInmuebleNombre": "Local"
        }
    ],
    "result": 1
}
```

```json Sin resultados theme={null}
{
    "total": 0,
    "rows": [],
    "result": 1
}
```

```json Error theme={null}
{
    "Message": "Invalid column name 'Nombre'., "
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.