Metódy

eOrdering API je navrhnuté v zmysle konceptu REST. Jednotlivé metódy sú hierarchicky rozdelené podľa nižšie uvedených objektov; v zvyšnej časti stránky budú tieto objekty označované v príkladoch URI ako {keyword}.

Adresovanie metód je postavené na kombinácii HTTP metódy a URI.

Objekt	eOrdering API metóda	HTTP metóda	URI
Dodávateľ	Zoznam dodávateľov	GET	/api.svc/json/suppliers
	Detail dodávateľa	GET	/api.svc/json/suppliers/{id}
		GET	/api.svc/json/suppliers/uniqueName/{uniqueName}
Spoločnosť	Zoznam spoločností	GET	/api.svc/json/companies
	Detail spoločnosti	GET	/api.svc/json/companies/{id}
	Zoznam lekární patriacich k spoločnosti	GET	/api.svc/json/companies/{id}/pharmacies
Lekáreň	Zoznam lekární	GET	/api.svc/json/pharmacies
	Detail lekárne	GET	/api.svc/json/pharmacies/{id}
		GET	/api.svc/json/pharmacies/key/{key}
Produkt	Zoznam produktov	GET	/api.svc/json/products
	Detail produktu	GET	/api.svc/json/products/{adc}
Objednávka	Zoznam objednávok	GET	/api.svc/json/orders
	Detail objednávky	GET	/api.svc/json/orders/{id}
		GET	/api.svc/json/orders/key/{key}
		GET	/api.svc/json/orders/customId/{customId}
	Nová objednávka	POST	/api.svc/json/orders
	Zmena objednávky	PUT	/api.svc/json/orders/{id}
		PUT	/api.svc/json/orders/key/{key}
		PUT	/api.svc/json/orders/customId/{customId}
	Zmazanie objednávky	DELETE	/api.svc/json/orders/{id}
		DELETE	/api.svc/json/orders/key/{key}
		DELETE	/api.svc/json/orders/customId/{customId}
	Odoslanie objednávky	POST	/api.svc/json/orders/{id}/send
		POST	/api.svc/json/orders/key/{key}/send
		POST	/api.svc/json/orders/customId/{customId}/send
	Zrušenie sledovania objednávky	DELETE	/api.svc/json/orders/{id}/watchdog
		DELETE	/api.svc/json/orders/key/{key}/watchdog
		DELETE	/api.svc/json/orders/customId/{customId}/watchdog

Vzhľadom na to, že objekty majú medzi sebou prirodzené vzťahy, eOrdering API podporuje prechádzanie cez tieto vzťahy pomocou spájania kľúčových slov. Napríklad pre získanie zoznamu všetkých lekární, ktoré patria k určitej spoločnosti

GET /api.svc/json/companies/{id-spolocnosti}/pharmacies

Poznámky

Adresovanie API metódy je odoslanie požiadavky na zvolenú URI príslušnou HTTP metódou, tak ako je to uvedené v tomto prehľade.

Možné chyby

V prípade nesprávneho adresovania, eOrdering API vráti chybovú odpoveď s HTTP statusom 405.