| Warning |
|---|
The data downloaded by API should be saved to a local database. Web pages should display data from database prepared in that way. Number of queries to the API is restricted to 25 per minute (It's best to use a 3-4 second interval). Limit of connection can undergo change. |
...
| Table of Contents |
|---|
| Child pages |
|---|
Introduction
Api methods serve http calls responding with json (http://www.json.org/)
| Warning | ||
|---|---|---|
| ||
apiSite authorized only by userId and Token in HEADER - link |
Main url: https://api.asari.pro
Response format
Every response object has property:
- success (boolean) - determaining if response is valid or error occured.
Success Response
Json object with properties:
...
| Code Block |
|---|
{
success: true,
data: [
{ id: 1, propertyType: "House"},
{ id: 2, propertyType: "Lot"},
{ id: 3, propertyType: "House"},
],
totalCount: 140
}
|
Error Response
Json object with properties:
...
| Code Block |
|---|
{
success: false,
error: "Invalid input",
parameterErrors : {
email: "Invalid format",
password: "Password to short"
}
}
|
Return types
Method will return json object with following properties (more info http://www.json.org/ )
Type | Format | Example | ||||
|---|---|---|---|---|---|---|
string | text | "bla bla bla" | ||||
integer | number | 3242 | ||||
float | decimal part separated by period | 3232.3232 | ||||
date | text in format yyyy-MM-dd hh:mm:ss | "2010-12-31 18:55:58" | ||||
boolean | true, false | |||||
money | object
|
|
Dictionaries
Name | Values |
|---|---|
fieldType | string, integer, float, date, boolean, money, dictionary, dictionaryList |
view | show, edit, list, search |
section | ApartmentSale, ApartmentRental, HouseSale, HouseRental, LotSale, LotRental, CommercialSpaceSale, CommercialSpaceRental, CommercialObjectSale, CommercialObjectRental, WarehouseSale, WarehouseRental, Investment, RoomRental |
status | Active, Cancelled, Closed, Pending, Draft |
taskStatus | Waiting, Solved, Cancelled |
taskType | Regular, Event, Reminder, Appointment, Call |
| callType | OUTGOING, INCOMING, MISSED, REJECTED |
listingActivityEventType | Appointment, ContactAcquisition, Email, Printout |
seekerActivityEventType | Appointment, ContactAcquisition, Email |
seekerPrivilege | Contact, PublicContact, Edit, Related |
listingPrivilege | Contact, PublicContact, Edit, Related |
contractType | Exclusive, Open, None, Direct, CustomerApplication |
ownershipType | Mortgage, HousingCooperative, Shared, Other |
currency | PLN, EUR, USD |
customerType | Person, Company |
customerFrom | Press, Internet, Phone, DirectVisit, Command |
commissionPercentPeriod | Year, Month |
valueType | String, Integer, Float, Date, Boolean, Dictionary, DictionaryList |
| scope | All , Company, Swo, Office |
| condition | Perfect, VeryGood, Good, NeedsSmallRenovation, NeedsTotalRenovation, NeedsConversion, NeedsFinishing, OpenRawState, CloseRawState |
| objectClassName | Listing, Seeker, Customer, Transaction, Invoice, Task, UserBase, Contract, Asset, Chance |
| documentType | Agreement, Annex, Termination, Other, Withdrawal, AddressAcquisitionProtocol, ContactAcquisitionProtocol |
| userType | Free, Paid |
Methods
- Required paremeters are marked with *
- If property is type of dictionary and both names are the same, name of dictionary is ommited f.ex. - sectionName(dictionary SectionName) -> sectionName(dictionary)
- Methods that raturn that don't return no data except of success indicator are marked as succces/failure
...