Skip to content
grabarczyk-t edited this page Jun 1, 2014 · 40 revisions

###Wstęp API przygotowanego projektu opiera się o powszechnie stosowane praktyki REST'owe. Statusy wiadomości HTTP zwracane w podstawowych przypadkach są zgodne z przyjętymi standardami. Więcej na temat standardów można doczytać na stronie: http://www.restapitutorial.com/lessons/httpmethods.html.

Autoryzacja i uwierzytelnianie opiera się o BASIC.

Jako standard formatowania wiadomości wykorzystywany jest JSON + HAL.

#####Odpowiedzi serwera w przypadku sytuacji wyjątkowej

Jeżeli nie wszystkie maszyny są aktywne serwer zwróci błąd HTTP 503 Service Unavailable

W niektórych sytuacjach istnieje potrzeba przesłania dodatkowych informacji na temat przyczyny błędu logiki biznesowej. Informację te są zawarte w prezentowanej niżej strukturze.

Status HTTP: 500 Internal Server Error

{
"message":"Nie można usunąć pomiaru złożonego, ponieważ jest on wykorzystywany w systemie przez inny pomiar"
}

###Katalog

idzasóbopis
[[RST_KT_MSLREST-API-Katalog#rst_kt_msl]]GET measurements
[[RST_KT_MSAREST-API-Katalog#rst_kt_msa]]POST measurements
[[RST_KT_MSDREST-API-Katalog#rst_kt_msd]]DELETE measurements/{id}
[[RST_KT_RSLREST-API-Katalog#rst_kt_rsl]]GET resources

###Monitor

idzasóbopis
[[RST_MT_MSLREST-API-Monitor#rst_mt_msl]]GET measurements
[[RST_MT_CMSOREST-API-Monitor#rst_mt_cmso]]GET complex/types
[[RST_MT_CMSAREST-API-Monitor#rst_mt_cmsa]]POST measurements
[[RST_MT_MSGREST-API-Monitor#rst_mt_msg]]GET measurements/{id}
[[RST_MT_MSVLREST-API-Monitor#rst_mt_msvl]]GET measurements/{id}/data
[[RST_MT_CPLXREST-API-Monitor#rst_mt_cplx]]GET complex/{id}
[[RST_MT_CMSDREST-API-Monitor#rst_mt_cmsd]]DELETE measurements/{id}
[[RST_MT_RSLREST-API-Monitor#rst_mt_rsl]]GET resources

Clone this wiki locally