Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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


Panel
bgColor#f0f0f0
titleBGColor#f0f0f0
titleNa tej stronie

Table of Contents
minLevel2
 



Custom Attributes Form

AtrybutTypWalidacja
target_pointStringAtrybut nie jest wymagany
dropoff_pointString

Atrybut nie jest wymagany, wymagalność przekazania atrybutu dropoff_point występuje wraz z przekazaniem atrybutu sending_method

Powyższa wymagalność występuje wyłącznie dla następujących wartości atrybutu sending_method (parcel_locker, pok, courier_pok)

sending_methodStringAtrybut nie jest wymagany, dopuszczalne wartości (parcel_locker, pok, pop, courier_pok, branch, dispatch_order), możliwość przekazania pustego atrybutu.


Insurance Form

AtrybutTypWalidacja
insurance_amountDecimal

Atrybut nie jest wymagany

Minimum 1 mniej niż 10000000

insurance_currencyStringAtrybut nie jest wymagany, defoultowa wartość PLN


Parcels Simple Form

AtrybutTypWalidacja
dimensionsDimensions Simple FormAtrybut nie jest wymagany, wymagalność pojawia się z chwilą kiedy template nie zostanie przekazany.
templateStringAtrybut nie jest wymagany
weightWeight Simple FormAtrybut nie jest wymagany, wymagalność pojawia się z chwilą kiedy template nie zostanie przekazany.
idStringAtrybut nie jest wymagany
is_non_standardBooleanAtrybut nie jest wymagany, defoultowa wartość null

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

AtrybutTypWalidacja
heightFloatAtrybut jest wymagany, minimum 1 mniej niż 1000000, możliwość przekazania pustego atrybutu.
lengthFloatAtrybut jest wymagany, minimum 1 mniej niż 1000000, możliwość przekazania pustego atrybutu.
widthFloatAtrybut jest wymagany, minimum 1 mniej niż 1000000, możliwość przekazania pustego atrybutu.
unitStringAtrybut nie jest wymagany, defoultowa wartość mm


Weight Simple Form

Atrybut
Typ
Walidacja
amountFloatAtrybut jest wymagany, minimum 1 mniej niż 10000000, możliwość przekazania pustego atrybutu.
unitString

Atrybut nie jest wymagany, defoultowa

wartość mm

wartość kg


Receiver Form

AtrybutTypWalidacja
company_nameString

Atrybut nie jest wymagany, wymagalność pojawia się w momencie kiedy nie zostanie przekazany atrybut first_name,last_name oraz address.

Maksimum 255 znaków.

emailString

Atrybut nie jest wymagany, możliwość przekazania pustego atrybutu, w przypadku przesyłek paczkomatowych atrybut jest wymagany.

phoneString

Atrybut jest wymagany,

addressAddress FormAtrybut jest wymagany,
first_nameStringAtrybut nie jest wymagany, wymagalność pojawia się w momencie kiedy nie zostanie przekazany atrybut company_name, email oraz phone
last_nameStringAtrybut nie jest wymagany, wymagalność pojawia się w momencie kiedy nie zostanie przekazany atrybut company_name, email oraz phone


Sender Form

AtrybutTypWalidacja
company_nameStringAtrybut nie jest wymagany, wymagalność pojawia się w momencie kiedy nie zostanie przekazany atrybut first_name oraz last_name
emailStringAtrybut nie jest wymagany, możliwość przekazania pustego atrybutu.
phoneStringAtrybut jest wymagany.
addressAddress FormAtrybut jest wymagany.
first_nameStringAtrybut nie jest wymagany, wymagalność pojawia się w momencie kiedy nie zostanie przekazany atrybut company_name, first_name lub last_name
last_nameStringAtrybut nie jest wymagany, wymagalność pojawia się w momencie kiedy nie zostanie przekazany atrybut company_name, first_name lub last_name


Address Form

AtrybutTypWalidacja
line1StringAtrybut nie jest wymagany
cityStringAtrybut nie jest wymagany
post_codeStringAtrybut nie jest wymagany
country_codeStringAtrybut nie jest wymagany
streetStringAtrybut nie jest wymagany
building_numberStringAtrybut nie jest wymagany


Create Address Form

AtrybutTypWalidacja
streetStringAtrybut jest wymagany, maksymalna długość 255 znaków, warunkiem walidacji atrybutu jest nieprzekazanie atrybutów line1 / line2 lub przekazanie atrybutu building_number
building_numberStringAtrybut jest wymagany, maksymalna długość 255 znaków, warunkiem walidacji atrybutu jest nieprzekazanie atrybutów line1 / line2 lub przekazanie atrybutu street
line1StringAtrybut jest wymagany, maksymalna długość 255 znaków, warunkiem walidacji atrybutu jest przekazanie atrybutu line2
line2StringAtrybut nie jest wymagany, maksymalna długość 255 znaków
cityStringAtrybut jest wymagany, maksymalna długość 255 znaków
post_codeStringAtrybut jest wymagany, format adresu zgodnie z konwencją Polskiego adresu pocztowego np. 00-000
country_codeStringAtrybut nie jest wymagany, minimum 2 znaki, maksimum 3 znaki


Cod Form

AtrybutTypWalidacja
cod_amountDecimalAtrybut nie jest wymagany, Z chwilą przekazania danych system oczekuje wartości z przedziału od 1 do 10000000
cod_currencyStringAtrybut nie jest wymagany, defoultowa wartość PLN


Shipment Select Offers Form

AtrybutTypWalidacja
idStringAtrybut nie jest wymagany
shipment_idInteger

Atrybut jest wymagany

  • Dopuszczalny format Integer
offer_idInteger

Atrybut jest wymagany

  • Dopuszczalny format Integer


Bulk Buy Shipments Form

AtrybutTypWalidacja
idStringAtrybut nie jest wymagany
shipment_idInteger

Atrybut jest wymagany

  • Dopuszczalny format Integer
offer_idInteger

Atrybut jest wymagany

  • Dopuszczalny format Integer


Format Parameters Form

AtrybutTypWalidacja
field_separatorStringAtrybut nie jest wymagany
character_encodingStringAtrybut nie jest wymagany
text_qualifierStringAtrybut nie jest wymagany
sheets_indexArray[Integer]Atrybut nie jest wymagany


Mapping Form

AtrybutTypWalidacja
custom_attributesStringAtrybut nie jest wymagany, defaultowa wartość nil
insuranceStringAtrybut nie jest wymagany, defaultowa wartość nil
codStringAtrybut nie jest wymagany, defaultowa wartość nil
additional_servicesStringAtrybut nie jest wymagany, defaultowa wartość nil
serviceStringAtrybut nie jest wymagany, defaultowa wartość nil
parcelsStringAtrybut nie jest wymagany, defaultowa wartość nil
receiverStringAtrybut nie jest wymagany, defaultowa wartość nil
senderStringAtrybut nie jest wymagany, defaultowa wartość nil