# Países

Para obtener el listado de todos los países soportados por Wasi se debe usar la URI:

api.wasi.co/v1/location/all-countries

Esto debería retornar un JSON similar al siguiente:

{
    "0": {
        "id_country": "1",
        "name": "Colombia",
        "iso": "CO"
    },
    "1": {
        "id_country": "5",
        "name": "Argentina",
        "iso": "AR"
    },
    "2": {
        "id_country": "9",
        "name": "Belgium",
        "iso": "BE"
    },
    "status": "success"
}

Adicionalmente para obtener la cantidad de inmuebles Activos o Destacados en el sistema podemos adicionar las variables quantity, id_property_type, for_sale, for_rent, for_transfer, y scope:

Nombre Tipo
quantity Boolean Valor booleano (true o false) para obtener la cantidad de inmuebles.
id_property_type Number Identificador del tipo de propiedad de las propiedades, ver Tipos de propiedad.
for_sale Boolean Valor booleano (true o false) que indica si los inmuebles estan diponibles para la venta o no.
for_rent Boolean Valor booleano (true o false) que indica si los inmuebles estan diponibles para la renta (alquilar, arrendar) o no.
for_transfer Boolean Valor booleano (true o false) que indica si el inmuebles estan disponibles para permutar.
scope Number Indica si la cantidad se obtiene contando las propiedades propias o de los aliados, ver scope

# Scope

Valor Representa
1 Privado, sólo cuenta las propiedades creadas por la empresa.
2 Aliados, sólo cuenta las propiedades activas de empresas aliadas.
3 Todas, cuenta propiedades privadas y propiedades activas de empresas aliadas. (opción por defecto)
4 Grupo, sólo cuenta las propiedades activas en los grupos.

Si se quiere ver las cantidades en general para este ejemplo quedaría asi:

api.wasi.co/v1/location/all-countries?quantity=true

Si se quiere ver especificamente cuantas casas hay (Código 1 para Casas) para este ejemplo quedaría asi:

api.wasi.co/v1/location/all-countries?quantity=true&id_property_type=1

Si se quiere ver especificamente cuantas casas hay (Código 1 para Casas) que esten en venta, para este ejemplo quedaría asi:

api.wasi.co/v1/location/all-countries?quantity=true&id_property_type=1&for_sale=true

Todos los casos anteriores deberian retornar un JSON similar al siguiente:

{
    "0": {
        "id_country": "1",
        "name": "Colombia",
        "iso": "CO",
        "quantity": 102
    },
    "1": {
        "id_country": "5",
        "name": "Argentina",
        "iso": "AR",
        "quantity": 13
    },
    "2": {
        "id_country": "9",
        "name": "Belgium",
        "iso": "BE",
        "quantity": 0
    },
    "status": "success"
}

Para obtener información de un país en especifico conociendo su id se tiene la URI general:

api.wasi.co/v1/location/country/#id_country

Por ejemplo para Colombia el id_country es 1, entonces la URI seria:

api.wasi.co/v1/location/country/1

Y se obtiene la respuesta:

{
    "id_country": "1",
    "name": "Colombia",
    "iso": "CO",
    "status": "success"
}

Al igual que con el ejemplo anterior para obtener la cantidad de inmuebles Activos o Destacados en el sistema podemos adicionar las variables quantity (booleana), id_property_type (ver Tipos de propiedad), for_sale (booleana), for_rent (booleana), for_transfer (booleana) y scope (número).

Si se quiere ver las cantidades en general para este ejemplo quedaría asi:

api.wasi.co/v1/location/country/1?quantity=true

Si se quiere ver especificamente cuantas casas hay (Código 1 para Casas) para este ejemplo quedaría asi:

api.wasi.co/v1/location/country/1?quantity=true&id_property_type=1

Si se quiere ver especificamente cuantas casas hay (Código 1 para Casas) que esten en venta, para este ejemplo quedaría asi:

api.wasi.co/v1/location/country/1?quantity=true&id_property_type=1&for_sale=true

Si se quiere ver especificamente cuantas propiedades hay activas que sean de empresas aliadas, para este ejemplo quedaría asi:

api.wasi.co/v1/location/country/1?quantity=true&scope=2

Todos los casos deberian retornar un JSON similar al siguiente:

{
    "id_country": "1",
    "name": "Colombia",
    "iso": "CO",
    "quantity": 102,
    "status": "success"
}

❗️ Importante

Para todas las peticiones es necesario el envío de credenciales, para más información puedes visitar la sección de Primeros pasos.

Last Updated: 3/8/2020 21:51:52