Местоположение:
Bigle API
Advertisements
List advertisements
Return list of all seller advertisements
Request
GET - /api/v1/advert/list?key=key&id=id
|
Param |
Type |
Description |
Required |
|
key |
string |
Developer key |
+ |
|
id |
int |
Seller id |
|
Response
|
Param |
Type |
Description |
|
status |
int |
Status 200 - success 405 - http method not allowed 407 - failed auth 453 - wrong format of seller id |
|
statusMessage |
string |
Status message |
|
output |
array |
Array of objects { advert_id: advertisement id, advert_url: advertisement url, advert_type: advertisement category (apartments, house), published: 1 - published, 0 - not published } |
Add advertisement
Add advertisement
Request
GET - /api/v1/advert/add?key=key&advert=data
|
Param |
Type |
Description |
Required |
|
key |
string |
Developer key |
+ |
|
advert |
struct |
Advertisement data |
+ |
Advertisement data
|
Param |
Type |
Description |
Required |
|
advert_function |
int |
Type 1 - Sell 2 - Let |
+ |
|
advert_price |
double |
Price |
+ |
|
advert_price_currency |
int |
Currency 1 - Kc 2 - USD 3 - EUR |
+ |
|
advert_type |
int |
Category 1 - Apartments 2 - House 3 - Land 4 - Commercial 5 - Other |
+ |
|
description |
string |
Description |
+ |
|
advert_room_count |
int |
Room (only for house) 1 - 1 room 2 - 2 rooms 3 - 3 rooms 4 - 4 rooms 5 - 5 rooms 6 - 6 or more rooms |
+ (for houses) |
|
advert_subtype |
int |
Subcategory For apartments 2 - 1+kk 3 - 1+1 4 - 2+kk 5 - 2+1 6 - 3+kk 7 - 3+1 8 - 4+kk 9 - 4+1 10 - 5+kk 11 - 5+1 12 - 6 or more For houses 33 - Cottage 37 - Family 39 - Villa 43 - Holiday home For land 18 - Commercial 19 - Residental 20 - Fields 21 - Forests 22 - Meadow 23 - Gardens 24 - Others 46 - Ponds 48 - Vineyards For commercial 25 - Office 26 - Store 27 - Production 28 - Shop 30 - Restaurant 32 - Others 38 - Apartment building For others 34 - Garage |
+ |
|
balcony |
bool |
Balcony |
|
|
building_condition |
int |
Condition 1 - Perfect 2 - Good 3 - Bad 4 - For reconstruction 5 - Project 6 - New building 7 - For demolition 8 - For reconstruction 9 - After reconstruction |
|
|
building_type |
int |
Material 1 - Wood 2 - Brick 3 - Stone 4 - Prefabricated 5 - Panel 6 - Frame-based 7 - Mixed |
|
|
cellar |
bool |
Cellar |
|
|
estate_area |
double |
Area of ground |
|
|
floor_number |
int |
Floor |
|
|
garage |
bool |
Garage |
|
|
locality_city |
string |
Locality |
+ |
|
locality_citypart |
string |
Sublocality |
|
|
locality_street |
string |
Route |
|
|
locality_co |
string |
Street number |
|
|
locality_cp |
string |
Premise |
|
|
locality_latitude |
double |
Latitude |
|
|
locality_longitude |
double |
Longitude |
|
|
loggia |
bool |
Loggia |
|
|
ownership |
int |
Ownership 1 - Private 2 - Cooperative |
|
|
parking_lots |
bool |
Parking |
|
|
seller_id |
int |
ID of advertisement seller |
|
|
terrace |
bool |
Terrace |
|
|
usable_area |
double |
Overall area |
|
|
balcony_area |
double |
Area of balcony |
|
|
building_area |
double |
Area of building |
|
|
ceiling_height |
double |
Ceiling height |
|
|
cellar_area |
double |
Area of cellar |
|
|
easy_access |
int |
Barier less 1 - Yes 2 - No |
|
|
elevator |
int |
Elevator 1 - Yes 2 - No |
|
|
energy_efficiency_rating |
int |
Energy efficiency 1 - A (low energy) 2 - B (energetic) 3 - C (medium energy) 4 - D (minimum legal) 5 - E (energy consumpting) 6 - F (highly energy consumpting) 7 - G (very high energy consumpting) |
|
|
flat_class |
int |
Apartment type 1 - Standard 2 - Loft 3 - Attic |
|
|
floor_area |
double |
Area of floor |
|
|
floors |
int |
Floors count |
|
|
garage_count |
int |
Garage count |
|
|
garden_area |
double |
Area of garden |
|
|
gas |
int |
Gas 1 - Individual 2 - Pipeline 3 - Other |
|
|
gully |
int |
Sewage 1 - Public 2 - WWTP for the whole building 3 - Septic 4 - Sump |
|
|
heating |
int |
Heating 1 - Local gas 2 - Local solid fuels 3 - Local electric 4 - In house gas 5 - In house solid fuels 6 - In house electric 7 - Central 8 - Other |
|
|
loggia_area |
double |
Area of loggia |
|
|
offices_area |
double |
Area of offices |
|
|
parking |
int |
Parking lots count |
|
|
production_area |
double |
Area of production |
|
|
reconstruction_year |
int |
Year of reconstruction |
|
|
shop_area |
double |
Area of shop |
|
|
store_area |
double |
Area of store |
|
|
telecommunication |
int[] |
Telecommunication 1 - Phone 2 - Internet 3 - Satellite 4 - Cable TV |
|
|
terrace_area |
double |
Area of terrace |
|
|
water |
int |
Water 1 - Local 2 - Long-distance |
|
Response
|
Param |
Type |
Description |
|
status |
int |
Status 200 - OK 405 - http method not allowed 407 - failed auth 452 - not filled required params 453 - wrong params format 461 - seller doesn’t exist |
|
statusMessage |
string |
Status message |
|
output |
array |
Array { advert_id: id of advertisement, advert_url: advertisement url } |
Delete advertisement
Delete specified seller advertisement
Request
POST - /api/v1/advert/del?key=key&id=id
|
Param |
Type |
Description |
Required |
|
key |
string |
Developer key |
+ |
|
id |
int |
Advertisement id |
+ |
Response
|
Param |
Type |
Description |
|
status |
int |
Status 200 - OK 405 - http method not allowed 407 - failed auth 452 - empty required params 453 - wrong format of advertisement id |
|
statusMessage |
string |
Status message |
|
output |
array |
No data |
Add advertisement photo
Add photo to specified seller advertisement
Request
POST - /api/v1/advert/add-photo?key=key&id=id&photo=photo
|
Param |
Type |
Description |
Required |
|
key |
string |
Developer key |
+ |
|
id |
int |
Advertisement id |
+ |
|
photo |
struct |
Photo data |
+ |
Photo data
|
Param |
Type |
Description |
Required |
|
data |
binary |
Photo |
+ |
|
main |
int |
Main photo 1 - main 2 - not main |
+ |
|
alt |
string |
Photo description |
|
Response
|
Param |
Type |
Description |
|
status |
int |
Status 200 - OK 405 - http method not allowed 407 - failed auth 452 - empty required params 453 - wrong format of advertisement id |
|
statusMessage |
string |
Status description |
|
output |
array |
Array { photo_id: id of photo } |
Delete advertisement photo
Delete specified seller advertisement photo
Request
POST - /api/v1/advert/del-photo?key=key&id=id
|
Param |
Type |
Description |
Required |
|
key |
string |
Developer key |
+ |
|
id |
int |
Photo id |
+ |
Response
|
Param |
Type |
Description |
|
status |
int |
Status 200 - OK 405 - http method not allowed 407 - failed auth 452 - empty required params 453 - wrong format of photo id |
|
statusMessage |
string |
Status description |
|
output |
array |
No data |
List advertisement photos
Return list of advertisement photos
Request
GET - /api/v1/advert/list-photos?key=key&id=id
|
Param |
Type |
Description |
Required |
|
key |
string |
Developer key |
+ |
|
id |
int |
Advertisement id |
+ |
Response
|
Param |
Type |
Description |
|
status |
int |
Status 200 - OK 407 - failed auth 452 - empty required params 453 - wrong format of advertisement id |
|
statusMessage |
string |
Status description |
|
output |
array |
Array of objects { id: photo id, main: is main photo (1 - yes, 0 - no), } |
Advertisement statistics
Return overall statistics of advertisement
Request
GET - /api/v1/advert/stat?key=key&id=id
|
Param |
Type |
Description |
Required |
|
key |
string |
Developer key |
+ |
|
id |
int |
Advertisement id |
+ |
Response
|
Param |
Type |
Description |
|
status |
int |
Status 200 - OK 407 - failed auth 452 - empty required params 453 - wrong format of advertisement id |
|
statusMessage |
string |
Status description |
|
output |
array |
Array { advert_id: advertisement id, total_views: total advertisement views, total_price: advertisement price } |
Advertisement daily statistics
Return daily statistics of advertisement
Request
GET - /api/v1/advert/daily-stat?key=key&id=id
|
Param |
Type |
Description |
Required |
|
key |
string |
Developer key |
+ |
|
id |
int |
Advertisement id |
+ |
Response
|
Param |
Type |
Description |
|
status |
int |
Status 200 - OK 407 - failed auth 452 - empty required params 453 - wrong format of advertisement id |
|
statusMessage |
string |
Status description |
|
output |
array |
Array of objects { date: date of day, views: advertisement views, price: advertisement price } |
All advertisements daily statistics
Return statistics of all advertisements of seller for specified date
Request
GET - /api/v1/advert/all-daily-stat?key=key&date=date
|
Param |
Type |
Description |
Required |
|
key |
string |
Developer key |
+ |
|
date |
date |
Date (dd.mm.yyyy) |
+ |
Response
|
Param |
Type |
Description |
|
status |
int |
Status 200 - OK 407 - failed auth 452 - empty required params 453 - wrong format of advertisement id |
|
statusMessage |
string |
Status description |
|
output |
array |
Array of objects { advert_id: id of advertisement, views: advertisement views, advert_price: advertisement price } |
Seller
List sellers
Return all seller created by user with specified key
Request
GET - /api/v1/seller/list?key=key
|
Param |
Type |
Description |
Required |
|
key |
string |
Developer key |
+ |
Response
|
Param |
Type |
Description |
|
status |
int |
Status 200 - OK 407 - failed auth 452 - empty required params |
|
statusMessage |
string |
Status description |
|
output |
array |
Array of objects { seller_id: seller id, client_name: name and surname, client_login: seller login (email), photo: 1 - yes, 0 - no } |
Add seller
Add seller
Request
POST - /api/v1/seller/add?key=key&seller=data
|
Param |
Type |
Description |
Required |
|
key |
string |
Developer key |
+ |
|
seller |
struct |
Seller data |
+ |
Seller data
|
Param |
Type |
Description |
Required |
|
client_login |
string |
Email to login |
+ |
|
client_name |
string |
Name and surname |
+ |
|
contact_phone |
string |
Phone number |
|
|
contact_email |
string |
|
+ |
|
client_ic |
int |
Seller ICO |
+ |
|
client_is_employee |
bool |
Seller is employee |
|
|
broker_specialization |
int[] |
Seller specialization 0 - Sale 1 - Letting 2 - Property management 3 - Buyout 4 - Property valuation 5 - Taxes asvising 6 - Sale of new buildings 7 - Commercial property 8 - Sites 9 - Investment property 10 - Other |
|
|
makler_note |
string |
About seller |
|
|
photo |
binary |
Seller photo |
|
Response
|
Param |
Type |
Description |
|
status |
int |
Status 200 - OK 407 - failed auth 452 - empty required params |
|
statusMessage |
string |
Status description |
|
output |
array |
Array { seller_id: seller id } |
Delete seller
Delete specified seller
Request
POST - /api/v1/seller/del?key=key&id=id
|
Param |
Type |
Description |
Required |
|
key |
string |
Developer key |
+ |
|
id |
int |
Seller id |
+ |
Response
|
Param |
Type |
Description |
|
status |
int |
Status 200 - OK 407 - failed auth 452 - empty required params 453 - wrong format of seller id |
|
statusMessage |
string |
Status description |
|
output |
array |
No data |
Seller statistics
Return overall statistics of seller’s advertisements for date range
Request
GET - /api/v1/seller/stat?key=key&from=date&till=date&seller=seller
|
Param |
Type |
Description |
Required |
|
key |
string |
Developer key |
+ |
|
id |
int |
Seller id |
+ |
|
from |
date |
From date (dd.mm.yyyy) |
+ |
|
till |
date |
To date (dd.mm.yyyy) |
+ |
Response
|
Param |
Type |
Description |
|
status |
int |
Status 200 - OK 407 - failed auth 452 - empty required params 453 - wrong format of seller id |
|
statusMessage |
string |
Status description |
|
output |
array |
Array of objects { date: date of day, advert_count: advertisements count, views: advertisement views } |
© 2019-2021 Bigle.cz