1
Umowa nr DG/CIT/172/2006 z dnia 28.11.2006 r. na
ś
wiadczenie usług informatycznych w zakresie
Oprogramowania
DOK
Rodzaj dokumentu
Specyfikacja funkcjonalna
Wersja dokumentu
10.1
Autor
Krzysztof Bartyś
Projekt
EKN
Data sporządzenia
2011-02-22
Data akceptacji dokumentu
Akceptacja dokumentu
Ze strony Poczty
Ze strony POSTDATA
Opis przykładowego pliku XML
2
Opis przykładowego pliku XML
Wersja 10.1
POSTDATA S.A.
Oddział w Gdańsku
ul. Fabryczna 3
85-741 Bydgoszcz
tel. 0-52 / 370-57-57
fax.0-52 / 370-57-77
ul. Długie Ogrody 10-12
80-765 Gdańsk,
tel. 0-58 / 32-60-430
fax.0-58 / 32-01-307
G
RUDZIEŃ
2010
Opis przykładowego pliku XML
3
S
PIS TREŚCI
Wstęp .......................................................................................................................................... 4
2. P
LIK PRZESYŁEK
EKN ............................................................................................................. 5
2.1. Przykład ........................................................................................................................... 5
2.2. Nazwa pliku ..................................................................................................................... 5
2.3. Sekcja pól <Nadawca> .................................................................................................... 6
2.4. Sekcja pól <Zbior> .......................................................................................................... 7
2.5. Sekcja pól <Przesylka> ................................................................................................... 8
2.5.1. <Przesyłka polecona> .............................................................................................. 9
2.5.2. <Paczka pocztowa> ................................................................................................ 10
2.5.3. <Przesyłka pobraniowa> ........................................................................................ 12
2.5.4. <Przesyłka listowa zwykła> ................................................................................... 14
2.5.5. <E-PRZESYŁKA>................................................................................................. 15
2.5.6. <POCZTEX> ......................................................................................................... 17
3. Historia zmian dokumentu ................................................................................................... 19
Opis przykładowego pliku XML
4
Wstęp
Niniejszy dokument jest opisem przykładowego pliku XML zawierającego przesyłki
przeznaczone do zaimportowania w systemie SP2000. Pliki takie są zgodne ze strukturą pliku
przesyłek generowanego przez system EKN, ale utworzonych w tym przypadku przez
systemy firm trzecich w postaci „czystego xml”.
Niniejszy przykład opisuje taki plik na podstawie przesyłek: przesyłka polecona, paczka
pocztowa, przesyłka pobraniowa, przesyłka listowa zwykła, E-PRZESYŁKA, POCZTEX na
jutro standard.
Pliki utworzone na podstawie tego wzoru będą mogły być przekazywane do zaimportowania
w systemie SP2000, wykorzystując mechanizmy importu pliku przesyłek EKN.
Opis przykładowego pliku XML
5
2. P
LIK PRZESYŁEK
EKN
2.1. Przykład
Przykładowy plik XML z przesyłkami 845, 846, 848, 840, 850, 812
101230_145457_polr
ejstat.xml
2.2. Nazwa pliku
Informacje o przesyłkach do nadania zapisywane są pod postacią pliku XML.
Przykładowy plik XML umieszczony został powyżej. Plik ten posiada nazwę pliku
101230_145457_polrejstat, gdzie
• 101230 – oznacza 30 grudnia 2010 (data utworzenia pliku)
• 145457 – oznacza godzinę 14:54 i 57 sekund (czas utworzenia pliku)
• polrejstat – ciąg znaków odpowiadających nazwie skróconej klienta (skrót nazwy
klienta, w pliku XML jest to wartość pola „NazwaSkrocona”)
Rozszerzeniem pliku jest „xml”.
Pierwszym wierszem pliku XML jest następujący, stały ciąg:
•
<?xml version=”1.0” encoding=”iso-8859-2”?>
Kolejne wiersze zawierają pozostałe informacje o przesyłkach, które zawierają się
w znacznikach otwierających (<znacznik>) i zamykających (</znacznik>):
• Nadawca
• Zbior
• Przesylka
Opis przykładowego pliku XML
6
2.3. Sekcja pól <Nadawca>
Znacznik <Nadawca> posiada atrybuty charakteryzujące nadawcę przesyłek zawartych w
pliku. Znacznik ten zawiera w sobie znaczniki <Zbior> (Zbior – grupuje wiele różnych
przesyłek), których może być nieskończenie wiele. Poniżej znajduje się opis atrybutów, dla
znacznika <Nadawca>.
P
OLE
T
YP
O
PIS
W
YMAGANA
WARTOŚĆ
Struktura
CHAR (3)
Numer wersji struktury w oparciu, o który został
utworzony plik XML zawierający definicje
przesyłek pocztowych.
Aktualnym numerem wersji jest 1.6
Tak
Nazwa
CHAR (60)
Nazwa
nadawcy
(podmiotu,
dla
którego
utworzony został plik z przesyłkami do nadania).
Pole ograniczone do 60 znaków.
Tak
NazwaSkrocona
CHAR (10)
Nazwa skrócona klienta nadającego przesyłki.
Długość pola od 6 do 10 znaków.
Tak
Ulica
CHAR (35)
Nazwa ulicy nadawcy.
Pole ograniczone do 30 znaków.
Nie
Dom
CHAR (11)
Oznaczenie domu nadawcy przesyłek. Pole
ograniczone do 5 znaków.
Tak
Lokal
CHAR (11)
Oznaczenie domu nadawcy przesyłek. Pole
ograniczone do 5 znaków.
Nie
Miejscowosc
CHAR (30)
Oznaczenie miejscowości nadawcy przesyłek. Pole
ograniczone do 30 znaków.
Tak
Kod
NUMBER (5)
Oznaczenie kodu pocztowego nadawcy przesyłek.
Pole musi mieć 5 cyfr.
Tak
NIP
NUMBER (10)
Oznaczenie NIP’u nadawcy przesyłek.
Pole musi mieć 10 cyfr.
Tak
Zrodlo
CHAR (7)
Oznaczenie miejsca tworzenia przesyłek.
Pole musi mieć wartość „NADAWCA”.
Tak
Guid
CHAR (38)
Unikalny identyfikator nadawcy przesyłek.
Pole posiada wartość wyliczoną zgodnie z
algorytmem definiowania nr GUID. Kolejne pliki
tego samego nadawcy muszą zawierać tą samą
wartość pola GUID
Tak
Opis przykładowego pliku XML
7
2.4. Sekcja pól <Zbior>
Znacznik <Zbior> posiada atrybuty charakteryzujące zbiór przesyłek przeznaczonych do
nadania. Znacznik ten zawiera w sobie znaczniki <Przesyłka>, których może być
nieskończenie wiele. Poniżej znajduje się opis atrybutów, dla znacznika <Zbior>.
P
OLE
T
YP
O
PIS
W
YMAGANA
WARTOŚĆ
Nazwa
CHAR (13)
Nazwa zbioru, jaka została nadana przez system;
w formacie: rrrr-mm-dd\lp
Przykład: 2009-06-18\1, nazwą zbioru jest rok-
miesiąc-dzień, symbol „\”, nr kolejny zbioru
utworzonego w danym dniu.
Tak
DataUtworzenia
DATATIME (19)
Data i godzina utworzenia zbioru przesyłek; w
formacie: rrrr-mm-ddThh:mm:ss
Tak
Opis
CHAR (30)
Opis, jaki został zdefiniowany dla zbioru
przesyłek.
Nie
IloscPrzesylek
NUMBER (7)
Ilość przesyłek znajdujących się w zbiorze
przesyłek
Tak
Guid
CHAR (38)
Unikalny identyfikator nadawcy przesyłek.
Pole posiada wartość wyliczoną zgodnie z
algorytmem definiowania nr GUID.
Kolejne zbiory tego samego nadawcy muszą
zawierać inną wartość pola GUID.
Tak
Znacznik <Przesylka> posiada atrybuty charakteryzujące pojedynczą przesyłkę przeznaczoną
do nadania. Atrybuty te są uzależnione od rodzaju przesyłki (np. przesyłka polecona, paczka
pocztowa, przesyłka pobraniowa). Znacznik ten zawiera w sobie znaczniki <Atrybut>,
które mogą posiadać swoje atrybuty dokładniej opisujące przesyłkę.
Opis przykładowego pliku XML
8
2.5. Sekcja pól <Przesylka>
Poniżej znajduje się opis atrybutów, dla znacznika <Przesylka>
P
OLE
T
YP
O
PIS
W
YMAGANA
WARTOŚĆ
Guid
CHAR (38)
Unikalny identyfikator nadawcy przesyłek.
Pole posiada wartość wyliczoną zgodnie z algorytmem
definiowania nr GUID.
Kolejne przesyłki tego samego nadawcy muszą zawierać
inną wartość pola GUID.
Tak
Atrybut
Pole odpowiadające atrybutom przesyłki.
Ograniczenia pola wynikają z zastosowania właściwych atrybutów.
Tak
Uwaga:
W załączonym przykładowym pliku XML, zawierającym przesyłki pocztowe przeznaczone
do nadania, wśród pól opisujących przesyłkę, znajdują się pola o nazwie „Typ”, które w
niektórych przypadkach mają określoną wartość lub tej wartości nie mają: pole „Typ” może
posiadać wartość „Adresat” lub nie posiadać żadnej wartości (NULL). Jeśli pole „Typ”
posiada wartość „Adresat”, to pole „Nazwa” przyjmuje wartości: Nazwa, NazwaII, Ulica,
Dom, Lokal, Miejscowość, Kod, Kraj.
Jeśli pole „Typ” nie posiada żadnej wartości, co oznacza, że posiada wartość pustą (NULL),
wówczas pole „Nazwa” przyjmuje różne wartości (charakteryzujące konkretne przesyłki),
których występowanie jest uzależnione od rodzaju przesyłki (nie dla wszystkich przesyłek
występują takie same pola).
Opis przykładowego pliku XML
9
2.5.1. <Przesyłka polecona>
Poniżej znajduje się opis atrybutów dla pola <Atrybut> dla przesyłki: „Przesyłka polecona”
A
TRYBUTY
T
YP
O
PIS
W
YMAGANA
WARTOŚĆ
Typ=””
Nazwa=”Symbol”
NUMBER (3)
Cyfrowy symbol odpowiadający przesyłce
poleconej. Wartością pola jest „845”
Wartość pola jest wymagana
Tak
Typ=””
Nazwa=”NrNadania”
CHAR (20)
Dwudziestocyfrowy numer identyfikujący
przesyłkę.
Pole
jest
wyliczane
wg
specjalnego algorytmu.
Nie
Typ=””
Nazwa=”Masa
NUMBER (7)
Masa przesyłki, podana w gramach. Pole
ograniczone do 2000 gramów.
Nie
Typ=””
Nazwa=”Umowa”
NUMBER (10)
Oznaczenie umowy na podstawie, której
nadawane są przesyłki pocztowe.
Pole posiadać może konkretną wartość
odpowiadającą oznaczeniu umowy lub wpis
„Bez umowy”.
Nie
Typ=””
Nazwa=”KartaUmowy”
NUMBER (10)
Oznaczenie karty na podstawie, której
nadawane są przesyłki pocztowe.
Pole posiadać może konkretną wartość
odpowiadającą oznaczeniu karty umowy.
Nie
Typ=””
Nazwa=”Kategoria
CHAR (1)
Informuje o tym, jakiej kategorii jest
przesyłka; wartości:
E – ekonomiczna
P – priorytetowa
Tak
Typ=””
Nazwa=”PosteRestante
CHAR (1)
Informuje o tym, czy przesyłka jest nadana
na Poste Restante; wartości:
T – tak
N – nie
Tak
Typ=””
Nazwa=”EgzBibl
CHAR (1)
Informuje o tym, czy przesyłka jest
„Egzemplarzem bibliotecznym”; wartości:
T – tak
N – nie
Tak
Typ=””
Nazwa=”DlaOciemn
CHAR (1)
Informuje o tym, czy przesyłka jest „Dla
ociemniałych”; wartości:
T – tak
N – nie
Tak
Typ=””
Nazwa=”Ilosc”
NUMBER (1)
Informuje o ilości przesyłek; domyślną
wartością jest „1”.
Tak
Typ=””
Nazwa=”Uslugi”
CHAR (8)
Usługi komplementarne, jakie są aktywne
dla rozpatrywanej przesyłki; wartości:
Z – żądanie zwrotu/dosłania
R – polecenie
O – potwierdzenie odbioru
Domyślną wartością jest „R”.
Tak
Opis przykładowego pliku XML
10
Typ=””
Nazwa=”IloscPotwOdb”
NUMBER (1)
Ilość potwierdzeń odbioru.
Tak,
dla
Usługi=O
Typ=””
Nazwa=”Strefa”
CHAR (1)
Dotyczy gabarytu przesyłki, wartości:
A – gabaryt A
B – gabaryt B
Tak
Typ=””
Nazwa=”Wersja”
NUMBER (1)
Numer wersji struktury danych dla danego
rodzaju przesyłki.
Aktualnym numerem wersji jest „1”
Tak
Typ=”Adresat”
Nazwa=”Nazwa”
CHAR (30)
Oznaczenie pierwszego członu nazwy
adresata przesyłki.
Tak
Typ=”Adresat”
Nazwa=”NazwaII”
CHAR (30)
Oznaczenie
drugiego
członu
nazwy
adresata przesyłki.
Nie
Typ=”Adresat”
Nazwa=”Ulica”
CHAR (35)
Oznaczenie ulicy adresata przesyłki.
Nie
Typ=”Adresat”
Nazwa=”Dom”
CHAR (11)
Oznaczenie domu adresata przesyłki, pole
max 5-znakowe.
Tak
Typ=”Adresat”
Nazwa=”Lokal”
CHAR (11)
Oznaczenie domu adresata przesyłki, pole
max 5-znakowe.
Nie
Typ=”Adresat”
Nazwa=”Miejscowosc”
CHAR (30)
Oznaczenie
miejscowości
adresata
przesyłki.
Tak
Typ=”Adresat”
Nazwa=”Kod”
NUMBER (5)
Oznaczenie kodu pocztowego adresata
przesyłki.
Tak
Typ=”Adresat”
Nazwa=”Kraj”
CHAR (6)
Oznaczenie kraju adresata przesyłki. Pole
tekstowe, zawierające nazwę kraju adresata
przesyłki („Polska”).
Tak
2.5.2. <Paczka pocztowa>
Poniżej znajduje się opis atrybutów dla pola <Atrybut> dla przesyłki: „Paczka pocztowa”
A
TRYBUTY
T
YP
O
PIS
W
YMAGANA
WARTOŚĆ
Typ=””
Nazwa=”Symbol”
NUMBER (3)
Cyfrowy symbol odpowiadający paczce
pocztowej. Wartością pola jest „846”
Wartość pola jest wymagana
Tak
Typ=””
Nazwa=”NrNadania”
CHAR (20)
Dwudziestocyfrowy numer identyfikujący
przesyłkę.
Pole
jest
wyliczane
wg
specjalnego algorytmu.
Nie
Typ=””
Nazwa=”Masa
NUMBER (7)
Masa przesyłki, podana w gramach. Pole
ograniczone do 10000 gramów.
Nie
Opis przykładowego pliku XML
11
Typ=””
Nazwa=”Umowa”
NUMBER (10)
Oznaczenie umowy na podstawie, której
nadawane są przesyłki pocztowe.
Pole posiadać może konkretną wartość
odpowiadającą oznaczeniu umowy lub wpis
„Bez umowy”. Pole jest ograniczone do 35
znaków
Nie
Typ=””
Nazwa=”KartaUmowy”
NUMBER (10)
Oznaczenie karty na podstawie której
nadawane są przesyłki pocztowe.
Pole posiadać może konkretną wartość
odpowiadającą oznaczeniu karty umowy.
Nie
Typ=””
Nazwa=”Kategoria
CHAR (1)
Informuje o tym, jakiej kategorii jest
przesyłka; wartości:
E – ekonomiczna
P – priorytetowa
Tak
Typ=””
Nazwa=”PosteRestante
CHAR (1)
Informuje o tym, czy przesyłka jest nadana
na Poste Restante; wartości:
T – tak
N – nie
Tak
Typ=””
Nazwa=”EgzBibl
CHAR (1)
Informuje o tym, czy przesyłka jest
„Egzemplarzem bibliotecznym”; wartości:
T – tak
N – nie
Tak
Typ=””
Nazwa=”DlaOciemn
CHAR (1)
Informuje o tym, czy przesyłka jest „Dla
ociemniałych”; wartości:
T – tak
N – nie
Tak
Typ=””
Nazwa=”Ilosc”
NUMBER (1)
Informuje o ilości przesyłek; domyślną
wartością jest „1”.
Tak
Typ=””
Nazwa=”Uslugi”
CHAR (8)
Usługi komplementarne, jakie są aktywne
dla rozpatrywanej przesyłki; wartości:
Z – żądanie zwrotu/dosłania
W – zadeklarowanie wartości
O – potwierdzenie odbioru
Tak
z
wartością „W”
dla
paczki
wartościowej
Nie dla paczki
zwykłej
Typ=””
Nazwa=”IloscPotwOdb”
NUMBER (1)
Ilość potwierdzeń odbioru.
Tak,
dla
Usługi=O
Typ=””
Nazwa=”Wartosc”
NUMBER (7)
Deklarowana wartość przesyłki; podana w
groszach.
Wartość pola ograniczona do 20000 groszy.
Tak,
dla
Usługi=W
Typ=””
Nazwa=”Strefa”
CHAR (1)
Dotyczy gabarytu przesyłki, wartości:
A – gabaryt A
B – gabaryt B
Tak
Typ=””
Nazwa=”Wersja”
NUMBER (1)
Numer wersji struktury danych dla danego
rodzaju przesyłki.
Aktualnym numerem wersji jest „1”
Tak
Typ=”Adresat”
Nazwa=”Nazwa”
CHAR (30)
Oznaczenie pierwszego członu nazwy
adresata przesyłki.
Tak
Typ=”Adresat”
Nazwa=”NazwaII”
CHAR (30)
Oznaczenie
drugiego
członu
nazwy
adresata przesyłki.
Nie
Typ=”Adresat”
Nazwa=”Ulica”
CHAR (30)
Oznaczenie ulicy adresata przesyłki.
Nie
Opis przykładowego pliku XML
12
Typ=”Adresat”
Nazwa=”Dom”
CHAR (5)
Oznaczenie domu adresata przesyłki, pole
max 5-znakowe.
Tak
Typ=”Adresat”
Nazwa=”Lokal”
CHAR (5)
Oznaczenie domu adresata przesyłki, pole
max 5-znakowe
Nie
Typ=”Adresat”
Nazwa=”Miejscowosc”
CHAR (30)
Oznaczenie
miejscowości
adresata
przesyłki.
Tak
Typ=”Adresat”
Nazwa=”Kod”
NUMBER (5)
Oznaczenie kodu pocztowego adresata
przesyłki.
Tak
Typ=”Adresat”
Nazwa=”Kraj”
CHAR (6)
Oznaczenie kraju adresata przesyłki. Pole
tekstowe, zawierające nazwę kraju adresata
przesyłki („Polska”).
Tak
2.5.3. <Przesyłka pobraniowa>
Poniżej znajduje się opis atrybutów dla pola <Atrybut> dla przesyłki: „Przesyłka
pobraniowa”.
A
TRYBUTY
T
YP
O
PIS
W
YMAGANA
WARTOŚĆ
Typ=””
Nazwa=”Symbol”
NUMBER (3)
Cyfrowy symbol odpowiadający przesyłce
pobraniowej. Wartością pola jest „848”
Tak
Typ=””
Nazwa=”NrNadania”
CHAR (20)
Dwudziestocyfrowy numer identyfikujący
przesyłkę.
Pole
jest
wyliczane
wg
specjalnego algorytmu.
Nie
Typ=””
Nazwa=”Masa
NUMBER (7)
Masa przesyłki, podana w gramach. Pole
ograniczone do 30000 gramów.
Nie
Typ=””
Nazwa=”KwotaPobrania”
NUMBER (7)
Kwota, jaką należy pobrać w związku z
doręczeniem przesyłki pobraniowej.
Wartość pola ograniczona do 20000 groszy.
Tak
Typ=””
Nazwa=”SposobPobrania”
CHAR (1)
Informuje o tym, jaki jest sposób
przekazania kwoty pobrania; wartości:
P – na wskazany adres
S – na rachunek bankowy
Tak
Typ=””
Nazwa=”Umowa”
NUMBER (10)
Oznaczenie umowy na podstawie, której
nadawane są przesyłki pocztowe.
Pole posiadać może konkretną wartość
odpowiadającą oznaczeniu umowy lub wpis
„Bez umowy”.
Nie
Typ=””
Nazwa=”KartaUmowy”
NUMBER (10)
Oznaczenie karty na podstawie, której
nadawane są przesyłki pocztowe.
Pole posiadać może konkretną wartość
odpowiadającą oznaczeniu karty umowy.
Nie
Opis przykładowego pliku XML
13
Typ=””
Nazwa=”Kategoria
CHAR (1)
Informuje o tym, jakiej kategorii jest
przesyłka; wartości:
E – ekonomiczna
P – priorytetowa
Tak
Typ=””
Nazwa=”PosteRestante
CHAR (1)
Informuje o tym, czy przesyłka jest nadana
na Poste Restante; wartości:
T – tak
N – nie
Tak
Typ=””
Nazwa=”Ilosc”
NUMBER (1)
Informuje o ilości przesyłek; domyślną
wartością jest „1”.
Tak
Typ=””
Nazwa=”Uslugi”
CHAR (8)
Usługi komplementarne, jakie są aktywne
dla rozpatrywanej przesyłki; wartości:
S – sprawdzenie zawartości
W – zadeklarowanie wartości
K – ostrożnie
O – potwierdzenie odbioru
Nie
Typ=””
Nazwa=”IloscPotwOdb”
NUMBER (1)
Ilość potwierdzeń odbioru.
Tak,
dla
Usługi=O
Typ=””
Nazwa=”Wartosc”
NUMBER (7)
Deklarowana wartość przesyłki; podana w
groszach.
Wartość pola ograniczona do 20000 groszy.
Tak,
dla
Usługi=W
Typ=””
Nazwa=”Strefa”
CHAR (1)
Dotyczy gabarytu przesyłki, wartości:
A – gabaryt A
B – gabaryt B
Tak
Typ=””
Nazwa=”Wersja”
NUMBER (1)
Numer wersji struktury danych dla danego
rodzaju przesyłki.
Aktualnym numerem wersji jest „1”
Tak
Typ=”Adresat”
Nazwa=”Nazwa”
CHAR (30)
Oznaczenie pierwszego członu nazwy
adresata przesyłki.
Tak
Typ=”Adresat”
Nazwa=”NazwaII”
CHAR (30)
Oznaczenie
drugiego
członu
nazwy
adresata przesyłki.
Nie
Typ=”Adresat”
Nazwa=”Ulica”
CHAR (35)
Oznaczenie ulicy adresata przesyłki.
Nie
Typ=”Adresat”
Nazwa=”Dom”
CHAR (11)
Oznaczenie domu adresata przesyłki, pole
max 5-znakowe.
Tak
Typ=”Adresat”
Nazwa=”Lokal”
CHAR (11)
Oznaczenie domu adresata przesyłki, pole
max 5-znakowe.
Nie
Typ=”Adresat”
Nazwa=”Miejscowosc”
CHAR (30)
Oznaczenie
miejscowości
adresata
przesyłki.
Tak
Typ=”Adresat”
Nazwa=”Kod”
NUMBER (5)
Oznaczenie kodu pocztowego adresata
przesyłki.
Tak
Typ=”Adresat”
Nazwa=”Kraj”
CHAR (6)
Oznaczenie kraju adresata przesyłki. Pole
tekstowe, zawierające nazwę kraju adresata
przesyłki („Polska”).
Tak
Opis przykładowego pliku XML
14
2.5.4. <Przesyłka listowa zwykła>
Poniżej znajduje się opis atrybutów dla pola <Atrybut> dla przesyłki: „Przesyłka listowa
zwykła”.
A
TRYBUTY
T
YP
O
PIS
W
YMAGANA
WARTOŚĆ
Typ=””
Nazwa=”Symbol”
NUMBER (3)
Cyfrowy symbol odpowiadający przesyłce
listowej zwykłej. Wartością pola jest „840”
Wartość pola jest wymagana
Tak
Typ=””
Nazwa=”Masa
NUMBER (7)
Masa przesyłki, podana w gramach. Pole
ograniczone do 2000 gramów.
Nie
Typ=””
Nazwa=”Umowa”
NUMBER (10)
Oznaczenie umowy na podstawie, której
nadawane są przesyłki pocztowe.
Pole posiadać może konkretną wartość
odpowiadającą oznaczeniu umowy lub wpis
„Bez umowy”.
Nie
Typ=””
Nazwa=”KartaUmowy”
NUMBER (10)
Oznaczenie karty na podstawie, której
nadawane są przesyłki pocztowe.
Pole posiadać może konkretną wartość
odpowiadającą oznaczeniu karty umowy.
Nie
Typ=””
Nazwa=”Kategoria
CHAR (1)
Informuje o tym, jakiej kategorii jest
przesyłka; wartości:
E – ekonomiczna
P – priorytetowa
Tak
Typ=””
Nazwa=”PosteRestante
CHAR (1)
Informuje o tym, czy przesyłka jest nadana
na Poste Restante; wartości:
T – tak
N – nie
Tak
Typ=””
Nazwa=”EgzBibl
CHAR (1)
Informuje o tym, czy przesyłka jest
„Egzemplarzem bibliotecznym”; wartości:
T – tak
N – nie
Tak
Typ=””
Nazwa=”DlaOciemn
CHAR (1)
Informuje o tym, czy przesyłka jest „Dla
ociemniałych”; wartości:
T – tak
N – nie
Tak
Typ=””
Nazwa=”Ilosc”
NUMBER (1)
Informuje o ilości przesyłek; domyślną
wartością jest „1”.
Tak
Typ=””
Nazwa=”Strefa”
CHAR (1)
Dotyczy gabarytu przesyłki, wartości:
A – gabaryt A
B – gabaryt B
Tak
Typ=””
Nazwa=”Wersja”
NUMBER (1)
Numer wersji struktury danych dla danego
rodzaju przesyłki.
Aktualnym numerem wersji jest „1”
Tak
Typ=”Adresat”
Nazwa=”Nazwa”
CHAR (30)
Oznaczenie pierwszego członu nazwy
adresata przesyłki.
Nie
Typ=”Adresat”
Nazwa=”NazwaII”
CHAR (30)
Oznaczenie
drugiego
członu
nazwy
adresata przesyłki.
Nie
Opis przykładowego pliku XML
15
Typ=”Adresat”
Nazwa=”Ulica”
CHAR (35)
Oznaczenie ulicy adresata przesyłki.
Nie
Typ=”Adresat”
Nazwa=”Dom”
CHAR (11)
Oznaczenie domu adresata przesyłki, pole
max 5-znakowe.
Nie
Typ=”Adresat”
Nazwa=”Lokal”
CHAR (11)
Oznaczenie domu adresata przesyłki, pole
max 5-znakowe.
Nie
Typ=”Adresat”
Nazwa=”Miejscowosc”
CHAR (30)
Oznaczenie
miejscowości
adresata
przesyłki.
Nie
Typ=”Adresat”
Nazwa=”Kod”
NUMBER (5)
Oznaczenie kodu pocztowego adresata
przesyłki.
Nie
Typ=”Adresat”
Nazwa=”Kraj”
CHAR (6)
Oznaczenie kraju adresata przesyłki. Pole
tekstowe, zawierające nazwę kraju adresata
przesyłki („Polska”).
Nie
Uwaga:
Podanie danych adresowych dla przesyłki 840 jest opcjonalne: jeśli zostały podane to pola
adresowe występują, jeśli ich nie podano to pola adresowe nie występuja.
2.5.5. <E-PRZESYŁKA>
Poniżej znajduje się opis atrybutów dla pola <Atrybut> dla przesyłki: „E-PRZESYŁLA”.
A
TRYBUTY
T
YP
O
PIS
W
YMAGANA
WARTOŚĆ
Typ=””
Nazwa=”Symbol”
NUMBER (3)
Cyfrowy
symbol
odpowiadający
E-PRZESYŁCE. Wartością pola jest „850”
Tak
Typ=””
Nazwa=”NrNadania”
CHAR (20)
Dwudziestocyfrowy numer identyfikujący
przesyłkę.
Pole
jest
wyliczane
wg
specjalnego algorytmu.
Nie
Typ=””
Nazwa=”Masa
NUMBER (7)
Masa przesyłki, podana w gramach. Pole
ograniczone do 30000 gramów.
Nie
Typ=””
Nazwa=”Umowa”
NUMBER (10)
Oznaczenie umowy na podstawie, której
nadawane są przesyłki pocztowe.
Pole posiadać może konkretną wartość
odpowiadającą oznaczeniu umowy lub wpis
„Bez umowy”.
Nie
Typ=””
Nazwa=”KartaUmowy”
NUMBER (10)
Oznaczenie karty na podstawie której
nadawane są przesyłki pocztowe.
Pole posiadać może konkretną wartość
odpowiadającą oznaczeniu karty umowy.
Nie
Typ=””
Nazwa=”Ilosc”
NUMBER (1)
Informuje o ilości przesyłek; domyślną
wartością jest „1”.
Tak
Opis przykładowego pliku XML
16
Typ=””
Nazwa=”Uslugi”
CHAR (8)
Usługi komplementarne, jakie są aktywne
dla rozpatrywanej przesyłki; wartości:
S – sprawdzenie zawartości
W – zadeklarowanie wartości
K – ostrożnie
O – potwierdzenie wydania/zwrotu
Nie
Typ=””
Nazwa=”Wartosc”
NUMBER (7)
Deklarowana wartość przesyłki; podana w
groszach.
Wartość pola ograniczona do 20000 groszy.
Tak,
dla
Usługi=W
Typ=””
Nazwa=”KwotaPobrania”
NUMBER (7)
Kwota, jaką należy pobrać od Adresata w
związku z doręczeniem E-PRZESYŁKI.
Wartość pola ograniczona do 20000 groszy.
Nie, Tak dla
Typ=S lub P
Typ=””
Nazwa=”SposobPobrania”
CHAR (1)
Informuje o tym rodzaju przesyłki dla
E-PRZESYŁKI; wartości:
E – standard
P – pobranie na wskazany adres
S – pobranie na rachunek bankowy
Nie, Tak dla
Typ=S lub P
Typ=””
Nazwa=”SposobPowiadomie
niaNadawcy”
CHAR (1)
Informuje o sposobie powiadomienia
nadawcy o oczekującej E-PRZESYŁCE;
wartości:
E – e-mail
M – SMS
Tak dla Usługi
= O
Typ=””
Nazwa=”KontaktNadawcy”
CHAR (50)
lub
CHAR (9)
Informuje o konkretnej wartości dla
sposobu powiadomienia nadawcy:
e-mail (50 znaków), SMS (9 cyfr)
Tak dla Usługi
= O
Typ=””
Nazwa=”SposobPowiadomie
niaAdresata”
CHAR (1)
Informuje o sposobie powiadomienia
adresata o oczekującej E-PRZESYŁCE;
wartości:
E – e-mail
M – SMS
Tak
Typ=””
Nazwa=”KontaktAdresata”
CHAR (50)
lub
CHAR (9)
Informuje o konkretnej wartości dla
sposobu powiadomienia adresata:
e-mail (50 znaków), SMS (9 cyfr)
Tak
Typ=””
Nazwa=”KodUP”
NUMBER (5)
Kod
pocztowy
Placówki
Pocztowej
wydającej E-PRZESYŁKĘ.
Tak
Typ=””
Nazwa=”MiejscowoscUP”
CHAR (30)
Nazwa Placówki Pocztowej wydającej
E-PRZESYŁKĘ.
Tak
Typ=””
Nazwa=”Wersja”
NUMBER (1)
Numer wersji struktury danych dla danego
rodzaju przesyłki.
Aktualnym numerem wersji jest „1”
Tak
Typ=”Adresat”
Nazwa=”Nazwa”
CHAR (30)
Oznaczenie pierwszego członu nazwy
adresata przesyłki.
Tak
Typ=”Adresat”
Nazwa=”NazwaII”
CHAR (30)
Oznaczenie
drugiego
członu
nazwy
adresata przesyłki.
Nie
Typ=”Adresat”
Nazwa=”Ulica”
CHAR (35)
Oznaczenie ulicy adresata przesyłki.
Nie
Opis przykładowego pliku XML
17
Typ=”Adresat”
Nazwa=”Dom”
CHAR (11)
Oznaczenie domu adresata przesyłki, pole
max 5-znakowe.
Tak
Typ=”Adresat”
Nazwa=”Lokal”
CHAR (11)
Oznaczenie domu adresata przesyłki, pole
max 5-znakowe
Nie
Typ=”Adresat”
Nazwa=”Miejscowosc”
CHAR (30)
Oznaczenie
miejscowości
adresata
przesyłki.
Tak
Typ=”Adresat”
Nazwa=”Kod”
NUMBER (5)
Oznaczenie kodu pocztowego adresata
przesyłki.
Tak
Typ=”Adresat”
Nazwa=”Kraj”
CHAR (6)
Oznaczenie kraju adresata przesyłki. Pole
tekstowe, zawierające nazwę kraju adresata
przesyłki („Polska”).
Tak
2.5.6. <POCZTEX>
Poniżej znajduje się opis atrybutów dla pola <Atrybut> dla przesyłki: „POCZTEX” na jutro
standard, bez pobrania i bez usług komplementarnych.
A
TRYBUTY
T
YP
O
PIS
W
YMAGANA
WARTOŚĆ
Typ=””
Nazwa=”Symbol”
NUMBER (3)
Cyfrowy symbol odpowiadający przesyłce
POCZTEX. Wartością pola jest „812”
Tak
Typ=””
Nazwa=”NrNadania”
CHAR (13)
Odpowiednio sformatowany 13-znakowy
numer
identyfikujący
przesyłkę
(EE9999999PL). Pole jest wyliczane wg
specjalnego algorytmu.
Nie
Typ=””
Nazwa=”Masa
NUMBER (7)
Masa przesyłki, podana w gramach. Pole
ograniczone do 50000 gramów.
Nie
Typ=””
Nazwa=”Umowa”
NUMBER (10)
Oznaczenie umowy na podstawie, której
nadawane są przesyłki pocztowe.
Pole posiadać może konkretną wartość
odpowiadającą oznaczeniu umowy lub wpis
„Bez umowy”.
Nie
Typ=””
Nazwa=”KartaUmowy”
NUMBER (10)
Oznaczenie karty na podstawie której
nadawane są przesyłki pocztowe.
Pole posiadać może konkretną wartość
odpowiadającą oznaczeniu karty umowy.
Nie
Typ=””
Nazwa=”Ilosc”
NUMBER (1)
Informuje o ilości przesyłek; domyślną
wartością jest „1”.
Tak
Typ=””
Nazwa=”Uslugi”
CHAR (8)
Usługi komplementarne, jakie są aktywne
dla rozpatrywanej przesyłki; wartości:
C – Chroniona
W – Zadeklarowanie wartości
D – Potwierdzenie doręczenia
O – Potwierdzenie odbioru
Z – Doręczenie do rąk własnych
N – Doręczenie w niedzielę lub święto
S – Sprawdzenie zawartości przesyłki przez odbiorcę
P – Odbiór od nadawcy w godzinach 8:00-20:00
X – Odbiór przesyłki w niedzielę lub święto
G – Doręczenie przesyłki w godzinach 8:00-20:00
E – Doręczenie przesyłki we wskazanym dniu
R – Zwrot podpisanych dokumentów
B – Doręczenie przesyłki w sobotę
Nie
Opis przykładowego pliku XML
18
Typ=””
Nazwa=”Odleglosc”
NUMBER (7)
Odległość dla nadawanej przesyłki
POCZTEX; podana w kilometrach.
Nie
(Tak, dla Typ=Z i
Termin=B)
Typ=””
Nazwa=”Termin”
CHAR (1)
Termin-serwis dla przesyłki:
B – Bezpośredni
D – Na dziś krajowy
M – Na dziś miejski
U – Na dziś miejski super
A – Na dziś aglomeracja
P – Na jutro południe
R – Na jutro poranek
S – Na jutro standard
Tak
Typ=””
Nazwa=”UiszczaOplate”
CHAR (1)
Informuje o uiszczającym opłatę za nadanie
przesyłki:
N – nadawca
A – adresat
Tak
Typ=””
Nazwa=”Typ”
CHAR (1)
Rodzaj przesyłki:
Z – zwykły
E – full pack 1
F – full pack 2
Tak
Typ=””
Nazwa=”Ponadwymiarowa”
CHAR (1)
T – jest to „Przesyłka ponadwymiarowa”
N – nie jest to „Przesyłka
ponadwymiarowa”
Typ=””
Nazwa=”Wersja”
NUMBER (1)
Numer wersji struktury danych dla danego
rodzaju przesyłki.
Aktualnym numerem wersji jest „2”
Tak
Typ=”Adresat”
Nazwa=”Nazwa”
CHAR (30)
Oznaczenie pierwszego członu nazwy
adresata przesyłki.
Tak
Typ=”Adresat”
Nazwa=”NazwaII”
CHAR (30)
Oznaczenie
drugiego
członu
nazwy
adresata przesyłki.
Nie
Typ=”Adresat”
Nazwa=”Ulica”
CHAR (35)
Oznaczenie ulicy adresata przesyłki.
Nie
Typ=”Adresat”
Nazwa=”Dom”
CHAR (11)
Oznaczenie domu adresata przesyłki, pole
max 5-znakowe.
Tak
Typ=”Adresat”
Nazwa=”Lokal”
CHAR (11)
Oznaczenie domu adresata przesyłki, pole
max 5-znakowe
Nie
Typ=”Adresat”
Nazwa=”Miejscowosc”
CHAR (30)
Oznaczenie
miejscowości
adresata
przesyłki.
Tak
Typ=”Adresat”
Nazwa=”Kod”
NUMBER (5)
Oznaczenie kodu pocztowego adresata
przesyłki.
Tak
Typ=”Adresat”
Nazwa=”Kraj”
CHAR (6)
Oznaczenie kraju adresata przesyłki. Pole
tekstowe, zawierające nazwę kraju adresata
przesyłki („Polska”).
Tak
Opis przykładowego pliku XML
19
3. Historia zmian dokumentu
DATA
AUTOR
ZMIANY
31-07-2009
Krzysztof Bartyś
Utworzenie pierwszej wersji dokumentu.
14-12-2009
Krzysztof Bartyś
Uzupełnienie dokumentu o opis przesyłki 840.
02-03-2010
Krzysztof Bartyś
Uzupełnienie pliku o opis przesyłki 850.
11-03-2010
Krzysztof Bartyś
Aktualizacja dokumentu w zakresie:
a) Uzupełnienie opisu sekcji pól „Przesyłka” o pole „Typ”.
b) Zamiana pola „Karta” przez pole „KartaUmowy” (w sekcji pól
opisujących poszczególne rodzaje przesyłek).
02-04-2010
Krzysztof Bartyś
Aktualizacja dokumentu w zakresie:
a) Zamiana pola ródło na Zrodlo
29-10-2010
Krzysztof Bartyś
Dla przesyłki 850 usunięto pole Tyl.
29-12-2010
Krzysztof Bartyś
Na str 5 wstawiono nowy przykładowy plik XML.
Udzielono odpowiedzi na zadane pytania. Usunięto opisy dla
formatowania wartości pól nr domu/lokalu w związku ze zmianą
wprowadzoną w EKN.
30-12-2010
Krzysztof Bartyś
Zmiana treści dokumentu wynikająca z rozszerzenia opisu i przykładu o
pola opisujące przesyłkę POCZTEX na jutro standard.
22-02-2011
Krzysztof
Ś
leszyński
Zmiana długości pola ulica na 35 znaków, dom na 11 znaków, lokal na 11
znaków