Skip to end of metadata
Go to start of metadata

Wstęp

Niniejsza dokumentacja zawiera informacje związane z implementacją metod API dedykowanych platformie asariMLS.

Metody API obsługiwane połączeniem http odpowiadają w standardzie JSON (więcej informacji: http://www.json.org/)

Wywoływanie metod:

  • Parametry wymagalne oznaczone są *
  • Jeśli zwracany obiekt jest słownikiem i obie nazwy (nazwa słownika i hasło) są takie same, nazwa słownika zostanie pominięta - sectionName(dictionary SectionName) -> sectionName(dictionary)
  • Deklaracje metody, które nie zwracają żadnych danych z wyjątkiem wskaźnika sukcesu są oznaczone jako succes/failure

Informacje ogólne

Autoryzacja przez userId oraz Token

Wykonanie jakiejkolwiek operacji na platformie asariMLS wymaga autoryzacji. Do autoryzacji wymagany jest identyfikator użytkownika oraz unikalny token.

loginToken oraz userId muszą być wysyłane z innymi parametrami zapytania.

Na przykład: http://api.asariweb.pl/apiLocation/findLocations?query=Warszawa&userId=12456&loginToken=abcdefghij3131231231321

Uzyskiwanie parametrów userId oraz loginToken

Rozpoczęcie czynności związanych z uzyskaniem userId oraz loginToken wymaga zarejestrowania konta na platformie asariMLS.

Rejestracji konta dokonujemy korzystając z formularza rejestracyjnego.

Adres strony na której znajduje się formularz rejestracyjny do konkretnej platformy MLS dostępny jest w Dziale Obsługi Klienta f-my Protoss (dok@asari.pl)

Po dokonaniu rejestracji należy zalogować się aplikacji, przejść do opcji Twoje ustawienia i na zakładce Ustawienia aplikacji przejść do opcji API gdzie widoczne jest ID i Token.

Typy parametrów wejściowych

Występujące w metodach parametry mogą być nastepującego formatu:

Typ

Format

Przykład

integer

liczby całkowite

123345
0

float

liczby rzeczywiste (część ułamkowa rozdzielona przecinkiem lub kropką)

123.4343
 lub
123,4343

date

yyyy-MM-dd
  lub
yyyy-MM-dd hh:mm:ss
(krótki format jest konwertowany do formatu yyyy-MM-dd 00:00:00)

2010-12-31
2010-12-31 18:55:58

string

tekst

jakiś dowolny tekst

boolean

logiczny: true lub pusta wartość dla false

 

dictionary

ciąg znaków reprezentujący wartość danego słownika 

Mieszkanie
Dom

Paginacja i sortowanie

Niektóre metody zwracające listę obiektów mogą podlegać paginacji.

Mogą być ustawiane następujące parametry:

Parametr

Typ

Opis

offset
lub
start

integer

zwraca wynik rozpoczynając od  wiersza podanego w offset lub start(0)

max
lub
limit

integer

zwraca max  lub limit liczbę wierszy

Uwaga: Jeśli nie zostanie ustawiony max(limit) system automatycznie ustawi parametr do rozsądnych wartości.

Sortowanie może być ustalone przez przekazanie następujących parametrów. Powinny być wysyłane oba parametry.

Parametr

Typ

Opis

sort

string

nazwa pola

order

string

'asc' lub 'desc'

Format odpowiedzi

Każda odpowiedź posiada właściwość:

  • success (logiczny) - określa czy odpowiedź jest prawidłowa lub czy wystąpił błąd

Odpowiedź prawidłowa

Obiekt Json z właściwościami:

  • data (obiekt lub tablica obiektów)
  • totalCount (integer) - zwracany gdy zwracany wynik jest tablicą a metoda używa paginacji

Przykład prostego obiektu:

Przykład listy:

Błędna odpowiedź

Obiekt Json z właściwościami:

error (string) - tekst komunikatu (zlokalizowany)

  • parametersErrors (obiekt gdzie właściwości są nazwami typu błędu i tekstami komunikatów o błędach dotyczących danego parametru) - zwracane, jeśli błąd jest związany z parametrem wejściowym metody. Może być użyty jako komunikat błędu przy formatkach zatwierdzanych przez użytkownika.

Przykład odpowiedzi o błędzie:

Przykład odpowiedzi o błędzie (z parametrami):

Typy parametrów wyjściowych

Metody zwracają obiekty json z następującymi właściwościami (więcej informacji http://www.json.org/ )

Typ

Format

Przykład

string

tekst

"dowolny tekst"

integer

liczby całkowite

3242

float

liczby rzeczywiste (część ułamkowa rozdzielona kropką)

3232.3232

date

tekst w formacie yyyy-MM-dd hh:mm:ss

"2010-12-31 18:55:58"

boolean

logiczny -> true, false

 

money

Słowniki

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, CommercialObjecSale, CommercialObjectRental

ListingStatus

Active, Cancelled, Closed, Pending, Draft

TaskStatus

Waiting, Solved, Cancelled

TaskType

Regular, Reminder, Appointment

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

Metody

Lokalizacje

Agenci (pośrednicy)

Oferty

Zdjęcia

Przekazywanie adresu

  • No labels