Reporte Disponible

Verifica que tu cuenta tiene reportes disponbles y que además un resultado podrá ser generado para la ubicación y tipo de propiedad especificados. Utiliza este endpoint para garantizar a tus usuarios podrán usar RED Atlas para consultar su inmueble.

info

En modo de pruebas la verificación de reportes disponibles es omitida

POSThttps://api.finco.co/v1/query-available

Request Body (JSON)#

Key	Tipo y Condiciones	Requerido	Descripción
APIKey	string		Key de accesso a la API
test	boolean	Default = false	Activa el modo de pruebas
testError	QueryError		Código de error a simular
propertyType	PropertyTypeEnum		Tipo de propiedad que se desea consultar
address	string		Dirección del inmueble. Aparecerá dentro del reporte
location	object		Contiene las coordenadas del inmueble que se está consultado
location > latitude	float		Latitud de las coordenadas en grados
location > longitude	float		Longitud de las coordenadas en grados

Response Body (JSON)#

Key	Tipo	Descripción
queryAvailable	object	Contiene las respuesta
queryAvailable > available	boolean	Indica si será posible realizar el reporte
queryAvailable > code	ErrorCode Presente solo si available = false	Código de error
queryAvailable > message	string Presente solo si available = false	Mensaje que indica por qué el reporte no puede ser generado

Ejemplo Reporte Disponible#

Request Body (JSON)#

{
  "APIKey": "{{APIKey}}",
  "propertyType": "APARTMENT",
  "location": {
    "latitude": 19.3757956,
    "longitude": -99.1486069
  }
}

Response Body (JSON)#

Status:200OK

{
  "queryAvailable": {
    "available": true
  }
}

Ejemplo Reporte No Disponible#

Request Body (JSON)#

{
  "APIKey": "{{APIKey}}",
  "test": true,
  "testError": "QUERY_NOT_ALLOWED",
  "propertyType": "APARTMENT",
  "location": {
    "latitude": 19.3757956,
    "longitude": -99.1486069
  }
}

Response Body (JSON)#

Status:200OK

{
  "queryAvailable": {
    "available": false,
    "code": "QUERY_NOT_ALLOWED",
    "message": "No es posible generar el reporte para estas coordenadas"
  }
}

Ejemplo Reportes Insuficientes#

Request Body (JSON)#

{
  "APIKey": "{{APIKey}}",
  "test": true,
  "testError": "INSUFFICIENT_QUERIES",
  "propertyType": "APARTMENT",
  "location": {
    "latitude": 19.3757956,
    "longitude": -99.1486069
  }
}

Response Body (JSON)#

Status:200OK

{
  "queryAvailable": {
    "available": false,
    "code": "INSUFFICIENT_QUERIES",
    "message": "No cuentas con reportes disponibles"
  }
}