- Created by anagorski, last modified by Michał Machowski on Sept 16, 2022
You are viewing an old version of this page. View the current version.
Compare with Current View Page History
« Previous Version 12 Next »
Walidator (ang. validator) – jest skryptem sprawdzającym poprawność przekazywanych informacji w strukturze o określonej składni (JSON w przypadku metody POST
lub jako parametr w przypadku metody GET
). W przypadku platformy ShipX przeprowadzamy kilka wariantów walidacji jednocześnie.
Wraz z wysłaniem żądania, przekazywane są wartości podlegające walidacji, dzięki której przekazywane dane zgodne są z założeniami platformy, przyjmującej żądanie.
Dane, które nie spełniają założeń walidacji, nie są zapisywane przez platformę. Użytkownik w takim przypadku informowany jest czytelnym komunikatem zwrotnym.
Zasób posiada informacje dot. walidacji formularzy wykorzystywanych w ShipX.
Na tej stronie
Custom Attributes Form
Atrybut | Typ | Walidacja |
---|---|---|
| String | Atrybut jest wymagany dla poniższych serwisów: |
| String | Atrybut jest wymagany dla poniższych serwisów: Wymagalność przekazania atrybutu Powyższa wymagalność występuje wyłącznie dla następujących wartości atrybutu |
| String | Atrybut jest wymagany dla poniższych serwisów: Dopuszczalne wartości ( |
Insurance Form
Atrybut | Typ | Walidacja |
---|---|---|
| Decimal | Atrybut nie jest wymagany Minimum 1 mniej niż 10000000 |
| String | Atrybut nie jest wymagany, domyślna wartość PLN |
Parcels Simple Form
Atrybut | Typ | Walidacja |
---|---|---|
| Dimensions Simple Form | Atrybut nie jest wymagany, wymagalność pojawia się z chwilą kiedy |
| String | Atrybut nie jest wymagany, wymagalność pojawia się z chwilą kiedy |
| Weight Simple Form | Atrybut nie jest wymagany, wymagalność pojawia się z chwilą kiedy |
| String | Atrybut nie jest wymagany |
| Boolean | Atrybut nie jest wymagany, domyślna wartość |
Dodatkowa walidacja:
Przekazując kolekcję, pojawia się wymagalność przekazania atrybutu id
w obiekcie paczki, jeśli atrybut id
nie zostanie przekazany, użytkownik otrzyma stosowny komunikat.
Przekazując kolekcję, pojawia się wymagalność przekazania atrybutu id
w obiekcie paczki, jeśli atrybut id
nie będzie unikatowy w ramach żądania, użytkownik otrzyma stosowny komunikat.
Dimensions Simple Form
Atrybut | Typ | Walidacja |
---|---|---|
| Float | Atrybut jest wymagany, minimum 1 mniej niż 1000000, możliwość przekazania pustego atrybutu. |
| Float | Atrybut jest wymagany, minimum 1 mniej niż 1000000, możliwość przekazania pustego atrybutu. |
| Float | Atrybut jest wymagany, minimum 1 mniej niż 1000000, możliwość przekazania pustego atrybutu. |
| String | Atrybut nie jest wymagany, domyślna wartość mm |
Weight Simple Form
Atrybut | Typ | Walidacja | |
---|---|---|---|
| Float | Atrybut jest wymagany, minimum 1 mniej niż 10000000, możliwość przekazania pustego atrybutu. | |
| String | Atrybut nie jest wymagany, domyślna wartość kg |
Receiver Form
Atrybut | Typ | Walidacja |
---|---|---|
| String | Atrybut nie jest wymagany, wymagalność pojawia się w momencie kiedy nie zostanie przekazany atrybut Maksimum 255 znaków. |
| String | Atrybut nie jest wymagany, możliwość przekazania pustego atrybutu, w przypadku przesyłek Paczkomat® atrybut jest wymagany. |
| String | Atrybut jest wymagany. Tylko 9 cyfr (333222111) |
| Address Form | Atrybut jest wymagany dla poniższych serwisów: |
| String | Atrybut nie jest wymagany, wymagalność pojawia się w momencie kiedy nie zostanie przekazany atrybut |
| String | Atrybut nie jest wymagany, wymagalność pojawia się w momencie kiedy nie zostanie przekazany atrybut |
Sender Form
Atrybut | Typ | Walidacja |
---|---|---|
| String | Atrybut nie jest wymagany, wymagalność pojawia się w momencie kiedy nie zostanie przekazany atrybut |
| String | Atrybut nie jest wymagany, możliwość przekazania pustego atrybutu. |
| String | Atrybut jest wymagany. Tylko 9 cyfr (333222111) |
| Address Form | Atrybut jest wymagany dla poniższych serwisów:
|
| String | Atrybut nie jest wymagany, wymagalność pojawia się w momencie kiedy nie zostanie przekazany atrybut |
| String | Atrybut nie jest wymagany, wymagalność pojawia się w momencie kiedy nie zostanie przekazany atrybut |
Address Form
Atrybut | Typ | Walidacja |
---|---|---|
| String | Atrybut nie jest wymagany, wymagalność pojawia się w momencie kiedy zostanie przekazany atrybut |
| String | Atrybut nie jest wymagany, wymagalność pojawia się w momencie kiedy zostanie przekazany atrybut |
| String | Atrybut nie jest wymagany, wymagalność pojawia się w momencie kiedy zostanie przekazany atrybut |
| String | Atrybut nie jest wymagany |
| String | Atrybut nie jest wymagany, wymagalność pojawia się w momencie kiedy zostanie przekazany atrybut |
| String | Atrybut nie jest wymagany, wymagalność pojawia się w momencie kiedy zostanie przekazany atrybut |
Create Address Form
Atrybut | Typ | Walidacja | |
---|---|---|---|
| String | Atrybut jest wymagany, maksymalna długość 255 znaków, warunkiem walidacji atrybutu jest nieprzekazanie atrybutów | |
| String | Atrybut jest wymagany, maksymalna długość 255 znaków, warunkiem walidacji atrybutu jest nieprzekazanie atrybutów | |
| String | Atrybut jest wymagany, maksymalna długość 255 znaków, warunkiem walidacji atrybutu jest przekazanie atrybutu | |
| String | Atrybut nie jest wymagany, maksymalna długość 255 znaków | |
| String | Atrybut jest wymagany, maksymalna długość 255 znaków | |
| String | Atrybut jest wymagany, format adresu zgodnie z konwencją Polskiego adresu pocztowego np. | |
| String | Atrybut nie jest wymagany, minimum 2 znaki, maksimum 3 znaki |
Cod Form
Atrybut | Typ | Walidacja |
---|---|---|
| Decimal | Atrybut nie jest wymagany, Z chwilą przekazania danych system oczekuje wartości z przedziału od |
| String | Atrybut nie jest wymagany, domyślna wartość PLN |
Shipment Select Offers Form
Atrybut | Typ | Walidacja |
---|---|---|
| String | Atrybut nie jest wymagany |
| Integer | Atrybut jest wymagany
|
| Integer | Atrybut jest wymagany
|
Bulk Buy Shipments Form
Atrybut | Typ | Walidacja |
---|---|---|
| String | Atrybut nie jest wymagany |
| Integer | Atrybut jest wymagany
|
| Integer | Atrybut jest wymagany
|
Format Parameters Form
Atrybut | Typ | Walidacja |
---|---|---|
| String | Atrybut nie jest wymagany |
| String | Atrybut nie jest wymagany |
| String | Atrybut nie jest wymagany |
| Array[Integer] | Atrybut nie jest wymagany |
Mapping Form
Atrybut | Typ | Walidacja |
---|---|---|
| String | Atrybut nie jest wymagany, defaultowa wartość null |
| String | Atrybut nie jest wymagany, defaultowa wartość null |
| String | Atrybut nie jest wymagany, defaultowa wartość null |
| String | Atrybut nie jest wymagany, defaultowa wartość null |
| String | Atrybut nie jest wymagany, defaultowa wartość null |
| String | Atrybut nie jest wymagany, defaultowa wartość null |
| String | Atrybut nie jest wymagany, defaultowa wartość null |
| String | Atrybut nie jest wymagany, defaultowa wartość null |
- No labels