Walidacja formularzy
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
- 1 Custom Attributes Form
- 2 Insurance Form
- 3 Parcels Simple Form
- 4 Dimensions Simple Form
- 5 Weight Simple Form
- 6 Receiver Form
- 7 Sender Form
- 8 Address Form
- 9 Create Address Form
- 10 Cod Form
- 11 Shipment Select Offers Form
- 12 Bulk Buy Shipments Form
- 13 Format Parameters Form
- 14 Mapping Form
- 15 Kody odpowiedzi HTTP
- 16 Błędy
- 16.1 Klucze błędów
- 16.2 Klucze błędów walidacji
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 jest wymagany dla poniższych serwisów:
Minimum |
| 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, (podana wartość nie jest widoczna na etykiecie) Maksimum 255 znaków. | ||
| String | Atrybut nie jest wymagany, możliwość przekazania pustego atrybutu, w przypadku przesyłek Paczkomat® atrybut jest wymagany. | ||
| 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 | ||
| String | regex | kraj | liczba znaków |
PL: \A(\(?((\+)|00)48\)?) | Polska | 9 znaków | ||
FR: \A(\(?((\+)|00)33\)?) | FR (Francja) | 9 znaków | ||
ES: \A(\(?((\+)|00)34\)?) | ES (Hiszpania) | 9 znaków | ||
BE: \A(\(?((\+)|00)32\)?) | BE (Belgia) | 8-9 znaków | ||
DE: \A(\(?((\+)|00)49\)?) | DE (Niemcy) | 10-11 znaków | ||
LU: \A(\(?((\+)|00)352\)?) | LU (Luksemburg) | 9 znaków | ||
PT: \A(\(?((\+)|00)351\)?) | PT (Portugalia) | 9 znaków | ||
AT: \A(\(?((\+)|00)43\)?) | AT (Austria) | 7-13 znaków | ||
GB: \A(\(?((\+)|00)44\)?) | GB (Wielka Brytania) | 10 znaków | ||
IT: \A(\(?((\+)|00)39\)?) | IT (Włochy) | 9-10 znaków | ||
NL: \A(\(?((\+)|00)31\)?) | NL (Holandia) | 10 znaków | ||
IE: \A(\(?((\+)|00)353\)?) | IE (Irlandia) | 10 znaków | ||
MC: \A(\(?((\+)|00)377\)?) | MC (Monako) | 8 znaków | ||
CH: \A(\(?((\+)|00)41\)?) | CH (Szwajcaria) | 9 znaków | ||
UA: \A(\(?((\+)|00)380\)?) | UA (Ukraina) | 9 znaków | ||
BY: \A(\(?((\+)|00)375\)?) | BY (Białoruś) | 9 znaków | ||
BG: \A(\(?((\+)|00)359\)?) | BG (Bułgaria) | 8-9 znaków | ||
CY: \A(\(?((\+)|00)357\)?) | CY (Cypr) | 8 znaków | ||
CZ: \A(\(?((\+)|00)420\)?) | CZ (Czechy) | 9 znaków | ||
DK: \A(\(?((\+)|00)45\)?) | DK (Dania) | 8 znaków | ||
EE: \A(\(?((\+)|00)372\)?) | EE (Estonia) | 7-8 znaków | ||
FI: \A(\(?((\+)|00)358\)?) | FI (Finlandia) | 8-10 znaków | ||
GR: \A(\(?((\+)|00)30\)?) | GR (Grecja) | 10 znaków | ||
HU: \A(\(?((\+)|00)36\)?) | HU (Węgry) | 9 znaków | ||
LT: \A(\(?((\+)|00)370\)?) | LT (Litwa) | 8 znaków | ||
LV: \A(\(?((\+)|00)371\)?) | LV (Łotwa) | 8 znaków | ||
MT: \A(\(?((\+)|00)356\)?) | MT (Malta) | 8 znaków | ||
SE: \A(\(?((\+)|00)46\)?) | SE (Szwecja) | 9 znaków | ||
SK: \A(\(?((\+)|00)421\)?) | SK (Słowacja) | 9 znaków |
Sender Form
Atrybut | Typ | Walidacja |
---|---|---|
| String | Atrybut nie jest wymagany, wymagalność pojawia się w momencie kiedy nie zostanie przekazany atrybut |
| String | 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 |
Address Form
Atrybut | Typ | Walidacja |
---|---|---|
| String | Atrybut nie jest wymagany, wymagalność pojawia się w momencie kiedy zostanie przekazany atrybut Maksimum 255 znaków. |
| String | Atrybut nie jest wymagany, wymagalność pojawia się w momencie kiedy zostanie przekazany atrybut Maksimum 255 znaków. |
| String | Atrybut nie jest wymagany, wymagalność pojawia się w momencie kiedy zostanie przekazany atrybut Maksimum 255 znaków. |
| 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 |
|
|