Skip to main content

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

KeyTipo y CondicionesRequeridoDescripci贸n
APIKeystring
Key de accesso a la API
testboolean
Default = false
Activa el modo de pruebas
testErrorQueryError
C贸digo de error a simular
propertyTypePropertyTypeEnum
Tipo de propiedad que se desea consultar
addressstring
Direcci贸n del inmueble. Aparecer谩 dentro del reporte
locationobject
Contiene las coordenadas del inmueble que se est谩 consultado
location > latitudefloat
Latitud de las coordenadas en grados
location > longitudefloat
Longitud de las coordenadas en grados

Response Body (JSON)#

KeyTipoDescripci贸n
queryAvailableobject
Contiene las respuesta
queryAvailable > availableboolean
Indica si ser谩 posible realizar el reporte
queryAvailable > codeErrorCode
Presente solo si available = false
C贸digo de error
queryAvailable > messagestring
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"
}
}