WS trenutno podržava sledeće metode:

  • webServiceInfo
  • updateRouter
  • retreiveNews
  • pingWebAQL
  • checkPortalAliasAvailability
  • requestActivation
  • processRequest

Metoda webServiceInfo

Informacije o WS-u – naziv i trenutna verzija.

Sintaksa:

string webServiceInfo()

Metoda updateRouter

Ažurira ruter tabelu, kako bi WS u svakom trenutku znao gde da preusmeri dolazni zahtev za podacima sa portala.

Parametar Opis
username korisničko ime
password lozinka
ip IP adresa WebAQL servera
port port
webAQL verzija WebAQL-a
webService putanja do Host WS-a

Sintaksa:

bool updateRouter(string username, string password, string ip, int port, string webAQL, string webService)

Metoda retreiveNews

Opšte informacije, kao i informacije vezane za korisnika WS-a.

Parametar Opis
username korisničko ime
password lozinka

Sintaksa:

string retreiveNews(string username, string password)

Metoda pingWebAQL

Proverava dostupnost WebAQL-a i aktivnost AQL servera.

Parametar Opis
username korisničko ime
password lozinka

Sintaksa:

bool pingWebAQL(string username, string password)

Metoda checkPortalAliasAvailability

Proverava dostupnost aliasa za portal. Koristi se pri procesu aktiviranja novog portala.

Parametar Opis
portalAlias alias portala

Sintaksa:

bool checkPortalAliasAvailability(string portalAlias)

Metoda requestActivation

Registrovanje novog portala i licence neophodne za rad WebAQL-a.

Parametar Opis
name naziv portala (firme)
email e-mail adresa za kontakt (javno dostupna na portalu)
portalAlias alias portala
hardwareKey HDD serijski broj
validationKey validacioni ključ

Sintaksa:

string requestActivation(string name, string email, string portalAlias, string hardwareKey, string validationKey)

Metoda processRequest

Predstavlja jedinstven interfejs za interakciju sa APPom.

Parametar Opis
xmlRequest XML struktuiran zahtev za realizaciju

Sintaksa:

string processRequest(string xmlRequest)

XML struktuiran zahtev/odgovor

Struktura XML zahteva:

<request>
   <command name="#funkcija#" output="#xml/json#">
       <parametar></parametar>
   </command>
</request>

Svaki zahtev (request tag) može sadržati jednu ili više komandi (command tag). Shodno tome, odgovor (reposnse tag) sadrži onoliko rezultata koliko je komandi upućeno u zahtevu.

Struktura XML odgovora:

<response>
   <command name="#funkcija#" retcode="#0/1#" message="#poruka#">
       <atribut></atribut>
   </command>
</response>

Atribut retcode može imati dve vrednosti:

  • 0 – operacija nije izvršena (greška prilikom izvršavanja),
  • 1 – operacija uspešno izvršena.

Atribut message pruža dodatno objašnjenje / opis nastale greške.

Kompletan pregled XML struktuiranih zahteva i odgovora