METODA POST
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 | TAK | Minimalna dopuszczalna wartość 0,01 | |
Waluta | estimatedPriceCurrency | string | TAK | Pole wyboru waluty ze słownika walut | |
Status | status | string | Nie | Możliwa wartość: w przygotowaniu (IN_PREPARE), w trakcie zatwierdzania (PENDING_APPROVAL), zaakceptowane (WAIT_FOR_REALIZATION), odrzucony (REJECTED) , zmodyfikowany (MODIFIED), zrealizowany (REALIZED), anulowany (CANCELED), | |
Nip firmy | companyNip | string | TAK | Nip firmy w ramach, której tworzone jest zapotrzebowanie | |
Login użytkownika | login | string | TAK | Login użytkownika tworzącego zapotrzebowanie | |
Szablon zapotrzebowania | requestTemplate | string | TAK | Pole wyboru typu zapotrzebowania ze słownika szablonów zapotrzebowań | |
Kategorie zakupowe | buyerCategoryStructCode | string | TAK | Słownik kategorii zakupowych. Konieczność przekazania kodu kategorii | |
Jednostka organizacyjna | organisationUnitStructCode | string | 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 | numeric | 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. |
UWAGA
Jeżeli nie posiadasz danej funkcji, skontaktuj się z nami w celu uzyskania szczegółów.