METODA
| Status | ||||
|---|---|---|---|---|
|
Zakres danych
Przesyłane żądanie w formacie json przez API Rest musi posiadać poniższą strukturę danych
NAZWA POLA | NAZWA POLA W APLIKACJI | TYP POLA | WYMAGANE | OPIS |
|---|---|---|---|---|
ID zamówienia | orderId | integer | TAK | |
| Data dostawy | deliveryDate | string | TAK | |
| Komentarz | comment | string | NIE | |
| POZYCJE W DOSTAWIE (orderItemDelivery) | ||||
| ID pozycji zamówienia | orderItemId | integer | TAK | |
| Ilość w dostawie | suppliedQuantity | numeric | TAK | |
Przykład
Poniżej przedstawiamy przykładową strukturę danych w pliku json.
{
"orderId" : 1,
"deliveryDate" : "2020-12-23T11:54:30.862",
"comment" : "Comment",
"orderItemDelivery" : [ {
"orderItemId" : 1,
"suppliedQuantity" : 1
}, {
"orderItemId" : 2,
"suppliedQuantity" : 10
} ]
}Statusu odpowiedzi
Nazwa statusu |
OK |
ERROR |
Kody błędów
Kod Błędu | Nazwa | Opis |
101 | Nie wszystkie wymagane pola są uzupełnione. | Występuje kiedy pola wymagane nie zostały wysłane w żądaniu. |
102 | Uzupełnione pola są wypełnione nieprawidłowo. | Występuje kiedy dane słownikowe wysłane w żądaniu nie zgadzają się ze słownikiem. |
201 | Błąd autoryzacji | Występuje kiedy dane autoryzacyjne są nieprawidłowe. |
202 | Błąd podczas deserializacji json | Występuje kiedy w żądaniu występują nieprawidłowe dane. |
203 | Błąd json. Uszkodzenie całego pliku | Występuje kiedy całe żądanie jest nieprawidłowe błędy podczas transmisji danych. |
...