Prerequisitos
Antes de realizar la consulta de contratos, se debe contar con los siguientes datos:- AccessToken solicitado mediante el servicio de inicio de sesión
- Código único del cliente (TerceroID) obtenido del servicio de datos del cliente
Consultar contratos
Request URL: https://portal.sedierp.com/API/api/Inmobiliaria/ContratosConsultarTipo: POST
Content Type: application/json
int
required
Código único del cliente (ID) que inició sesión. Solo se retornan contratos si corresponde al cliente del AccessToken.
int
Filtro de búsqueda por código único del inmueble (ID).
int
Página de consulta, por defecto (1).
int
Cantidad de registros por página de consulta, por defecto (10). Si se envía 0, se retornan todos los registros sin paginar.
string
Nombre de la columna de la respuesta por la cual se ordenan los registros (ej.
Consecutivo). Por defecto se ordena por el consecutivo del inmueble de forma ascendente.string
Dirección del ordenamiento:
ASC (ascendente) o DESC (descendente). Es obligatorio cuando se envía SortColumn.string
Campo de consulta múltiple. Busca el texto enviado en cualquier parte del consecutivo del contrato, el consecutivo del inmueble o la dirección del inmueble.
Si el
TerceroID no corresponde al cliente del AccessToken, si no se envía, o si se envía SortColumn sin SortDirection, el servicio no retorna error: responde rows vacío.Respuesta
El servicio retorna el listado de contratos de arrendamiento del cliente, sin filtrar por estado del contrato. El campototal corresponde a la cantidad de registros retornados en la página consultada. Cada registro de rows contiene los siguientes campos:
int
Código único del contrato (ID).
int
Código único del inmueble arrendado (ID).
int
Consecutivo del contrato.
int
Consecutivo (número) del inmueble.
string
Ruta del documento del contrato, tal como está almacenada en la plataforma (puede ser una referencia
cdn://). Es null cuando el contrato no tiene documento cargado.string
Dirección del inmueble.
GUID
Identificador único del contrato.
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"}).