# Properties
The heart of real estate is the properties, Wasi stores detailed information of the properties and in this section you will see how you can manipulate it through the API.
# Get all the properties
❗️ Important
When all the properties are listed, there are some filters, see the section on Filter.
To get the list of all the properties in Wasi, you can count on the URI:
api.wasi.co/v1/property/search
This should return a JSON similar to this one:
{
"total": 2,
"0": {
"id_property": 1,
"id_company": 1,
"id_user": 1,
"for_sale": "true",
"for_rent": "true",
"for_transfer": "false",
"id_property_type": 14,
"id_country": 1,
"country_label": "Colombia",
"id_region": 26,
"region_label": "Quindio",
"id_city": 63,
"city_label": "Armenia",
"id_location": 0,
"location_label": "",
"id_zone": 0,
"zone_label": "",
"id_currency": 1,
"iso_currency": "COP",
"name_currency": "Pesos Colombianos",
"title": "SV65850-44301",
"address": "Av/ de la peseta # 110 - 25",
"area": "79",
"id_unit_area": "1",
"unit_area_label": "M2",
"built_area": "",
"id_unit_built_area": "1",
"unit_built_area_label": "M2",
"private_area": "",
"id_unit_private_area": "1",
"unit_private_area_label": "M2",
"maintenance_fee": "0",
"sale_price": "150000000",
"sale_price_label": "$150.000.000",
"rent_price": "0",
"rent_price_label": "$0",
"bedrooms": "2",
"bathrooms": "1",
"garages": "0",
"floor": "",
"observations": "Aqui las observaciones del ejemplo 1",
"video": "https:\/\/vimeo.com\/88462167",
"id_property_condition": "2",
"property_condition_label": "Used",
"id_status_on_page": "3",
"status_on_page_label": "Outstanding",
"map": "",
"latitude": "",
"longitude": "",
"building_date": "",
"network_share": false,
"visits": 79,
"created_at": "2015-09-07 16:22:45",
"updated_at": "2016-04-06 14:40:01",
"reference": "",
"comment": "",
"id_rents_type": "4",
"rents_type_label": "Monthly",
"zip_code": "",
"id_availability": "2",
"availability_label": "Sold",
"id_publish_on_map": "1",
"publish_on_map_label": "Do not post",
"main_image": {
"id_gallery": "112861",
"id_image": "4096458",
"url": "https:\/\/images.wasi.co\/eyJidWNrZXQiOiJzdciLCJlZGl0cyI6eyJub3JtYWxp",
"url_big": "https:\/\/images.wasi.co\/eyJidWNrZXQiOiJzdciLCJlZGl0cyI6eyJub3JtYWxp",
"url_original": "https:\/\/images.wasi.co\/inmuebles\/ejemplo13.jpg",
"description": "",
"position": "1"
},
"galleries": [
{
"id": "112861",
"0": {
"id": "4096458",
"url": "https:\/\/images.wasi.co\/eyJidWNrZXQiOiJzdciLCJlZGl0cyI6eyJub3JtYWxp",
"url_big": "https:\/\/images.wasi.co\/eyJidWNrZXQiOiJzdciLCJlZGl0cyI6eyJub3JtYWxp",
"url_original": "https:\/\/images.wasi.co\/inmuebles\/ejemplo15.jpg",
"description": "",
"position": "1"
},
"1": {
"id": "4096459",
"url": "https:\/\/images.wasi.co\/eyJidWNrZXQiOiJzdciLCJlZGl0cyI6eyJub3JtYWxp",
"url_big": "https:\/\/images.wasi.co\/eyJidWNrZXQiOiJzdciLCJlZGl0cyI6eyJub3JtYWxp",
"url_original": "https:\/\/images.wasi.co\/inmuebles\/ejemplo16.jpg",
"description": "",
"position": "2"
},
"2": {
"id": "4096460",
"url": "https:\/\/images.wasi.co\/eyJidWNrZXQiOiJzdGF0aWNiIiwia2V5IjoiaW5tdWVibGVzXC9iN",
"url_big": "https:\/\/images.wasi.co\/eyJidWNrZXQiOiJzdciLCJlZGl0cyI6eyJub3JtYWxp",
"url_original": "https:\/\/images.wasi.co\/inmuebles\/ejemplo17.jpg",
"description": "",
"position": "3"
}
}
],
"features": {
"internal": [
{
"id": "84",
"nombre": "Armarios empotrados",
"name": ""
},
{
"id": "5",
"nombre": "Balcón",
"name": ""
}
],
"external": [
{
"id": "78",
"nombre": "Área social",
"name": ""
}
]
},
"label": "Parque central",
"owner": "own"
},
"1": {
"id_property": 2,
"id_company": 1,
"id_user": 1,
"for_sale": "true",
"for_rent": "true",
"for_transfer": "false",
"id_property_type": 7,
"id_country": 1,
"country_label": "Colombia",
"id_region": 26,
"region_label": "Quindio",
"id_city": 129,
"city_label": "Calarca",
"id_location": 0,
"location_label": "",
"id_zone": 22170,
"zone_label": "Vereda",
"id_currency": 1,
"iso_currency": "COP",
"name_currency": "Pesos Colombianos",
"title": "Finca en venta El Paraiso, Vereda Floresta Calarca",
"address": "Finca el Paraiso, vereda la Floresta. Calarca, Quindio",
"area": "6400",
"id_unit_area": "1",
"unit_area_label": "M2",
"built_area": "",
"id_unit_built_area": "1",
"unit_built_area_label": "M2",
"maintenance_fee": "0",
"sale_price": "289000000",
"sale_price_label": "$289.000.000",
"rent_price": "0",
"rent_price_label": "$0",
"bedrooms": "4",
"bathrooms": "1",
"garages": "1",
"floor": "Rural",
"furnished": "false",
"observations": "Aqui las observaciones del ejemplo 2",
"video": "",
"id_property_condition": "2",
"property_condition_label": "Used",
"id_status_on_page": "3",
"status_on_page_label": "Outstanding",
"map": "4.529195895731443,-75.63777923583984",
"latitude": "4.529195895731443",
"longitude": "-75.63777923583984",
"building_date": "",
"network_share": true,
"visits": 404,
"created_at": "2015-07-08 07:39:18",
"updated_at": "2015-08-12 11:25:50",
"reference": "",
"comment": "",
"id_rents_type": "4",
"rents_type_label": "Monthly",
"zip_code": "630001",
"id_availability": "1",
"availability_label": "Available",
"id_publish_on_map": "1",
"publish_on_map_label": "Do not post",
"main_image": {
"id_gallery": "105232",
"id_image": "4052247",
"url": "https:\/\/images.wasi.co\/eyJidWNrZXQiOiJzdciLCJlZGl0cyI6eyJub3JtYWxp",
"url_big": "https:\/\/images.wasi.co\/eyJidWNrZXQiOiJzdciLCJlZGl0cyI6eyJub3JtYWxp",
"url_original": "https:\/\/images.wasi.co\/inmuebles\/ejemplo18.jpg",
"description": "",
"position": "1"
},
"galleries": [
{
"id": "105232",
"0": {
"id": "4052247",
"url": "https:\/\/images.wasi.co\/eyJidWNrZXQiOiJzdciLCJlZGl0cyI6eyJub3JtYWxp",
"url_big": "https:\/\/images.wasi.co\/eyJidWNrZXQiOiJzdciLCJlZGl0cyI6eyJub3JtYWxp",
"url_original": "https:\/\/images.wasi.co\/inmuebles\/ejemplo22.jpg",
"description": "",
"position": "1"
},
"1": {
"id": "4052248",
"url": "https:\/\/images.wasi.co\/eyJidWNrZXQiOiJzdciLCJlZGl0cyI6eyJub3JtYWxp",
"url_big": "https:\/\/images.wasi.co\/eyJidWNrZXQiOiJzdciLCJlZGl0cyI6eyJub3JtYWxp",
"url_original": "https:\/\/images.wasi.co\/inmuebles\/ejemplo24.jpg",
"description": "",
"position": "2"
},
"2": {
"id": "4052249",
"url": "https:\/\/images.wasi.co\/eyJidWNrZXQiOiJzdciLCJlZGl0cyI6eyJub3JtYWxp",
"url_big": "https:\/\/images.wasi.co\/eyJidWNrZXQiOiJzdciLCJlZGl0cyI6eyJub3JtYWxp",
"url_original": "https:\/\/images.wasi.co\/inmuebles\/ejemplo26.jpg",
"description": "",
"position": "3"
}
}
],
"features": {
"internal": [
{
"id": "2",
"nombre": "Alarma",
"name": ""
},
{
"id": "4",
"nombre": "Amoblado",
"name": ""
}
],
"external": [
{
"id": "53",
"nombre": "Árboles frutales",
"name": ""
}
]
},
"label": "",
"owner": "own"
},
"status": "success"
}
❗️ Note
The owner field in the JSON response indicates whether the property obtained is your own or an allied company's.
❗️ Important
If you send the short parameter with true value a reduced version of the property returns, without the Galleries and Features listing. These listings can be obtained independently as indicated in Property Galleries, and Property features.
# Obtain a property
To get a property in Wasi, you count on the URI:
api.wasi.co/v1/property/get/#id_property
For a sample property whose id_property is 1, the URI would be:
api.wasi.co/v1/property/get/1
This should return a JSON similar to this one:
{
"id_property": 1,
"id_company": 1,
"id_user": 1,
"for_sale": "true",
"for_rent": "true",
"for_transfer": "false",
"id_property_type": 14,
"id_country": 1,
"country_label": "Colombia",
"id_region": 26,
"region_label": "Quindio",
"id_city": 63,
"city_label": "Armenia",
"id_location": 0,
"location_label": "",
"id_zone": 0,
"zone_label": "",
"id_currency": 1,
"iso_currency": "COP",
"name_currency": "Pesos Colombianos",
"title": "SV65850-44301",
"address": "Av/ de la peseta # 110 - 25",
"area": "79",
"id_unit_area": "1",
"unit_area_label": "M2",
"built_area": "",
"id_unit_built_area": "1",
"unit_built_area_label": "M2",
"private_area": "",
"id_unit_private_area": "1",
"unit_private_area_label": "M2",
"maintenance_fee": "0",
"sale_price": "150000000",
"sale_price_label": "$150.000.000",
"rent_price": "0",
"rent_price_label": "$0",
"bedrooms": "2",
"bathrooms": "1",
"garages": "0",
"floor": "",
"observations": "Aqui las observaciones del ejemplo 1",
"video": "https:\/\/vimeo.com\/88462167",
"id_property_condition": "2",
"property_condition_label": "Used",
"id_status_on_page": "3",
"status_on_page_label": "Outstanding",
"map": "",
"latitude": "",
"longitude": "",
"building_date": "",
"network_share": false,
"visits": 79,
"created_at": "2015-09-07 16:22:45",
"updated_at": "2016-04-06 14:40:01",
"reference": "",
"comment": "",
"id_rents_type": "4",
"rents_type_label": "Monthly",
"zip_code": "",
"id_availability": "2",
"availability_label": "Sold",
"id_publish_on_map": "1",
"publish_on_map_label": "Do not post",
"main_image": {
"id_gallery": "112861",
"id_image": "4096458",
"url": "https:\/\/images.wasi.co\/eyJidWNrZXQiOiJzdciLCJlZGl0cyI6eyJub3JtYWxp",
"url_big": "https:\/\/images.wasi.co\/eyJidWNrZXQiOiJzdciLCJlZGl0cyI6eyJub3JtYWxp",
"url_original": "https:\/\/images.wasi.co\/inmuebles\/ejemplo12.jpg",
"description": "",
"position": "1"
},
"galleries": [
{
"id": "112861",
"0": {
"id": "4096458",
"url": "https:\/\/images.wasi.co\/eyJidWNrZXQiOiJzdciLCJlZGl0cyI6eyJub3JtYWxp",
"url_big": "https:\/\/images.wasi.co\/eyJidWNrZXQiOiJzdciLCJlZGl0cyI6eyJub3JtYWxp",
"url_original": "https:\/\/images.wasi.co\/inmuebles\/ejemplo12.jpg",
"description": "",
"position": "1"
},
"1": {
"id": "4096459",
"url": "https:\/\/images.wasi.co\/eyJidWNrZXQiOiJzdciLCJlZGl0cyI6eyJub3JtYWxp",
"url_big": "https:\/\/images.wasi.co\/eyJidWNrZXQiOiJzdciLCJlZGl0cyI6eyJub3JtYWxp",
"url_original": "https:\/\/images.wasi.co\/inmuebles\/ejemplo14.jpg",
"description": "",
"position": "2"
},
"2": {
"id": "4096460",
"url": "https:\/\/images.wasi.co\/eyJidWNrZXQiOiJzdciLCJlZGl0cyI6eyJub3JtYWxp",
"url_big": "https:\/\/images.wasi.co\/eyJidWNrZXQiOiJzdciLCJlZGl0cyI6eyJub3JtYWxp",
"url_original": "https:\/\/images.wasi.co\/inmuebles\/ejemplo16.jpg",
"description": "",
"position": "3"
}
}
],
"features": {
"internal": [
{
"id": "2",
"nombre": "Alarma",
"name": ""
},
{
"id": "4",
"nombre": "Amoblado",
"name": ""
},
{
"id": "84",
"nombre": "Armarios empotrados",
"name": ""
},
{
"id": "5",
"nombre": "Balcón",
"name": ""
}
],
"external": [
{
"id": "53",
"nombre": "Árboles frutales",
"name": ""
},
{
"id": "78",
"nombre": "Área social",
"name": ""
}
]
},
"label": "Parque central",
"owner": "own",
"status": "success"
}
The owner field in the JSON response indicates whether the property obtained is owned (own) or by an allied company (allied).
❗️ Important
If you send the short parameter with true value a reduced version of the property returns, without the Galleries and Features listing. These listings can be obtained independently as indicated in Property Galleries, and Property features.
# Additional filtering
They apply filtering options defined in the property's Image Galleries.
# Filters
All filters are optional, below are listed the existing filters for searching properties, see the Get all properties section.
| Filter | Type | Detail |
|---|---|---|
| match | String | Keywords to perform a search. |
| id_property | Number | Property identifier. |
| id_user | Number | User ID associated with the property. |
| title | String | Partial or full title to the property. |
| id_country | Number | Country identifier, see Countries. |
| id_region | Number | Region identifier, see Regions. |
| id_city | Number | City identifier, see Cities. |
| id_location | Number | Identifier of a location, see Locations. |
| id_zone | Number | Zone identifier, see Zones. |
| id_property_type | Number | Property type identifier, see Property types. |
| for_sale | Boolean | Property for sale. |
| for_rent | Boolean | Property is available for rent. |
| for_transfer | Boolean | This property is available for exchange. |
| min_bedrooms | Number | Minimum number of rooms in the property. |
| max_bedrooms | Number | Maximum number of rooms in the property. |
| bathrooms | Number | Minimum number of bathrooms on the property. |
| garages | Number | Minimum number of garages on the property. |
| id_status_on_page | Number | Property status identifier, see Status on page. |
| id_availability | Number | Property availability identifier, see Availability. |
| id_property_condition | Number | Identifier of the condition of the property, see the section Property Conditions. |
| building_date | Number | Minimum year of construction of the property. |
| min_price | Number | Minimum price of the property. |
| max_price | Number | Maximum price of the property. |
| min_private_area | Number | Minimum private area of the property. |
| max_private_area | Number | Maximum private area of the property. |
| min_built_area | Number | Minimum built up area of the property. |
| max_built_area | Number | Maximum built area of the property. |
| min_area | Number | Minimum area of the property. |
| max_area | Number | Maximum area of the property. |
| scope | Number | Indicates if own or allied properties are listed, see scope. |
| short | Boolean | If sent as true, the Galleries, and Property features listings are not shown in the response. |
It is possible to fit properties in several zones, to do this in the property id_zone you must add the Identifier of the zones separated by a comma ( , ).
❗️ Important
If the short parameter is sent with true value a reduced version of the property returns, without the Galleries and Features listing. These listings can be obtained independently as indicated in Property Galleries, and Property features.
# Additional filtering
They apply filtering options defined in the property's Image Galleries.
| Filter | Type | |
|---|---|---|
| lax_business_type | Boolean | The value of lax_business_type is false by default. When lax_business_type is true, properties that meet at least one of the business type filters (for_sale, for_rent, for_transfer) sent as true are listed. When lax_business_type is false the properties that meet all business type filters (for_sale, for_rent, for_transfer) sent as true are listed. |
# Paging and sorting
| Filter | Type | |
|---|---|---|
| skip | Number | Offset, indicates from where the records are displayed, 0 by default (from the beginning, without omitting any). |
| take | Number | Limit, number of items to be listed, 10 by default (100 maximum) |
| order | String | You can take two values asc (Ascending) and desc (Descending), descending by default. |
| order_by | String | Sort by a specific criterion, id_property by default see order_by. |
# order_by
| Value | Description |
|---|---|
| id_property | Sort the properties by id. |
| title | Sort the properties by title. |
| id_country | Sort the properties by country. |
| id_region | Sort the properties by region. |
| id_city | Sort the properties by city. |
| id_property_type | Sort the properties by type. |
| id_business_type | Sort the properties according to your type of business. |
| sale_price | Sort the properties by their sales price. |
| rent_price | Sort the properties by their rental price. |
| visits | Sort the properties by their number of visits. |
| id_status_on_page | Sort properties by state, see State on page. |
| created_at | Sort the properties by date of registration. |
| max_price | Sort properties by price from highest to lowest. |
| min_price | Sort properties by price from lowest to highest. |
# Scope
| Value | Represents |
|---|---|
| 1 | Private, lists only properties created by the company. |
| 2 | Allies, lists only active properties of allied companies. |
| 3 | All, lists private properties and active properties of partner companies. (default option) |
| 4 | Group, only active properties in groups are counted. |
# Add a property
To add a new property in Wasi, you have the URI:
api.wasi.co/v1/property/add
To know which are the parameters that must be sent you can see the section Property fields, the fields that we can send as parameter in the table must appear as modifiable.
After sending the parameters correctly you should return a JSON like the one below:
{
"id_property": 123456,
"status": "success"
}
❗️ Important
Parameters can be sent via GET or via POST, as well as remembering that for all requests it is also necessary to send the access credentials, see Access Credentials.
❗️ Note
Once the property is created it is automatically sent to the allied portals assigned in the portals field.
# Update property
To update a property in Wasi, you have the URI:
api.wasi.co/v1/property/update/#id_property
For a sample property whose id_property is 1, the URI would be:
api.wasi.co/v1/property/update/1
To know which are the fields that can be updated you can see the section Property fields, the fields that we can send as parameter in the table must appear as modifiable.
For example if you want to change the agent with id_user 1 for the agent with id_user 2 of the property with id_property 3, you should do the following
api.wasi.co/v1/property/update/3?id_user=2
Should return a JSON like the next one:
{
"status": "success"
}
❗️ Important
The parameters to be modified can be sent via GET or via POST, as well as remembering that for all requests it is also necessary to send the access credentials, see Access Credentials.
❗️ Note
Once the property is updated it is automatically sent to the allied portals assigned in the portals field.
# Upload an image
To upload an image of a property in Wasi, you can count on the URI:
api.wasi.co/v1/property/upload-image/#id_property
To upload an image to the example property whose id_property is 1, the URI would be:
api.wasi.co/v1/property/upload-image/1
The image (file) must be sent in the parameter called image, the supported formats are PNG, JPEG, JPG and GIF. The following table lists the parameters supported by the image upload URI:
| Parameter | Type | Description |
|---|---|---|
| image | File | It is the file that is sent from an html form (PNG, JPEG, JPG and GIF) that you want to upload. |
| description | String | Specific description of the uploaded image. |
| position | Number | Indicates the position of the image with respect to the others. |
❗️ Important
The images can be uploaded using the api from an html form or also upload images that are previously hosted on a server. Below is how it could be done from PHP (using cURL).
$path = realpath('./img/photo1234.png');
$post = ['image' => new \CURLFile($path, 'text/plain', 'photo1234.png')];
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'http://api.wasi.co/v1/property/upload-image/1234?id_company=1234&wasi_token=my_token');
curl_setopt($ch, CURLOPT_POST,1);
curl_setopt($ch, CURLOPT_POSTFIELDS, $post);
curl_setopt($ch, CURLOPT_RETURNTRANSFER,1);
$result=curl_exec ($ch);
curl_close ($ch);
# Updating in portals
If you wish to update the images of the property in the allied portals, you can make an additional request to the URI:
api.wasi.co/v1/portal/send-property/#id_property
# Update data of an image
Para actualizar los datos de una imagen de una propiedad en Wasi, tienes la URI:
api.wasi.co/v1/gallery/image/update-data/#id_image
To update the data of an example image whose id_image is 1 and belongs to the property 2, the URI would be
api.wasi.co/v1/gallery/image/update-data/1?id_property=2
The following table lists the parameters supported by the URI:
| Parameter | Type | Description |
|---|---|---|
| id_property | Int | Identifier of the property to which the image belongs. Required. |
| description | String | Specific description of the uploaded image. |
| position | Number | Indicates the position of the image in relation to the others. |
❗️ Important
The parameters to be modified can be sent via GET or via POST, as well as remembering that for all requests it is also necessary to send the access credentials, see Access Credentials.
# Change/Remove Label
# Change label
You can change a property label with the URI:
POST api.wasi.co/v1/property/change-label/#id_property
You must send the label identifier.
# Parameters
| Name | Type | Detail |
|---|---|---|
| id_label | Number | Label identifier, see Labels for properties. |
If everything is in order, this should return a JSON similar to the next:
{
"status": "success"
}
# Remove label
If you want to remove the property label you can use the URI:
POST api.wasi.co/v1/property/remove-label/#id_property
If everything is in order, this should return a JSON similar to the next:
{
"status": "success"
}
❗️ Important
For all the requests it is necessary to send credentials, for more information you can visit the First steps section.
# Property types
To get the list of all property types supported by Wasi you should use the URI:
api.wasi.co/v1/property-type/all
This should return a JSON similar to the following:
{
"0": {
"id_property_type": "1",
"name": "",
"nombre": "Casa"
},
"1": {
"id_property_type": "2",
"name": "",
"nombre": "Apartamento"
},
"2": {
"id_property_type": "3",
"name": "",
"nombre": "Local"
},
"status": "success"
}
# Quantities by Property Type
Wasi's API allows to obtain the amount of properties based on their type (adding the variable quantity). This URI receives the following parameters:
| Name | Type | |
|---|---|---|
| quantity | Boolean | Boolean value (true or false) required to obtain the amount of property based on its type. |
| for_sale | Boolean | Boolean value (true or false) that indicates if the properties are available for sale or not. |
| for_rent | Boolean | Boolean value (true or false) that indicates if the properties are available for rent or not. |
| for_transfer | Boolean | Valor booleano (true o false) que indica si el inmuebles estan disponibles para permutar. |
| id_country | Number | Country identifier of the properties, see section Countries. |
| id_region | Number | Property region identifier, see the Regions section. |
| id_city | Number | Property city identifier, see the Cities section. |
| id_location | Number | Property location identifier, see the Locations section. |
| scope | Number | Indicates whether the quantity is obtained by counting own or allied properties, see scope. |
# Scope
| Value | Represents |
|---|---|
| 1 | Private, only properties created by the company count. |
| 2 | Allies, only active properties of allied companies count. |
| 3 | All, counts private properties and active properties of allied companies (default). |
| 4 | Group, only active properties in groups are counted. |
To obtain the quantities in general can be used:
api.wasi.co/v1/location/all-countries?quantity=true
If you want to see specifically the number of properties in a Zone with the hypothetical code 123, it would look like this:
api.wasi.co/v1/property-type/all?quantity=true&id_zone=123
If you want to see specifically the number of properties in the Armenian city (Code 63), it would look like this:
api.wasi.co/v1/property-type/all?quantity=true&id_city=63
If you want to see specifically the number of properties in the Chapinero location (Code 1), it would look like this:
api.wasi.co/v1/property-type/all?quantity=true&id_location=1
If you want to see specifically the amount of properties in the Quindio region (Code 26), it would look like this:
api.wasi.co/v1/property-type/all?quantity=true&id_region=26
If you want to see specifically the amount of properties in the country Colombia (Code 1), it would be like this:
api.wasi.co/v1/property-type/all?quantity=true&id_country=1
If you want to see the type of business, for example for sale or exchange in Colombia (Code 1), it would look like this:
api.wasi.co/v1/property-type/all?quantity=true&for_sale=true&for_transfer=true&id_country=1
If you want to see the type of business, for example for the sale of allied companies, it would be like this:
api.wasi.co/v1/property-type/all?quantity=true&for_sale=true&scope=2
❗️ Important
In the case of sending several location criteria together, only the most atomic value will be taken, that is, first id_zone, if there is no id_location, if there is no id_city, if there is no id_region and finally if there is none of the above the criterion would be id_country.
It is possible to fit properties in several zones, for this purpose in the property id_zone you must add the IDs of the zones separated by a comma ( , ).
This cases should return a JSON similar to this one:
{
"0": {
"id_property_type": "1",
"name": "",
"nombre": "Casa",
"quantity": 15
},
"1": {
"id_property_type": "2",
"name": "",
"nombre": "Apartamento",
"quantity": 10
},
"2": {
"id_property_type": "3",
"name": "",
"nombre": "Local",
"quantity": 1
},
"status": "success"
}
❗️ Important
For all the requests it is necessary to send credentials, for more information you can visit the section Getting started.
# Prices range
The API of Wasi allows to obtain in a simple way the maximums and minimums of the prices for sale as rent of all the properties, for this we have the URI:
api.wasi.co/v1/property/price-range
This should return a JSON similar to this one:
{
"max_sale_price":"450000000",
"min_sale_price":"200000000",
"max_rent_price":"1900000",
"min_rent_price":"450000",
"status":"success"
}
| Name | Represents |
|---|---|
| max_sale_price | It is the maximum value found in the sales price of own or partner properties. |
| min_sale_price | Is the minimum value found in the sales price of own or partner properties. |
| max_rent_price | Is the maximum value found in the rent/lease/rental price of own or partner properties. |
| min_rent_price | Is the minimum value found in the rental price/rent/rent of own or partner properties. |
# Areas range
The API of Wasi allows to obtain in a simple way the maximums and minimums of the areas of all the properties, for this we have the URI:
api.wasi.co/v1/property/area-range
This should return a JSON similar to this one:
{
"max_private_area": "55",
"min_private_area": "",
"max_built_area": "65",
"min_built_area": "",
"max_area": "110",
"min_area": "",
"status": "success"
}
| Name | Represents |
|---|---|
| max_private_area | Is the maximum value found in the private area of own or partner properties. |
| min_private_area | Is the minimum value found in the private area of the own or partner properties. |
| max_built_area | Is the maximum value found in the built area of own or partner properties. |
| min_built_area | Is the minimum value found in the built area of own or partner properties. |
| max_area | Is the maximum value found in the area of own or partner properties. |
| min_area | Is the minimum value found in the area of own or partner properties. |
# Quantities by Business type
The API of Wasi allows to obtain in a simple way the total of properties according to the type of business and the location of the same, for this we have the URI:
api.wasi.co/v1/property-business-type/quantity
This URI receives the following parameters:
| Name | Type | |
|---|---|---|
| for_sale | Boolean | Boolean value (true or false) which indicates whether the properties are available for sale or not. |
| for_rent | Boolean | Boolean value (true or false) which indicates whether the properties are available for rent (hire, lease) or not. |
| for_transfer | Boolean | Boolean value (true or false) which indicates if the property is available for exchange. |
| id_country | Number | Country identifier of the properties, see section Countries. |
| id_region | Number | Region identifier of the properties, see section Regions. |
| id_city | Number | Property city identifier, see the Cities section. |
| id_location | Number | Property location identifier, see the Locations section. |
| id_zone | Number | Property location identifier, see the Zones section. |
| scope | Number | Indicates if the quantity is obtained by counting the own or allied properties, see scope. |
❗️ Note
It is possible to fit properties in several zones. To do this, in the id_zone property, the zone identifiers must be added, separated by a comma ( , ).
# Scope
| Value | Represents |
|---|---|
| 1 | Private, only properties created by the company count. |
| 2 | Allies, only active properties of allied companies count. |
| 3 | All, counts private properties and active properties of allied companies (default). |
| 4 | Group, only active properties in groups are counted. |
❗️ Important
At least one of the three Boolean variables (for_sale, for_rent, for_transfer) must be specified as true, variables referring to the location are optional.
For example to request the total of properties for sale or exchange in Colombia can be done as follows:
api.wasi.co/v1/property-business-type/quantity?for_sale=true&for_transfer=true&id_country=1
This should return a JSON similar to this one:
{
"quantity": 28,
"status": "success"
}
# Publish on Google maps
The properties latitude and longitude are modified to store the coordinates of Google maps, these can take values such as
latitude: 4.5666285875039145
longitude: -75.74845790863037
The read-only property map (obtained when consulting properties) stores a String with the Google maps coordinates (latitude and longitude) separated by a comma, for example these three possible values:
4.5666285875039145,-75.74845790863037
4.467523992463404,-75.76628923416138
9.168449747185411,-79.57414627075195
# Image galleries
The galleries within the JSON of the property follow the following structure:
[
{
"id": "1",
"0": {
"id": "1",
"url": "https:\/\/images.wasi.co\/eyJidWNrZXQiOiJzdciLCJlZGl0cyI6eyJub3JtYWxp",
"url_big": "https:\/\/images.wasi.co\/eyJidWNrZXQiOiJzdciLCJlZGl0cyI6eyJub3JtYWxp",
"url_original": "https:\/\/images.wasi.co\/inmuebles\/ejemplo8.jpg",
"description": "",
"position": "1"
},
"1": {
"id": "2",
"url": "https:\/\/images.wasi.co\/eyJidWNrZXQiOiJzdciLCJlZGl0cyI6eyJub3JtYWxp",
"url_big": "https:\/\/images.wasi.co\/eyJidWNrZXQiOiJzdciLCJlZGl0cyI6eyJub3JtYWxp",
"url_original": "https:\/\/images.wasi.co\/inmuebles\/ejemplo9.jpg",
"description": "",
"position": "2"
},
"2": {
"id": "3",
"url": "https:\/\/images.wasi.co\/eyJidWNrZXQiOiJzdciLCJlZGl0cyI6eyJub3JtYWxp",
"url_big": "https:\/\/images.wasi.co\/eyJidWNrZXQiOiJzdciLCJlZGl0cyI6eyJub3JtYWxp",
"url_original": "https:\/\/images.wasi.co\/inmuebles\/ejemplo10.jpg",
"description": "",
"position": "3"
}
},
{
"id": "2",
"0": {
"id": "4",
"url": "https:\/\/images.wasi.co\/eyJidWNrZXQiOiJzdciLCJlZGl0cyI6eyJub3JtYWxp",
"url_big": "https:\/\/images.wasi.co\/eyJidWNrZXQiOiJzdciLCJlZGl0cyI6eyJub3JtYWxp",
"url_original": "https:\/\/images.wasi.co\/inmuebles\/ejemplo12.jpg",
"description": "",
"position": "1"
},
"1": {
"id": "5",
"url": "https:\/\/images.wasi.co\/eyJidWNrZXQiOiJzdciLCJlZGl0cyI6eyJub3JtYWxp",
"url_big": "https:\/\/images.wasi.co\/eyJidWNrZXQiOiJzdciLCJlZGl0cyI6eyJub3JtYWxp",
"url_original": "https:\/\/images.wasi.co\/inmuebles\/ejemplo14.jpg",
"description": "",
"position": "2"
},
"2": {
"id": "6",
"url": "https:\/\/images.wasi.co\/inmuebles\/ejemplo15.jpg",
"url_big": "https:\/\/images.wasi.co\/inmuebles\/ejemplo16.jpg",
"description": "",
"position": "3"
}
}
]
# Obtain property galleries
To obtain all the galleries of a property, there is the following URI:
http://api.wasi.co/v1/gallery/all/#id_property
This should return a JSON similar to this one:
{
"0": {
"id_gallery": 1,
"id_property": 1
},
"total": 1,
"status": "success"
}
To obtain all the images in a gallery independently from the property consultation, there is the following URI:
http://api.wasi.co/v1/gallery/image/all/#id_gallery
This should return a JSON similar to this one:
{
"0": {
"id_image": 1,
"url": "https://images.wasi.co/eyJidWNrZXQiOiJzdciLCJlZGl0cyI6eyJub3JtYWxp",
"url_big": "https://images.wasi.co/eyJidWNrZXQiOiJzdciLCJlZGl0cyI6eyJub3JtYWxp",
"url_original": "https://images.wasi.co/inmuebles/gr_imagen1.jpg",
"description": "",
"filename": "gr_imagen1.jpg",
"position": 1
},
"1": {
"id_image": 2,
"url": "https://images.wasi.co/eyJidWNrZXQiOiJzdciLCJlZGl0cyI6eyJub3JtYWxp",
"url_big": "https://images.wasi.co/eyJidWNrZXQiOiJzdciLCJlZGl0cyI6eyJub3JtYWxp",
"url_original": "https://images.wasi.co/inmuebles/gr_imagen2.jpg",
"description": "",
"filename": "gr_imagen2.jpg",
"position": 2
},
"2": {
"id_image": 3,
"url": "https://images.wasi.co/eyJidWNrZXQiOiJzdciLCJlZGl0cyI6eyJub3JtYWxp",
"url_big": "https://images.wasi.co/eyJidWNrZXQiOiJzdciLCJlZGl0cyI6eyJub3JtYWxp",
"url_original": "https://images.wasi.co/inmuebles/gr_imagen3.jpg",
"description": "",
"filename": "gr_imagen3.jpg",
"position": 3
},
"id_gallery": 1,
"status": "success"
}
# Filters
The following is a list of existing filters for the image type.
| Filter | Type | Detail |
|---|---|---|
| size | String | Image size, accept the options: small, big, giant |
| watermark | Boolean | Image with watermark true, or without watermark false. |
# Features
When creating or editing a property you can send an array with the ids of the features in the features parameter, for example if you want to update the property with id 1234, so that it has the features with id 2 and 4, we can send this parameter both via URL and JSON and it would be something like this in the first case:
http://api.wasi.co/v1/property/update/1234?features[]=2&features[]=4
❗️ Important
The array of features is optional, however when it is sent it will be validated, if you are updating a property and do not send the array it will keep the existing values, if you send a new array it will replace the previous one.
# Show property features
The characteristics within the JSON when consulting a property follow the following structure:
"features": {
"internal": [
{
"id": "2",
"nombre": "Alarma",
"name": "",
"own": false
},
{
"id": "4",
"nombre": "Amoblado",
"name": "",
"own": false
},
{
"id": "84",
"nombre": "Armarios empotrados",
"name": "",
"own": false
},
{
"id": "5",
"nombre": "Balcón",
"name": "",
"own": false
},
{
"id": "6",
"nombre": "Característica personalizada",
"name": "",
"own": true
}
],
"external": [
{
"id": "53",
"nombre": "Árboles frutales",
"name": "",
"own": false
},
{
"id": "78",
"nombre": "Área social",
"name": "",
"own": false
}
]
},
# Obtain all the features
To get all the features supported by Wasi, there is the following URI:
http://api.wasi.co/v1/feature/all
This should return a JSON that groups the features according to whether they are internal or external similar to the following:
{
"internal": [
{
"id": "1",
"nombre": "Aire acondicionado",
"name": "",
"own": false
},
{
"id": "2",
"nombre": "Alarma",
"name": "",
"own": false
},
{
"id": "4",
"nombre": "Amoblado",
"name": "",
"own": false
},
{
"id": "6",
"nombre": "Característica personalizada",
"name": "",
"own": true
}
],
"external": [
{
"id": "25",
"nombre": "Cancha de squash",
"name": "",
"own": false
},
{
"id": "26",
"nombre": "Cancha de tenis",
"name": "",
"own": false
},
{
"id": "27",
"nombre": "Zonas deportivas",
"name": "",
"own": false
}
],
"status": "success"
}
# Filter
| Filter | Type | Detail |
|---|---|---|
| type | String | It can take two values internal and external. |
| list | Boolean | Indicates if the answer is shown in a list without separation by type. |
If the list parameter is sent with a true value, the characteristics are displayed in a single array, with the following format:
{
"0": {
"id": 1,
"nombre": "Aire acondicionado",
"name": "",
"type": "Internal",
"own": false
},
"1": {
"id": 2,
"nombre": "Alarma",
"name": "",
"type": "Internal",
"own": false
},
"2": {
"id": 4,
"nombre": "Amoblado",
"name": "",
"type": "Internal",
"own": false
},
"23": {
"id": 25,
"nombre": "Cancha de squash",
"name": "",
"type": "External",
"own": false
},
"24": {
"id": 26,
"nombre": "Cancha de tenis",
"name": "",
"type": "External",
"own": false
},
"25": {
"id": 27,
"nombre": "Zonas deportivas",
"name": "",
"type": "External",
"own": false
},
"26": {
"id": 28,
"nombre": "Gimnasio",
"name": "",
"type": "External",
"own": false
},
"27": {
"id": 29,
"nombre": "Jardín",
"name": "",
"type": "External",
"own": false
},
"28": {
"id": 30,
"nombre": "Patio",
"name": "",
"type": "External",
"own": false
},
{
"id": "6",
"nombre": "Característica personalizada",
"name": "",
"own": true
},
"status": "success"
}
# Energy Certificate
To consult and update the information of Energy Certificate of the property.
❗️ Nota
This information only applies to properties in Spain.
# Query Energy Certificate
To consult the Energy Certificate of a property in Wasi, you have the URI:
api.wasi.co/v1/property/energy-certificate/get/#id_property
For example for a property whose id_property is 1, the URI would be:
api.wasi.co/v1/property/energy-certificate/get/1
After sending the parameters correctly you should return a JSON like the one below:
{
"is_certified": "Yes",
"certificate_type": "Projects",
"energy_rating": "E",
"ipe": 0,
"status": "success"
}
# Update Energy Certificate
To update the Energy Certificate of a property in Wasi, you have the URI:
api.wasi.co/v1/property/energy-certificate/update/#id_property
For example, for a property whose id_property is 1, and you want to update and indicate that it has a certificate of type Projects, with energy rating C and IPE 50, the URI would be:
api.wasi.co/v1/property/energy-certificate/update/1?is_certified=2&certificate_type=2&energy_rating=5&ipe=50
# Owners
You can get the owners of a property with the following URI:
api.wasi.co/v1/property/owner/#id_property
If everything is in order, this should return a JSON similar to the next:
{
"0": {
"id_client": 1,
"id_user": 1,
"id_client_type": 5,
"id_country": 1,
"country_label": "Colombia",
"id_region": 26,
"region_label": "Quindío",
"id_city": 63,
"city_label": "Armenia",
"id_client_status": 1,
"first_name": "John",
"last_name": "Doe",
"birthday": "1948-10-10",
"identification": "",
"email": "[email protected]",
"phone": "7111111",
"cell_phone": "3111111111",
"address": "Calle 1 # 1-11",
"query": "",
"comment": "",
"reference": "",
"send_information": true,
"created_at": "2011-09-11 17:12:12",
"updated_at": "0000-00-00 00:00:00"
},
"total": 1,
"status": "success"
}
# Paginate
| Filter | Type | Represents |
|---|---|---|
| skip | Number | Offset, indicates from where the records are displayed, 0 by default (from the start, without omitting any). |
| take | Number | Limit, number of items to be listed, 10 by default (100 maximum). |
❗️ Important
For all the requests it is necessary to send credentials, for more information you can visit the section Getting started.
# Allied portals
When creating or editing a property you can send an array with the ids of the portals in the portals parameter, for example if you want to update the property with id 1234, so that it synchronizes with the portals with id 2 and 4, we can send this parameter both via URL and JSON and it would be something like this in the first case:
http://api.wasi.co/v1/property/update/1234?portals[]=2&portals[]=4
❗️ Important
The portal array is optional, however when it is sent it will be validated, if a property is being updated and the array is not sent it will keep the existing values, if a new array is sent it will replace the previous one.
❗️ Important
When a new property is added and an array of portals is not sent, by default it will be created with all active portals for synchronization.
Wasi's API allows to obtain the list of valid allied portals for the company, for this we have the URI:
api.wasi.co/v1/portal/all
This should return a JSON similar to this one:
{
"0": {
"id": 43,
"name": "Mercadolibre"
},
"1": {
"id": 30,
"name": "Icasas"
},
"2": {
"id": 44,
"name": "Inmuebles24"
},
"3": {
"id": 22,
"name": "Goplaceit"
},
"4": {
"id": 2,
"name": "Lamudi"
},
"5": {
"id": 50,
"name": "Vivanuncios"
},
"6": {
"id": 24,
"name": "Tuad"
},
"7": {
"id": 32,
"name": "Los compradores"
},
"status": "success"
}
The following URI is used to request portal status information regarding a property:
api.wasi.co/v1/portal/property/#id_property
This should return a JSON similar to this one:
{
"0": {
"id": 43,
"name": "Mercadolibre",
"active": true
},
"1": {
"id": 30,
"name": "Icasas",
"active": false
},
"2": {
"id": 44,
"name": "Inmuebles24",
"active": false
},
"3": {
"id": 22,
"name": "Goplaceit",
"active": false
},
"4": {
"id": 2,
"name": "Lamudi",
"active": false
},
"5": {
"id": 50,
"name": "Vivanuncios",
"active": true
},
"6": {
"id": 24,
"name": "Tuad",
"active": false
},
"7": {
"id": 32,
"name": "Los compradores",
"active": true
},
"status": "success"
}
# Property clients
You can get the clients associated to a property with the following URI:
api.wasi.co/v1/property/clients/#id_property
If everything is in order, this should return a JSON similar to the next:
{
"0": {
"id_client": 1234,
"first_name": "Pepito Perez",
"last_name": "Perez",
"id_client_type": 5,
"client_type_label": "Propietario",
"id_user": 1234,
"id_country": 1,
"country_label": "Colombia",
"id_region": 26,
"region_label": "Quindío",
"id_city": 63,
"city_label": "Armenia",
"id_client_status": 2,
"client_status_label": "En Proceso",
"birthday": "0000-00-00",
"identification": "",
"email": "[email protected]",
"phone": "",
"cell_phone": "1234567",
"address": "",
"query": "",
"comment": "",
"reference": "",
"send_information": true,
"created_at": "2015-04-15 11:26:52",
"updated_at": "2019-03-29 11:18:50"
},
"1": {
"id_client": 1235,
"first_name": "Joe",
"last_name": "Doe",
"id_client_type": 1,
"client_type_label": "Comprador",
"id_user": 1234,
"id_country": 1,
"country_label": "Colombia",
"id_region": 26,
"region_label": "Quindío",
"id_city": 63,
"city_label": "Armenia",
"id_client_status": 2,
"client_status_label": "En Proceso",
"birthday": "0000-00-00",
"identification": "",
"email": "[email protected]",
"phone": "",
"cell_phone": "1234567",
"address": "",
"query": "",
"comment": "",
"reference": "",
"send_information": true,
"created_at": "2015-04-15 11:26:52",
"updated_at": "2019-03-29 11:18:50"
},
"total": 2,
"status": "success"
}
❗️ Important
The value returned id_client_type corresponds to the type of association of the client with the property, it is a different value than the one obtained when consulting the type of the client directly.
# Filters
The filters are optional, below are listed the existing filters for the client search.
| Filter | Type | Detail |
|---|---|---|
| id_client_type | Number | Client type identifier, see Client types. |
# Paginate
| Filter | Type | |
|---|---|---|
| skip | Number | Offset, indicates from where the records are displayed, 0 by default (from the start, without omitting any). |
| take | Number | Limit, number of items to be listed, 10 by default (100 maximum) |
❗️ Important
For all requests it is necessary to send credentials, for more information you can visit the section Getting started.
# Highlighted properties
You can obtain the highlighted properties with the following 'URI':
api.wasi.co/v1/property/highlighted/
If everything is in order, this should return a JSON similar to the next:
{
"0": {
"id_property": 1,
"id_company": 1,
"id_user": 1,
"for_sale": "true",
"for_rent": "true",
"for_transfer": "false",
"id_property_type": 14,
"id_country": 1,
"country_label": "Colombia",
"id_region": 26,
"region_label": "Quindio",
"id_city": 63,
"city_label": "Armenia",
"id_location": 0,
"location_label": "",
"id_zone": 0,
"zone_label": "",
"id_currency": 1,
"iso_currency": "COP",
"name_currency": "Pesos Colombianos",
"title": "SV65850-44301",
"address": "Av/ de la peseta # 110 - 25",
"area": "79",
"id_unit_area": "1",
"unit_area_label": "M2",
"built_area": "",
"id_unit_built_area": "1",
"unit_built_area_label": "M2",
"private_area": "",
"id_unit_private_area": "1",
"unit_private_area_label": "M2",
"maintenance_fee": "0",
"sale_price": "150000000",
"sale_price_label": "$150.000.000",
"rent_price": "0",
"rent_price_label": "$0",
"bedrooms": "2",
"bathrooms": "1",
"garages": "0",
"floor": "",
"observations": "Aqui las observaciones del ejemplo 1",
"video": "https:\/\/vimeo.com\/88462167",
"id_property_condition": "2",
"property_condition_label": "Used",
"id_status_on_page": "3",
"status_on_page_label": "Outstanding",
"map": "",
"latitude": "",
"longitude": "",
"building_date": "",
"network_share": false,
"visits": 79,
"created_at": "2015-09-07 16:22:45",
"updated_at": "2016-04-06 14:40:01",
"reference": "",
"comment": "",
"id_rents_type": "4",
"rents_type_label": "Monthly",
"zip_code": "",
"id_availability": "2",
"availability_label": "Sold",
"id_publish_on_map": "1",
"publish_on_map_label": "Do not post",
"main_image": {
"id_gallery": "112861",
"id_image": "4096458",
"url": "https:\/\/images.wasi.co\/eyJidWNrZXQiOiJzdciLCJlZGl0cyI6eyJub3JtYWxp",
"url_big": "https:\/\/images.wasi.co\/eyJidWNrZXQiOiJzdciLCJlZGl0cyI6eyJub3JtYWxp",
"url_original": "https:\/\/images.wasi.co\/inmuebles\/ejemplo12.jpg",
"description": "",
"position": "1"
},
"galleries": [
{
"id": "112861",
"0": {
"id": "4096458",
"url": "https:\/\/images.wasi.co\/eyJidWNrZXQiOiJzdciLCJlZGl0cyI6eyJub3JtYWxp",
"url_big": "https:\/\/images.wasi.co\/eyJidWNrZXQiOiJzdciLCJlZGl0cyI6eyJub3JtYWxp",
"url_original": "https:\/\/images.wasi.co\/inmuebles\/ejemplo12.jpg",
"description": "",
"position": "1"
},
"1": {
"id": "4096459",
"url": "https:\/\/images.wasi.co\/eyJidWNrZXQiOiJzdciLCJlZGl0cyI6eyJub3JtYWxp",
"url_big": "https:\/\/images.wasi.co\/eyJidWNrZXQiOiJzdciLCJlZGl0cyI6eyJub3JtYWxp",
"url_original": "https:\/\/images.wasi.co\/inmuebles\/ejemplo14.jpg",
"description": "",
"position": "2"
},
"2": {
"id": "4096460",
"url": "https:\/\/images.wasi.co\/eyJidWNrZXQiOiJzdciLCJlZGl0cyI6eyJub3JtYWxp",
"url_big": "https:\/\/images.wasi.co\/eyJidWNrZXQiOiJzdciLCJlZGl0cyI6eyJub3JtYWxp",
"url_original": "https:\/\/images.wasi.co\/inmuebles\/ejemplo16.jpg",
"description": "",
"position": "3"
}
}
],
"features": {
"internal": [
{
"id": "84",
"nombre": "Armarios empotrados",
"name": ""
},
{
"id": "5",
"nombre": "Balcón",
"name": ""
}
],
"external": [
{
"id": "78",
"nombre": "Área social",
"name": ""
}
]
},
"label": "Parque central",
"owner": "own"
},
"1": {
"id_property": 2,
"id_company": 1,
"id_user": 1,
"for_sale": "true",
"for_rent": "true",
"for_transfer": "false",
"id_property_type": 7,
"id_country": 1,
"country_label": "Colombia",
"id_region": 26,
"region_label": "Quindio",
"id_city": 129,
"city_label": "Calarca",
"id_location": 0,
"location_label": "",
"id_zone": 22170,
"zone_label": "Vereda",
"id_currency": 1,
"iso_currency": "COP",
"title": "Finca en venta El Paraiso, Vereda Floresta Calarca",
"address": "Finca el Paraiso, vereda la Floresta. Calarca, Quindio",
"area": "6400",
"id_unit_area": "1",
"unit_area_label": "M2",
"built_area": "",
"id_unit_built_area": "1",
"unit_built_area_label": "M2",
"maintenance_fee": "0",
"sale_price": "289000000",
"sale_price_label": "$289.000.000",
"rent_price": "0",
"rent_price_label": "$0",
"bedrooms": "4",
"bathrooms": "1",
"garages": "1",
"floor": "Rural",
"furnished": "false",
"observations": "Aqui las observaciones del ejemplo 2",
"video": "",
"id_property_condition": "2",
"property_condition_label": "Used",
"id_status_on_page": "3",
"status_on_page_label": "Outstanding",
"map": "4.529195895731443,-75.63777923583984",
"latitude": "4.529195895731443",
"longitude": "-75.63777923583984",
"building_date": "",
"network_share": true,
"visits": 404,
"created_at": "2015-07-08 07:39:18",
"updated_at": "2015-08-12 11:25:50",
"reference": "",
"comment": "",
"id_rents_type": "4",
"rents_type_label": "Monthly",
"zip_code": "630001",
"id_availability": "1",
"availability_label": "Available",
"id_publish_on_map": "1",
"publish_on_map_label": "Do not post",
"main_image": {
"id_gallery": "105232",
"id_image": "4052247",
"url": "https:\/\/images.wasi.co\/eyJidWNrZXQiOiJzdciLCJlZGl0cyI6eyJub3JtYWxp",
"url_big": "https:\/\/images.wasi.co\/eyJidWNrZXQiOiJzdciLCJlZGl0cyI6eyJub3JtYWxp",
"url_original": "https:\/\/images.wasi.co\/inmuebles\/ejemplo22.jpg",
"description": "",
"position": "1"
},
"galleries": [
{
"id": "105232",
"0": {
"id": "4052247",
"url": "https:\/\/images.wasi.co\/eyJidWNrZXQiOiJzdciLCJlZGl0cyI6eyJub3JtYWxp",
"url_big": "https:\/\/images.wasi.co\/eyJidWNrZXQiOiJzdciLCJlZGl0cyI6eyJub3JtYWxp",
"url_original": "https:\/\/images.wasi.co\/inmuebles\/ejemplo22.jpg",
"description": "",
"position": "1"
},
"1": {
"id": "4052248",
"url": "https:\/\/images.wasi.co\/eyJidWNrZXQiOiJzdciLCJlZGl0cyI6eyJub3JtYWxp",
"url_big": "https:\/\/images.wasi.co\/eyJidWNrZXQiOiJzdciLCJlZGl0cyI6eyJub3JtYWxp",
"url_original": "https:\/\/images.wasi.co\/inmuebles\/ejemplo24.jpg",
"description": "",
"position": "2"
},
"2": {
"id": "4052249",
"url": "https:\/\/images.wasi.co\/eyJidWNrZXQiOiJzdciLCJlZGl0cyI6eyJub3JtYWxp",
"url_big": "https:\/\/images.wasi.co\/eyJidWNrZXQiOiJzdciLCJlZGl0cyI6eyJub3JtYWxp",
"url_original": "https:\/\/images.wasi.co\/inmuebles\/ejemplo26.jpg",
"description": "",
"position": "3"
}
}
],
"features": {
"internal": [
{
"id": "2",
"nombre": "Alarma",
"name": ""
},
{
"id": "4",
"nombre": "Amoblado",
"name": ""
}
],
"external": [
{
"id": "53",
"nombre": "Árboles frutales",
"name": ""
}
]
},
"label": "",
"owner": "own"
},
"total": "2",
"status": "success"
}
❗️ Important
The number of returned properties is limited by the amount indicated in the Featured option in Configración sitio web.
# Filters
The following is a list of existing filters for the image type.
| Filter | Type | Detail |
|---|---|---|
| for_sale | Boolean | Property for sale. |
| for_rent | Boolean | Property available for rent. |
| for_transfer | Boolean | This property is available for exchange. |
| short | Boolean | If sent as true the Gallery and Features listings are not shown in the response. |
# Additional filters
They apply filtering options defined in the property's Image Galleries.
❗️ Important
If you send the short parameter with true value a reduced version of the property returns, without the Galleries and Features listing. These listings can be obtained independently as indicated in Property Galleries, and Property Features.
❗️ Important
For all requests it is necessary to send credentials, for more information you can visit the section Getting started.
# Share on social media
To share ownership in social networks you have the URI:
api.wasi.co/v1/property/social-sharing/#id_property
For example, for a property whose id_property is 1, and you want to publish it on facebook and twitter, the URI would be
api.wasi.co/v1/property/social-sharing/1?twitter=true&facebook=true
# Publish options
| Social media | Type | Description |
|---|---|---|
| Boolean | Indicates if the property should be shared in the social media facebook. | |
| Boolean | Indicates if the property should be shared on the twitter social media. |
❗️ Important
By logging in to wasi.co you can configure your social networks (Settings / General settings) and view the notifications that are generated in the publishing process.
# Generate PDF
For generate the PDF of a property you have the URI:
api.wasi.co/v1/property/make-pdf/#id_property
For example for a property whose id_property is 1, and you want to generate the PDF, the URI would be
api.wasi.co/v1/property/make-pdf/1
❗️ Important
For all requests it is necessary to send credentials, for more information you can visit the section Getting started.
# Documents
You can obtain the documents of a property with the following URI:
api.wasi.co/v1/property/#id_property/documents/all
If everything is in order, this should return a JSON similar to the next:
{
"0": {
"id_category": 1,
"category": "Contratos",
"files": [
{
"id_file": 1015,
"name": "Capture d’écran 2020-06-27 à 12.45.46 AM.png",
"title": "Captur...6 AM.png"
},
{
"id_file": 1017,
"name": "Guia ejercicios de Autocuidado.pdf",
"title": "Guia e...dado.pdf"
}
]
},
"1": {
"id_category": 2,
"category": "Fotocopias",
"files": [
{
"id_file": 1016,
"name": "19juncovid.jpg",
"title": "19juncovid.jpg"
}
]
},
"2": {
"id_category": 3,
"category": "Facturas",
"files": []
},
"3": {
"id_category": 4,
"category": "Anexos",
"files": []
},
"4": {
"id_category": 5,
"category": "Varios",
"files": []
},
"status": "success"
}
❗️ Important
The documents are grouped by category.
To obtain a document you have the following URI:
http://api.wasi/v1/property/#id_property/documents/get/#id_file
# Upload a document
To upload a document of a property in Wasi, you have the URI:
POST api.wasi.co/v1/property/#id_property/documents/upload
To upload a document to the example property whose id_property is 1, the URI would be:
api.wasi.co/v1/property/1/documents/upload
The document (file) must be sent in the parameter called file. The following table lists the parameters supported by the document upload URI:
| Parameter | Type | Description |
|---|---|---|
| file | File | It is the file that is sent from an html form. |
| id_category | Number | ndicates the category to which the document belongs, see Document categories |
# Delete a document
To delete a document from a property in Wasi, you have the URI:
POST api.wasi.co/v1/property/#id_property/documents/#id_file/delete
To remove document 3 from the example property whose id_property is 1, the URI would be:
api.wasi.co/v1/property/1/documents/3/delete
❗️ Important
For all requests it is necessary to send credentials, for more information you can visit the section Getting started.