InfoAPILib
Bilioteka za pristup InfoAPI-ju
Public Member Functions | Properties | List of all members
InfoAPILib.InfoAPIEnvelope Class Reference

Omotnica API poruke. Ovo je zajednička bazna klasa za InfoAPIRequest i InfoAPIResponse More...

Inheritance diagram for InfoAPILib.InfoAPIEnvelope:
InfoAPILib.InfoAPIBase InfoAPILib.InfoAPIRequest InfoAPILib.InfoAPIResponse

Public Member Functions

string ResetReqId ()
 Restuje req_id u InfoAPIEnvelope. Mora biti pozvan svaki put pre slanja upita API serveru, da bi se req_id promenio. More...
 
string GetChecksum (string pData, string pRequestId, string pPrivatekey)
 Izračuna čeksum na osnovu data, req_id i privatnog ključa More...
 
- Public Member Functions inherited from InfoAPILib.InfoAPIBase
 InfoAPIBase ()
 Конструктор More...
 
string Serialize ()
 Serijalizuje objekat More...
 
string Serialize (bool pIndented)
 Serializuje objekat sa identacijom More...
 
void Deserialize (string pSerializedInput)
 Deserijalizuje string u objekat More...
 

Properties

string req_id [get, set]
 req_id (char) Идентификатор упита.Овај податак генерише клијент а сервер га враћа у одговору.Служи да клијент може да по потреби повеже одговоре са упитима и за рачунање контролног кода за проверу целевитости послатог упита.Клијент треба да употребљава различиту вредност за сваки упит који шаље. More...
 
string session_id [get, set]
 session_id (char) Идентификатор сесије. Овај идентификатор генерише сервер када клијент први пут позове АПИ и враћа га клијенту. Клијент у сваком следећем упиту у оквиру исте сесије шаље идентификатор сесије. Ово омогућава да се одређени подаци или стања могу преносити између више упита са истог клијента ка АПИ-ју. Сесија се прекида одјавом или неактивношћу клијента. Подразумевано, некативност дужа од 10 минута прекида сесију, а то се може подешавати на АПИ северу. Ако клијент не зна идентификатор сесије, односно тек започиње сесију, шаље ово поље празно. More...
 
string instance_id [get, set]
 instance_id(char) Идентификатор инстанце у оквиру сесије.Овај идентификатор сервер генерише ако није добио идентификатор од клијента.Клијент по правилу у сваком наредном упиту шаље идентификатор инстанце који је добио од сервера осим ако не жели да започне нову инстанцу. Клијент може да покрене више инстанци у оквиру исте сесије. Све инстанце се затварају са затварањем сесије. More...
 
string encoding [get, set]
 encoding(char) Начин на који су кодирани подаци у пољу data. Сервер на основу овог податка зна како да декодира податке. Подразумевано се подаци не кодирају и ово поље остаје празно. Енкодирање података није још увек имплементирано. More...
 
string data [get, set]
 data (char) Параметри који се шаљу АПИ функцији.Ово поље садржи угњеждену ЈСОН структуру TAPIParams. Та структура је променљива зависно од функције која се позива. More...
 
string api_version [get, protected set]
 api_version (char) Ознака верзије АПИ-ја који клијент разуме More...
 
string poslovna_godina [get, set]
 poslovna_godina (char) Ознака пословне године. Употребљава се ако клијент треба да наведе АПИ-ју коју пословну годину жели да употреби. Ретко се употребљава и подразумевано је поље празно, што значи да ће АПИ употребљавати податке из текуће пословне године More...
 
string job [get, set]
 job (char) Ознака JOB-а. Употребљава се ако клијент треба да наведе у ком JOB-у жели да покрене АПИ функцију.Користи се само изузетно и подразумевано поље остаје празно. More...
 
string pozicija [get, set]
 pozicija(char) Ознака позиције.Употребљава се ако клијент треба да наведе на којој позицији жели да покрене АПИ функцију.Користи се само изузетно и подразумевано поље остаје празно. More...
 
string checksum [get, protected set]
 checksum(char) Контролни код поруке.Намена му је да се преко њега може проверити интегритет послатог упита. More...
 
- Properties inherited from InfoAPILib.InfoAPIBase
string _class_name [get, set]
 Naziv klase. U API porukama je ovo uglavnom informativnog karaktera, a dobro dođe kada se analiziraju složene strukture More...
 
string app_option [get, set]
 app_option(char) Oznaka API funcije koju klijent poziva. Ovo je podatak na osnovu koga API server zna koju funkciju treba da izvrši. More...
 

Additional Inherited Members

- Public Attributes inherited from InfoAPILib.InfoAPIBase
IInfoAPIFormatter Formatter
 Objekat koji vrši serijalizaciju i deserijalizaciju More...
 
- Package Attributes inherited from InfoAPILib.InfoAPIBase
string __class_name = ""
 

Detailed Description

Omotnica API poruke. Ovo je zajednička bazna klasa za InfoAPIRequest i InfoAPIResponse

Member Function Documentation

string InfoAPILib.InfoAPIEnvelope.ResetReqId ( )

Restuje req_id u InfoAPIEnvelope. Mora biti pozvan svaki put pre slanja upita API serveru, da bi se req_id promenio.

Returns
String vrednost podešenu za req_id
string InfoAPILib.InfoAPIEnvelope.GetChecksum ( string  pData,
string  pRequestId,
string  pPrivatekey 
)

Izračuna čeksum na osnovu data, req_id i privatnog ključa

Parameters
pDatasadržaj data svojstva
pRequestIdsadržaj req_id
pPrivatekey
Returns
izračunati čeksum kao string

Property Documentation

string InfoAPILib.InfoAPIEnvelope.req_id
getset

req_id (char) Идентификатор упита.Овај податак генерише клијент а сервер га враћа у одговору.Служи да клијент може да по потреби повеже одговоре са упитима и за рачунање контролног кода за проверу целевитости послатог упита.Клијент треба да употребљава различиту вредност за сваки упит који шаље.

string InfoAPILib.InfoAPIEnvelope.session_id
getset

session_id (char) Идентификатор сесије. Овај идентификатор генерише сервер када клијент први пут позове АПИ и враћа га клијенту. Клијент у сваком следећем упиту у оквиру исте сесије шаље идентификатор сесије. Ово омогућава да се одређени подаци или стања могу преносити између више упита са истог клијента ка АПИ-ју. Сесија се прекида одјавом или неактивношћу клијента. Подразумевано, некативност дужа од 10 минута прекида сесију, а то се може подешавати на АПИ северу. Ако клијент не зна идентификатор сесије, односно тек започиње сесију, шаље ово поље празно.

string InfoAPILib.InfoAPIEnvelope.instance_id
getset

instance_id(char) Идентификатор инстанце у оквиру сесије.Овај идентификатор сервер генерише ако није добио идентификатор од клијента.Клијент по правилу у сваком наредном упиту шаље идентификатор инстанце који је добио од сервера осим ако не жели да започне нову инстанцу. Клијент може да покрене више инстанци у оквиру исте сесије. Све инстанце се затварају са затварањем сесије.

string InfoAPILib.InfoAPIEnvelope.encoding
getset

encoding(char) Начин на који су кодирани подаци у пољу data. Сервер на основу овог податка зна како да декодира податке. Подразумевано се подаци не кодирају и ово поље остаје празно. Енкодирање података није још увек имплементирано.

string InfoAPILib.InfoAPIEnvelope.data
getset

data (char) Параметри који се шаљу АПИ функцији.Ово поље садржи угњеждену ЈСОН структуру TAPIParams. Та структура је променљива зависно од функције која се позива.

string InfoAPILib.InfoAPIEnvelope.api_version
getprotected set

api_version (char) Ознака верзије АПИ-ја који клијент разуме

string InfoAPILib.InfoAPIEnvelope.poslovna_godina
getset

poslovna_godina (char) Ознака пословне године. Употребљава се ако клијент треба да наведе АПИ-ју коју пословну годину жели да употреби. Ретко се употребљава и подразумевано је поље празно, што значи да ће АПИ употребљавати податке из текуће пословне године

string InfoAPILib.InfoAPIEnvelope.job
getset

job (char) Ознака JOB-а. Употребљава се ако клијент треба да наведе у ком JOB-у жели да покрене АПИ функцију.Користи се само изузетно и подразумевано поље остаје празно.

string InfoAPILib.InfoAPIEnvelope.pozicija
getset

pozicija(char) Ознака позиције.Употребљава се ако клијент треба да наведе на којој позицији жели да покрене АПИ функцију.Користи се само изузетно и подразумевано поље остаје празно.

string InfoAPILib.InfoAPIEnvelope.checksum
getprotected set

checksum(char) Контролни код поруке.Намена му је да се преко њега може проверити интегритет послатог упита.


The documentation for this class was generated from the following file: