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 | KOMENTARZ | |
|---|---|---|---|---|---|
Nazwa zapotrzebowania | requestname | String | TAK |
| |
Szacunkowa wartość | estimatedPriceAmount | numeric(19,6) | TAK | Minimalna dopuszczalna wartość 0,01 | |
Waluta | estimatedPriceCurrency | varchar(3) | TAK | Pole wyboru waluty ze słownika walut | |
| Status | status | Nie | Możliwa wartość: w przygotowaniu, w trakcie zatwierdzania, zaakceptowane, odrzucony, zmodyfikowany, przetarg, zrealizowany, anulowany | ||
| Nip firmy | companyNip | TAK | Nip firmy w ramach, której tworzone jest zapotrzebowanie | ||
| Login użytkownika | login | TAK | Login użytkownika tworzącego zapotrzebowanie | ||
Rodzaj zakupu | purchaseType | bigint | TAK | Pole wyboru typu zapotrzebowania ze słownika szablonów zapotrzebowań | |
Kategorie zakupowe | buyerCategoryStructCode | TAK | Słownik kategorii zakupowych. Konieczność przekazania kodu kategorii | ||
Jednostka organizacyjna | organisationUnitStructCode | TAK | Słownik jednostek organizacyjnych. Konieczność przekazania kodu jednostki organizacyjnej | ||
TABELA Z POZYCJAMI (requestTableRows) | |||||
Indeks kupca | buyerIndex | String | NIE |
| |
Nazwa | name | String | TAK |
| |
Ilość | quantity | Double | TAK |
| |
Jednostka | unit | String | NIE | Możliwa wartość ze słownika jednostek miar | |
LISTA PÓL DODATKOWYCH | |||||
Uwagi | comment | String | NIE |
| |
Przykład
Poniżej przedstawiamy przykładową strukturę danych w pliku json.
{
"requestName" : "Zapotrzebowanie",
"estimatedPriceAmount" : 1500,
"estimatedPriceCurrency" : "PLN",
"status" : "IN_PREPARE",
"companyNip" : "0000001111",
"login" : "user@test.pl",
"requestTemplate" : "Szablon zapotrzebowania",
"organisationUnitStructCode" : "1;1-1",
"buyerCategoryStructCode" : "1;1-2",
"comment" : "Comment",
"requestTableRows" : [ {
"name" : "Pozycja 1",
"quantity" : 1
}, {
"name" : "Pozycja 2",
"quantity" : 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. |