v1.9.1 Usługa WebService7 W WebMobile7 Dział Nowych Projektów Warszawa 2011
v1.9.1 Spis treści 1 KONTROLA DOKUMENTU... 3 2 SKRÓCONY OPIS USŁUGI... 4 3 METODY... 5 4 METODA LISTNADANIE.... 7 4.1 DEFINICJA KOMUNIKATU.XSD... 7 4.2 PRZYKŁADOWY KOMUNIKAT.XML... 9 4.3 UWAGI... 11 4.4 SŁOWNIKI WYKORZYSTANE W TYPACH KOMUNIKATU XML.... 12 5 METODA WYDRUKETYKIETAEPL... 12 6 METODA WYDRUKLISTPDF... 13 7 METODA NOWYDOKUMENTWYDANIA... 13 8 METODA POBIERZNUMERDOKUMENTULIST... 14 9 METODA POBIERZDOKUMENTWYDANIA... 14 10 METODA STATUSYPRZESYLKI... 15 11 METODA WYDRUKETYKIETAPNG... 16 12 METODA WYDRUKETYKIETAPDF... 17 13 METODA DODAJNADAWCE... 17 14 METODA DODAJODBIORCE... 19 15 METODA EDYTUJKLIENTA... 20 16 METODA SZUKAJKLIENTA... 21 17 LISTA KODÓW BŁĘDU ZWRACANYCH PRZEZ METODY WYKORZYSTANE W WEBSERVICE7.... 22 18 TESTOWANIE WEBSERVICE7 W WEBMOBILE7... 26 18.1 TESTOWA USŁUGA WEBSERVICE7 UDOSTĘPNIONA JEST NA ŚRODOWISKU TESTOWYM POD LINKAMI:... 26 18.2 PRACA PRODUKCYJNA Z WEBSERVICE7 W WEBMOBILE7... 26 19 DODATEK A: OGRANICZENIA PÓL W METODZIE LISTNADANIE... 27 20 DODATEK B: PREFIXY UŻYWANE DO WALIDACJI TELEFONU KOMÓRKOWEGO... 32 2
Opis usług WebService7 1 Kontrola dokumentu Wersja Data Autor Opis zmian 1.8.0 2011-09-05 Piotr Taraszkiewicz Utworzenie dokumentu 1.8.1 2011-12-08 Piotr Taraszkiewicz Uszczegółowienie maksymalnej ilości znaków w polach metody listnadanie: Dodatek B 1.8.2 2011-12-20 Piotr Taraszkiewicz Uszczegółowienie maksymalnej ilości znaków w polach metody listnadanie: Dodatek B 1.9.0 2011-12-30 Piotr Taraszkiewicz Metody: Dodanie nazw nowych metod (nie dostępnych) Dodatek B: Zmiana funkcjonowania pól: - listnadanie zkld - listnadanie formapobrania - listnadanie awizacjatelefoniczna - listnadanie zastrzdornagodz Dodatek B: zmiana opisu pól: - listnadanie potwdostemail - listnadanie potwdostsms 1.9.1 2012-01-01 Piotr Taraszkiewicz Aktualizacja XML w metody listnadanie
2 Skrócony opis usługi Siódemka S.A. udostępnia usługi WebService7 za pomocą których można komunikować się z aplikacją bez potrzeby logowania się przez przeglądarkę do samej aplikacji. Usługa to pozwala na zbudowanie własnego i dopasowanego do swoich potrzeb oprogramowania do drukowania listów przewozowych. W ramach usługi udostępniamy metody, które odzwierciedlają funkcjonalności aplikacji WebMobile7, dodatkowo wszystkie listy utworzone poprzez WebService7 mogą być drukowane/podglądane/raportowane bezpośrednio z aplikacji WebMobile7. Schemat komunikacji wygląda następująco: 1. Z oprogramowania klienta wysyłane są dane o liście przewozowym (metoda: listnadanie): dane odbiorcy, usługi, dane kontaktowe itp. W odpowiedzi z naszego serwera zostaje przesłany numer listu przewozowego (oraz numery podpaczek jeżeli zostały załączone do komunikatu). 2. Po otrzymaniu numeru, możemy wydrukować etykietę metoda: wydruketykietepl (w odpowiedzi przesłane będą dane gotowe do przesłania na port drukarki) 3. Następnie pozostanie przygotowanie dokumentu wydania za pomocą pozostałych metod. Szerszy opis metod i przykładowe komunikaty znajdują się w dalszej części instrukcji. 4
3 Metody Metody dostępne są za pomocą standardowych mechanizmów WebService za pośrednictwem protokołu SOAP. W skład metod udostępnianych przez Siódemkę wchodzą: listnadanie (przygotowanie listu przewozowego) wydruketykietaepl (wydruk etykiety w formacie EPL) wydruketykietapng (wydruk etykiety w formacie PNG) wydruketykietapdf (wydruk etykiety/etykiet w formacie PDF) wydruklistpdf (wydruk listu A4 w formacie PDF) nowydokumentwydania (przygotowanie Dokumentu Wydania Paczek) pobierznumerdokumentulist (pobranie numeru Dokumentu Wydania Paczek) pobierzdokumentwydania (pobranie Dokumentu Wydania Paczek) statusyprzesylki (pobranie statusów przesyłki) dodajodbiorce (Metoda pozwala na dodanie odbiorcy gotówkowego) dodajnadawce (Metoda pozwala na dodanie nadawcy gotówkowego) szukajklienta (Metoda pozwala na wyszukiwanie danych odbiorcy lub nadawcy gotówkowego) edytujklienta (Metoda pozwala na edycję danych odbiorcy) statusyprzesylkiv1 metoda nie aktywna bazaplacowek metoda nie aktywna znajdzplacowke metoda nie aktywna Metoda Parametry Wynik Opis listnadanie Dane o liście Numer listy (numer podpaczek opcjonalnie) Metoda służy do: - Wygenerowania numeru listu przewozowego - Wygenerowania numerów podpaczek (jeżeli zawarte w wywołaniu) - Obliczenia wag gabarytowych (jeżeli 5
Metoda Parametry Wynik Opis wydruketykietaepl Numer listu przewozowego wydruklistpdf Numer listu przewozowego Kod EPL gotowy do przekazania na port drukarki List przewozowy (PDF w postaci binarnej) nowydokumentwydania Numery listów Dokument Wydania Paczek (PDF w postaci binarnej) pobierznumerdokumentulist Numer listu Numer dokumentu wydania pobierzdokumentwydania Numer dokumentu wydania statusyprzesylki Numer listu przewozowego wydruketykietapng Numer listu przewozowego wydruketykietapdf Numery listów przewozowych Dokument Wydania Paczek (PDF w postaci binarnej) Lista (bądź pojedynczy) statusów danej przesyłki Etykieta adresowa (PNG w postaci binarnej) `Etykiety adresowe (PDF w postaci binarnej) dodajnadawce Dane nadawcy Dane nadawcy uzupełnione o jego numer zawarte w wywołaniu) Metoda służy do wygenerowania wydruku etykiety w formacie EPL Metoda służy do wygenerowania wydruku listu w formacie A4 Wygenerowanie dokumentu wydania paczek z załączonymi listami podanymi w parametrach wywołania Metoda pobiera numer dokumentu wydania na którym zawarty jest numer listu podany w parametrach Wygenerowanie dokumentu wydania paczek o numerze podanym w parametrach Metoda pobiera całą listę statusów bądź tylko ostatni stan dla danej przesyłki Metoda pozwala na pobranie etykiety (10x10) w postaci obrazka PNG, co umożliwia dalszą obróbkę po stornie klienta. Metoda pozwala na pobranie etykiet (10x10) w podanych w wywołaniu numerach Metoda pozwala na dodanie nadawcy gotówkowego 6
Metoda Parametry Wynik Opis dodajodbiorce Dane odbiorcy Dane odbiorcy uzupełnione o jego numer edytujklienta Nowe dane odbiorcy/ nadawcy szukajklienta Niepełne odbiorcy/nadawcy statusyprzesylkiv1 metoda nie aktywna bazaplacowek metoda nie aktywna znajdzplacowke metoda nie aktywna Zaktualizowane dane nadawcy Dane odbiorcy/nadawcy metoda aktywna metoda aktywna metoda aktywna nie nie nie Metoda pozwala na dodanie odbiorcy gotówkowego Metoda pozwala na edycję danych odbiorcy lub /nadawcy gotówkowego Metoda pozwala na wyszukiwanie danych odbiorcy lub nadawcy gotówkowego metoda nie aktywna metoda nie aktywna metoda nie aktywna 4 Metoda listnadanie. Metoda służy do wprowadzenia do aplikacji WebMobile7 informacji o liście przewozowym, na którym ma zostać wykonana usługa transportowa. Informacją zwrotną jest nadany numer przesyłki lub komunikat błędu. 4.1 Definicja komunikatu.xsd <schema xmlns="http://www.w3.org/2001/xmlschema" xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/" xmlns:xsi="http://www.w3.org/2001/xmlschema-instance" xmlns:soap11- enc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:tns="http://app.siodemka.com/mm7ws/type/" targetnamespace="http://app.siodemka.com/mm7ws/type/" elementformdefault="qualified"> <complextype name="kontrahentnadawca"> <sequence> <element name="numer" type="string" nillable="false" /> <element name="nazwisko" type="string" nillable="true" /> <element name="imie" type="string" nillable="true" /> <element name="telkontakt" type="string" nillable="true" /> <element name="emailkontakt" type="string" nillable="true" /> </sequence> </complextype> <complextype name="kontrahentodbiorca"> <sequence> <element name="numer" type="string" nillable="true" /> <element name="nrext" type="string" nillable="true" /> <element name="czyfirma" type="string" nillable="false" /> <element name="nazwa" type="string" nillable="true" /> <element name="nip" type="string" nillable="true" /> 7
<element name="nazwisko" type="string" nillable="true" /> <element name="imie" type="string" nillable="true" /> <element name="kodkraju" type="string" nillable="false" /> <element name="kod" type="string" nillable="false" /> <element name="miasto" type="string" nillable="false" /> <element name="ulica" type="string" nillable="false" /> <element name="nrdom" type="string" nillable="false" /> <element name="nrlokal" type="string" nillable="true" /> <element name="telkontakt" type="string" nillable="true" /> <element name="emailkontakt" type="string" nillable="true" /> </sequence> </complextype> <complextype name="kontrahentplatnik"> <sequence> <element name="numer" type="string" nillable="false" /> <element name="telkontakt" type="string" nillable="true" /> </sequence> </complextype> <complextype name="ubezpieczenie"> <sequence> <element name="kwotaubezpieczenia" type="string" nillable="true" /> <element name="opiszawartosci" type="string" nillable="true" /> </sequence> </complextype> <complextype name="pobranie"> <sequence> <element name="kwotapobrania" type="string" nillable="true" /> <element name="formapobrania" type="string" nillable="true" /> <element name="nrkonta" type="string" nillable="true" /> </sequence> </complextype> <complextype name="uslugi"> <sequence> <element name="nrbezpiecznejkoperty" type="string" nillable="true" /> <element name="zkld" type="string" nillable="true" /> <element name="zd" type="string" nillable="true" /> <element name="ubezpieczenie" type="tns:ubezpieczenie" nillable="true" /> <element name="pobranie" type="tns:pobranie" nillable="true" /> <element name="awizacjatelefoniczna" type="string" nillable="true" /> <element name="potwnademail" type="string" nillable="true" /> <element name="potwdostemail" type="string" nillable="true" /> <element name="potwdostsms" type="string" nillable="true" /> <element name="skladowanie" type="string" nillable="true" /> <element name="nadodbpkp" type="string" nillable="true" /> <element name="odbnadgodziny" type="string" nillable="true" /> <element name="odbwlas" type="string" nillable="true" /> <element name="palnextday" type="string" nillable="true" /> <element name="osobafiz" type="string" nillable="true" /> <element name="market" type="string" nillable="true" /> <element name="zastrzdornagodz" type="string" nillable="true" /> <element name="zastrzdornadzien" type="string" nillable="true" /> </sequence> </complextype> <complextype name="paczki"> <sequence> <element name="paczka" type="tns:paczka" nillable="false" minoccurs="1" maxoccurs="unbounded" /> </sequence> </complextype> <complextype name="paczka"> <sequence> <element name="nrpp" type="string" nillable="true" /> <element name="typ" type="string" nillable="false" /> <element name="waga" type="string" nillable="false" /> <element name="gab1" type="string" nillable="true" /> <element name="gab2" type="string" nillable="true" /> <element name="gab3" type="string" nillable="true" /> <element name="ksztalt" type="string" nillable="false" /> <element name="wagagabaryt" type="string" nillable="true" /> </sequence> </complextype> <complextype name="potwierdzenienadania"> <sequence> <element name="datanadania" type="string" nillable="false" /> <element name="numerkuriera" type="string" nillable="false" /> <element name="podpisnadawcy" type="string" nillable="false" /> </sequence> 8
</complextype> <complextype name="list"> <sequence> <element name="nrprzesylki" type="string" nillable="true" /> <element name="nrext" type="string" nillable="true" /> <element name="mpk" type="string" nillable="true" /> <element name="rodzajprzesylki" type="string" nillable="false" /> <element name="placi" type="string" nillable="false" /> <element name="formaplatnosci" type="string" nillable="false" /> <element name="nadawca" type="tns:kontrahentnadawca" nillable="false" /> <element name="odbiorca" type="tns:kontrahentodbiorca" nillable="false" /> <element name="platnik" type="tns:kontrahentplatnik" nillable="true" /> <element name="uslugi" type="tns:uslugi" nillable="true" /> <element name="paczki" type="tns:paczki" nillable="false" /> <element name="potwierdzenienadania" type="tns:potwierdzenienadania" nillable="false" /> <element name="uwagi" type="string" nillable="true" /> </sequence> </complextype> <complextype name="fault"> <sequence> <element name="bledy" type="tns:bledy" nillable="true" /> </sequence> </complextype> <complextype name="bledy"> <sequence> <element name="blad" type="tns:blad" nillable="true" minoccurs="0" maxoccurs="unbounded" /> </sequence> </complextype> <complextype name="blad"> <sequence> <element name="kod" type="long" nillable="true" /> <element name="opis" type="string" nillable="true" /> </sequence> </complextype> <element name="listnadanieelement"> <complextype> <sequence> <element name="przesylka" type="tns:list" nillable="false" /> <element name="klucz" type="string" nillable="false" /> </sequence> </complextype> </element> <element name="listnadanieresponseelement"> <complextype> <sequence> <element name="result" type="tns:list" nillable="true" /> </sequence> </complextype> </element> <element name="faultelement" type="tns:fault" /> </schema> 4.2 Przykładowy komunikat.xml <soap:envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:body xmlns:ns1="http://app.siodemka.com/mm7ws/type/"> <ns1:listnadanieelement> <ns1:przesylka> <ns1:nrprzesylki></ns1:nrprzesylki> <ns1:nrext></ns1:nrext> <ns1:mpk></ns1:mpk> <ns1:rodzajprzesylki>k</ns1:rodzajprzesylki> <ns1:placi>1</ns1:placi> <ns1:formaplatnosci>p</ns1:formaplatnosci> 9
10 <ns1:nadawca> <ns1:numer>8140604</ns1:numer> <ns1:nazwisko></ns1:nazwisko> <ns1:imie></ns1:imie> <ns1:telkontakt>506999888</ns1:telkontakt> <ns1:emailkontakt>nadawca@test.com</ns1:emailkontakt> </ns1:nadawca> <ns1:odbiorca> <ns1:numer></ns1:numer> <ns1:nrext></ns1:nrext> <ns1:czyfirma>1</ns1:czyfirma> <ns1:nazwa>tesotwa</ns1:nazwa> <ns1:nip></ns1:nip> <ns1:nazwisko></ns1:nazwisko> <ns1:imie></ns1:imie> <ns1:kodkraju></ns1:kodkraju> <ns1:kod>11-111</ns1:kod> <ns1:miasto>testowo</ns1:miasto> <ns1:ulica>testowa</ns1:ulica> <ns1:nrdom>47</ns1:nrdom> <ns1:nrlokal></ns1:nrlokal> <ns1:telkontakt>506007038</ns1:telkontakt> <ns1:emailkontakt>odbiorca@test.com</ns1:emailkontakt> </ns1:odbiorca> <ns1:platnik> <ns1:numer></ns1:numer> <ns1:telkontakt></ns1:telkontakt> </ns1:platnik> <ns1:uslugi> <ns1:nrbezpiecznejkoperty></ns1:nrbezpiecznejkoperty> <ns1:zkld>2</ns1:zkld> <ns1:zd>0</ns1:zd> <ns1:ubezpieczenie> <ns1:kwotaubezpieczenia>5000</ns1:kwotaubezpieczenia> <ns1:opiszawartosci>kamyki</ns1:opiszawartosci> </ns1:ubezpieczenie> <ns1:pobranie> <ns1:kwotapobrania>100</ns1:kwotapobrania> <ns1:formapobrania>p</ns1:formapobrania> <ns1:nrkonta>73150010701210700799640000</ns1:nrkonta> </ns1:pobranie> <ns1:awizacjatelefoniczna>0</ns1:awizacjatelefoniczna> <ns1:potwnademail>1</ns1:potwnademail> <ns1:potwdostemail>1</ns1:potwdostemail> <ns1:potwdostsms>0</ns1:potwdostsms> <ns1:skladowanie>0</ns1:skladowanie> <ns1:nadodbpkp>0</ns1:nadodbpkp> <ns1:odbnadgodziny>0</ns1:odbnadgodziny> <ns1:odbwlas>0</ns1:odbwlas> <ns1:palnextday>0</ns1:palnextday> <ns1:osobafiz>1</ns1:osobafiz> <ns1:market>0</ns1:market> <ns1:zastrzdornagodz>0</ns1:zastrzdornagodz> <ns1:zastrzdornadzien>b</ns1:zastrzdornadzien> </ns1:uslugi> <ns1:paczki> <ns1:paczka> <ns1:nrpp></ns1:nrpp> <ns1:typ>pc</ns1:typ> <ns1:waga>20</ns1:waga>
<ns1:gab1>0</ns1:gab1> <ns1:gab2>0</ns1:gab2> <ns1:gab3>0</ns1:gab3> <ns1:ksztalt>0</ns1:ksztalt> <ns1:wagagabaryt></ns1:wagagabaryt> </ns1:paczka> </ns1:paczki> <ns1:potwierdzenienadania> <ns1:datanadania>2012-01-01 18:00</ns1:dataNadania> <ns1:numerkuriera>233</ns1:numerkuriera> <ns1:podpisnadawcy>kowalski</ns1:podpisnadawcy> </ns1:potwierdzenienadania> <ns1:uwagi></ns1:uwagi> </ns1:przesylka> <ns1:klucz>c33ef81ba362985514ef2b0a0cc8426e</ns1:klucz> </ns1:listnadanieelement> </soap:body> </soap:envelope> Należy pamiętać aby pomiędzy znacznikami: <ns1:datanadania>2009-10-22 18:00</ns1:dataNadania> Znajdowała się aktualna data nadania przesyłki, w przypadku gdy wpiszemy datę wsteczną będzie zwrócony komunikat z błędem. Ograniczenia co do wprowadzanych wartości przedstawione są w dodatku A. 4.3 Uwagi Standardowo obsługiwane są następujące definicje wartości null (pustej) <ns1:zastrzdornadzien xsi:nil="1"/> <ns1:zastrzdornagodz xsi:nil="1"/> lub <ns1:zastrzdornadzien xsi:nil="true"/> <ns1:zastrzdornagodz xsi:nil="true"/> Jeśli implementacja wywoływania metod WebService nie obsługuje takiego wywołania to można użyć poniższych wartości dla podanych usług: wartość pola zastrzdornadzien - może przybierać wartości - S - sobota, N - niedziela, B - brak lub standardowo null (<ns1:zastrzdornadzien xsi:nil="true"/>) wartość pola zastrzdornagodz - może przybierać godzinowe przy czym wartość 0, 00:00, 00 jest traktowana jako brak usługi. Standardowo można użyć "wartości" null (<ns1:zastrzdornagodz xsi:nil="true"/>) 11
4.4 Słowniki wykorzystane w typach komunikatu XML. TN_TYPE_NIE = "0"; TN_TYPE_TAK = "1"; FORMA_PLATNOSCI_TYPE_GOTOWKA = "G"; FORMA_PLATNOSCI_TYPE_PRZELEW = "P"; RODZAJ_PRZESYLKI_TYPE_LOKALNA = "L"; RODZAJ_PRZESYLKI_TYPE_KRAJOWA = "K"; RODZAJ_PRZESYLKI_TYPE_ZAGRANICZNA = "Z"; PLACI_TYPE_NADAWCA = "1"; PLACI_TYPE_ODBIORCA = "2"; PLACI_TYPE_PLATNIK = "3"; FORMA_POBRANIA_TYPE_BANK = "B"; FORMA_POBRANIA_TYPE_PRZEKAZ = "P"; PACZKA_TYP_KOPERTA = "KP"; PACZKA_TYP_PACZKA = "PC"; PACZKA_TYP_PALETA = "PL"; ZASTRZ_DOR_NA_DZIEN_SOBOTA = "S"; ZASTRZ_DOR_NA_DZIEN_NIEDZIELA = "N"; 5 Metoda wydruketykietaepl Metoda służy do pobrania z aplikacji WebMobile7 wydruku etykiet/ty w formacie EPL, na którym/ych ma zostać wykonana usługa transportowa. Informacją zwrotną jest etykieta w formacie EPL lub komunikat błędu. Przykładowy komunikat.xml <soap:envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:body xmlns:ns1="http://app.siodemka.com/mm7ws/type/"> <ns1:wydruketykietaeplelement> <ns1:numery>9130030936916</ns1:numery> <ns1:klucz>c33ef81ba362985514ef2b0a0cc8426e</ns1:klucz> <ns1:separator></ns1:separator> </ns1:wydruketykietaeplelement> </soap:body> </soap:envelope> Gdzie: Numer numery listów które chcemy wydrukować Klucz klucz API do usług WS Separator znak umieszczany pomiędzy numerami listów w celu ich oddzielenia 12
6 Metoda wydruklistpdf Metoda służy do pobrania z aplikacji WebMobile7 wydruku listu przewozowego w formacie A4, na którym/ych ma zostać wykonana usługa transportowa. Informacją zwrotną jest dokument PDF w postaci binarnej lub komunikat błędu. Przykładowy komunikat.xml <soap:envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:body xmlns:ns1="http://app.siodemka.com/mm7ws/type/"> <ns1:wydruklistpdfelement> <ns1:numer>9130030936916</ns1:numer> <ns1:klucz>c33ef81ba362985514ef2b0a0cc8426e</ns1:klucz> </ns1:wydruklistpdfelement> </soap:body> </soap:envelope> Gdzie: Numer numery listów które chcemy wydrukować Klucz klucz API do usług WS 7 Metoda nowydokumentwydania Metoda służy do wygenerowania w aplikacji WebMobile7 dokumentu wydania na podstawie podanego zakresu listów przewozowych oraz jego pobrania. Informacją zwrotną dane binarne (base64binary) z dokumentem wydania. Przykładowy komunikat.xml <soap:envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:body xmlns:ns1="http://app.siodemka.com/mm7ws/type/"> <ns1:nowydokumentwydaniaelement> <ns1:kurier>233</ns1:kurier> <ns1:numery>9130030936916</ns1:numery> <ns1:klucz>c33ef81ba362985514ef2b0a0cc8426e</ns1:klucz> <ns1:separator></ns1:separator> </ns1:nowydokumentwydaniaelement> </soap:body> </soap:envelope> gdzie: kurier - nr kuriera numery - wykaz numerów listów do załączenia na dokumencie wydania klucz klucz API do usługi WS separator - separator numerów listów 13
8 Metoda pobierznumerdokumentulist Metoda ta służy do pobrania numeru dokumentu wydania paczek. Jako parametr przekazujemy numer przesyłki która załączona jest w pożądanym dokumencie Przykładowy komunikat.xml <soap:envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:body xmlns:ns1="http://app.siodemka.com/mm7ws/type/"> <ns1:pobierznumerdokumentulistelement> <ns1:numerlistu>9130030936916</ns1:numerlistu> <ns1:klucz>c33ef81ba362985514ef2b0a0cc8426e</ns1:klucz> </ns1:pobierznumerdokumentulistelement> </soap:body> </soap:envelope> Gdzie: numerlistu numer listu który jest zawarty do dokumentu klucz klucz API 9 Metoda pobierzdokumentwydania Metoda służy do pobrania wygenerowanego wcześniej w aplikacji WebMobile7 dokumentu wydania na podstawie numeru dokumentu wydania. Informacją zwrotną dane binarne (base64binary) z dokumentem wydania. Przykładowy komunikat.xml <soap:envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:body xmlns:ns1="http://app.siodemka.com/mm7ws/type/"> <ns1:pobierzdokumentwydaniaelement> <ns1:numerdokumentu>2010-06-28/813703</ns1:numerdokumentu> <ns1:klucz>c33ef81ba362985514ef2b0a0cc8426e</ns1:klucz> </ns1:pobierzdokumentwydaniaelement> </soap:body> </soap:envelope> gdzie: numerdokumentu numer dokumentu (taki jak na PDF-ie) klucz klucz do usługi WS 14
10 Metoda statusyprzesylki Metoda umożliwia śledzenie stanu (statusu) przesyłki z poziomu usług WebService7. Dzięki tej metodzie jesteśmy w stanie pobrać całą listę statusów bądź najbardziej aktualny (ostatni) sterowanie parametrem wywołania. Dzięki tej metodzie mogą Państwo sprawdzić statusy przesyłek w Państwa aplikacjach bez wykonywania dodatkowych czynności. Przykładowy komunikat.xml <soap:envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:body xmlns:ns1="http://app.siodemka.com/mm7ws/type/"> <ns1:statusyprzesylkielement> <ns1:numerlistu>9130030936916</ns1:numerlistu> <ns1:czyostatni>0</ns1:czyostatni> <ns1:klucz>c33ef81ba362985514ef2b0a0cc8426e</ns1:klucz> </ns1:statusyprzesylkielement> </soap:body> </soap:envelope> gdzie: numerlistu numer listu przewozowego czyostatni parametr pozwalający określić czy zwracana będzie cała lista statusów (0) czy tylko ostatni najbardziej aktualny (1) klucz klucz WebAPI Przykładowa odpowiedź.xml <env:envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/xmlschema" xmlns:xsi="http://www.w3.org/2001/xmlschema-instance" xmlns:ns0="http://app.siodemka.com/mm7ws/type/"> <env:body> <ns0:statusyprzesylkiresponseelement> <ns0:result> <ns0:skrot>ds</ns0:skrot> <ns0:oddsymbol>ldz</ns0:oddsymbol> <ns0:nrp>4130046283160</ns0:nrp> <ns0:datas>2011-08-31 11:10</ns0:dataS> <ns0:opis>przesyłka doręczona (DS)</ns0:opis> </ns0:result>... <ns0:result> <ns0:skrot>wk</ns0:skrot> <ns0:oddsymbol>ldz</ns0:oddsymbol> <ns0:nrp>4130046283160</ns0:nrp> <ns0:datas>2011-08-31 06:25</ns0:dataS> <ns0:opis>wydanie kurierowi doręczającemu (WK)</ns0:opis> 15
</ns0:result> </ns0:statusyprzesylkiresponseelement> </env:body> </env:envelope> Za pomocą tej metody możemy uzyskać następujące statusy: Symbol statusu (<ns0:skrot>) PK WK WE ZK OW PP UD NP AN ZN AV NA BA OP DS Opis statusu (<ns0:opis>) Przyjęcie od kuriera (PK) Wydanie kurierowi doręczającemu (WK) Przyjęcie do magazynu doręczającego (WE) Zwrot przez kuriera (ZK) Odbiór Własny Przemanifestowanie Umówione Doręczenie Nieudana próba doręczenia Przesyłka Anulowana Zwrot do nadawcy (ZN) Przesyłka awizowana (AV) Nie znaleziono adresu (NA) Błędny Adres (BA) Odbiorca odmówił przyjęcia (OP) Przesyłka doręczona (DS) 11 Metoda wydruketykietapng Metoda ta pozwala na pobranie etykiety adresowej (10 cm x 10 cm) w postaci obrazka (format PNG). Metoda ta udostępniania jest na specjalne życzenie klienta i w porozumieniu z działem IT Siódemki z powodu niebezpieczeństwa które niesie za sobą przeskalowanie pobranego obrazka. 16
Przykładowy komunikat.xml <soap:envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:body xmlns:ns1="http://app.siodemka.com/mm7ws/type/"> <ns1:wydruketykietapngelement> <ns1:numer>9130030936916</ns1:numer> <ns1:klucz>c33ef81ba362985514ef2b0a0cc8426e</ns1:klucz> </ns1:wydruketykietapngelement> </soap:body> </soap:envelope> gdzie: numer numer listu przewozowego klucz klucz WebAPI 12 Metoda WydrukEtykietaPdf Metoda ta pozwala na pobranie etykiety adresowej (10 cm x 10 cm) w postaci dokumentu binarnego PDF Przykładowy komunikat.xml <soap:envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:body xmlns:ns1="http://app.siodemka.com/mm7ws/type/"> <ns1:wydruketykietapdfelement> <ns1:numery>9130030936916</ns1:numery> <ns1:klucz>c33ef81ba362985514ef2b0a0cc8426e</ns1:klucz> <ns1:separator>;</ns1:separator> </ns1:wydruketykietapdfelement> </soap:body> </soap:envelope> gdzie: numer numer listu przewozowego klucz klucz WebAPI separator znak oddzielający numery listów 13 Metoda dodajnadawce Metoda służy do dodania do bazy danych klientów nadawcy gotówkowego. Dane wejściowe są przekazywane w postaci struktury, która jest także wykorzystywana do dodawania odbiorcy, edycji klienta i wyszukiwania klienta. Zwracana jest analogiczna struktura z uzupełnionym 17
numerem klienta. Struktura komunikatu (patrz typ danych Kontrahent w WSDL) z danymi klienta przedstawia się następująco: <ns1:ulica> - dane adresowe (ulica) <ns1:emailkontakt> - e-mail kontaktowy <ns1:imie> - imię (w przypadku osób fizycznych) <ns1:numer> - numer klienta <ns1:nazwisko> - nazwisko (w przypadku osób fizycznych) <ns1:nrdom> - dane adresowe (nr domu) <ns1:nrlokal> - dane adresowe (nr lokalu) <ns1:kod> - dane adresowe (kod pocztowy) <ns1:nrext> - numer zewnętrzny numer nadawany przez klienta do łatwego wyszukiwania <ns1:nazwa> - nazwa klienta (nazwa firmy) <ns1:telkontakt> - telefon kontaktowy <ns1:nip> - nr NIP (bez kresek) <ns1:czyfirma> - znacznik czy firma (wartości 1 lub T oznacza firmę) <ns1:kodkraju> - dwuliterowy kod kraju domyślnie PL <ns1:miasto> - dane adresowe (miasto) <ns1:fax> - numer faksu <ns1:telefonkom> - numer telefonu komórkowego <ns1:czynadawca> - znacznik czy klient jest nadawcą (1 lub T) l UWAGA!!! Użytkownik musi mieć nadane przez firmę Siódemka S. A. uprawnienia do używania tej metody. Uwagi do funkcjonowania metody: 1. Metoda dodaje TYLKO nadawcę gotówkowego (nie ma znaczenia ustawienia pola czy nadawca 2. Po zapisie zwracane są dane klienta z uzupełnionym numerem klienta 3. W przypadku osób fizycznych pola imię i nazwisko są zamieniane na pełną nazwę klienta (w komunikacie zwrotnym pole nazwa jest uzupełnione, pola imię i nazwisko są wyczyszczone) Przykładowy komunikat.xml <soap:envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:body xmlns:ns1="http://app.siodemka.com/mm7ws/type/"> <ns1:dodajnadawceelement > <ns1:daneklienta> <ns1:ulica>nowoprojektowana</ns1:ulica> <ns1:emailkontakt>test@nowy.pl</ns1:emailkontakt> <ns1:imie></ns1:imie> <ns1:numer>a</ns1:numer> <ns1:nazwisko></ns1:nazwisko> <ns1:nrdom>6</ns1:nrdom> <ns1:nrlokal>7a</ns1:nrlokal> <ns1:kod>00-950</ns1:kod> 18
<ns1:nrext>gamma</ns1:nrext> <ns1:nazwa>gamma instytut</ns1:nazwa> <ns1:telkontakt>123-456-789</ns1:telkontakt> <ns1:nip>955-125-12-86</ns1:nip> <ns1:czyfirma>1</ns1:czyfirma> <ns1:kodkraju>pl</ns1:kodkraju> <ns1:miasto>warszawa</ns1:miasto> <ns1:fax></ns1:fax> <ns1:telefonkom>601123456</ns1:telefonkom> <ns1:czynadawca>1</ns1:czynadawca> </ns1:daneklienta> <ns1:klucz>688ebf5d509e5fe310fcc304e0570425</ns1:klucz> </ns1: dodajnadawceelement> </soap:body> </soap:envelope> Gdzie: daneklienta struktura z danymi klienta Klucz klucz API do usług WS 14 Metoda dodajodbiorce Metoda służy do dodania do bazy danych klientów odbiorcy gotówkowego. Dane wejściowe są przekazywane analogicznie jak opisano to powyżej w przypadku metody dodajna dawce. Zwracana jest analogiczna struktura z uzupełnionym numerem klienta. Uwagi do funkcjonowania metody: 1. Metoda dodaje TYLKO odbiorcę gotówkowego (nie ma znaczenia ustawienia pola czy nadawca 2. Po zapisie zwracane są dane klienta z uzupełnionym numerem klienta 3. W przypadku osób fizycznych pola imię i nazwisko są zamieniane na pełną nazwę klienta (w komunikacie zwrotnym pole nazwa jest uzupełnione, pola imię i nazwisko są wyczyszczone) Przykładowy komunikat.xml <soap:envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:body xmlns:ns1="http://app.siodemka.com/mm7ws/type/"> <ns1: dodajodbiorceelement > <ns1:daneklienta> <ns1:ulica>nowoprojektowana</ns1:ulica> <ns1:emailkontakt>test@nowy.pl</ns1:emailkontakt> <ns1:imie></ns1:imie> <ns1:numer>a</ns1:numer> <ns1:nazwisko></ns1:nazwisko> <ns1:nrdom>6</ns1:nrdom> <ns1:nrlokal>7a</ns1:nrlokal> <ns1:kod>00-950</ns1:kod> <ns1:nrext>gamma</ns1:nrext> <ns1:nazwa>gamma instytut</ns1:nazwa> 19
<ns1:telkontakt>123-456-789</ns1:telkontakt> <ns1:nip>955-125-12-86</ns1:nip> <ns1:czyfirma>1</ns1:czyfirma> <ns1:kodkraju>pl</ns1:kodkraju> <ns1:miasto>warszawa</ns1:miasto> <ns1:fax></ns1:fax> <ns1:telefonkom>601123456</ns1:telefonkom> <ns1:czynadawca>0</ns1:czynadawca> </ns1:daneklienta> <ns1:klucz>688ebf5d509e5fe310fcc304e0570425</ns1:klucz> </ns1: dodajodbiorceelement> </soap:body> </soap:envelope> Gdzie: daneklienta struktura z danymi klienta Klucz klucz API do usług WS 15 Metoda edytujklienta Metoda służy do edycji danych klienta. W celu edycji należy podać dane klienta jak w opisanych wyżej metodach dodajnadawce, ale należy także uzupełnić pole numer klienta (patrz opis metody do wyszukiwania klienta). Zwracana struktura zawiera nowe dane i ewentualnie NOWY numer klienta UWAGA!!! Użytkownik musi mieć nadane przez firmę Siódemka S. A. uprawnienia do używania tej metody do edycji nadawców z formą płatności gotówka. Uwagi do funkcjonowania metody: 1. Metoda służy do edycji nadawców i odbiorców TYLKO z formą płatności gotówka 2. Jeśli dane klienta były już zapisane w systemie Centralnym to edytowany klient będzie miał nadany nowy numer, a jego nieaktualna wersja będzie oznaczona jako skasowana (nie będzie dostępna do wybrania np. z wyszukiwarki w Webmobile7). Na starych listach przewozowych będzie funkcjonowała wersja klienta sprzed zmiany 3. Wartość pola czynadawca jest ignorowana Przykładowy komunikat.xml <soap:envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:body xmlns:ns1="http://app.siodemka.com/mm7ws/type/"> <ns1:edytujklientaelement> <ns1:daneklienta> <ns1:ulica>nowoprojektowana</ns1:ulica> <ns1:emailkontakt>test@nowy.pl</ns1:emailkontakt> <ns1:imie></ns1:imie> 2 0
<ns1:numer>8126810</ns1:numer> <ns1:nazwisko></ns1:nazwisko> <ns1:nrdom>6</ns1:nrdom> <ns1:nrlokal>7a</ns1:nrlokal> <ns1:kod>00-950</ns1:kod> <ns1:nrext>gamma</ns1:nrext> <ns1:nazwa>gamma instytut wydawniczy</ns1:nazwa> <ns1:telkontakt>123-456-789</ns1:telkontakt> <ns1:nip>955-125-12-86</ns1:nip> <ns1:czyfirma>1</ns1:czyfirma> <ns1:kodkraju>pl</ns1:kodkraju> <ns1:miasto>warszawa</ns1:miasto> <ns1:fax></ns1:fax> <ns1:telefonkom>601123456</ns1:telefonkom> <ns1:czynadawca>1</ns1:czynadawca> </ns1:daneklienta> <ns1:klucz>688ebf5d509e5fe310fcc304e0570425</ns1:klucz> </ns1:edytujklientaelement> </soap:body> </soap:envelope> </soap:body> </soap:envelope> Gdzie: daneklienta struktura z danymi klienta Klucz klucz API do usług WS 16 Metoda szukajklienta Metoda służy do wyszukiwania danych klienta. Parametry wyszukiwania podajemy w strukturze analogicznej jak w opisanych wyżej metodach (np. dodajnadawce). Zwracana jest lista obiektów o strukturze jak opisano w metodzie dodajnadawce (patrz typ danych Kontrahent w WSDL) Uwagi do funkcjonowania metody: 1. Metoda służy do wyszukiwania nadawców i odbiorców TYLKO z formą płatności gotówka 2. Wyszukiwanie jest wykonywane wg pól jak poniżej: <ns1:numer> - numer klienta <ns1:nrext> - numer zewnętrzny numer nadawany przez klienta do łatwego wyszukiwania <ns1:nazwa> - nazwa klienta - należy podać minimalnie 3 znaki <ns1:miasto> - należy podać minimalnie 3 znaki <ns1:ulica> - należy podać minimalnie 3 znaki <ns1:nip> - nr NIP (bez kresek) - należy podać minimalnie 3 znaki <ns1:czynadawca> - znacznik czy klient jest nadawcą (1 lub T) l 3. Jeśli podano wartość dla któregokolwiek z tych pól: <ns1:numer>, <ns1:nrext>, <ns1:nip>, <ns1:nazwa> to wyszukiwanie odbędzie się po jednym z tych kryteriów 21
4. Jeśli nie podano numeru klienta <ns1:numer> czy numeru zewnętrznego (<ns1:nrext>) to wyszukiwanie wg ulicy czy miasta wymaga podania co najmniej trzech parametrów jednocześnie np. ulicy, miasta, początku nazwy 5. Wyszukiwanie jest prowadzone w dwóch trybach (parametr tryb) wartość 1 dokładny np. wyszukiwanie wg nazwy dla podanej nazwy ALA zostaną znalezione tylko dane klientów z nazwą ALA. W trybie drugim (parametr tryb 2) znalezione zostaną dane klientów z nazwą zaczynającą się na podany napis ALA (np. ALABAMA itp.). Przykładowy komunikat.xml <soap:envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:body xmlns:ns1="http://app.siodemka.com/mm7ws/type/"> <ns1:szukajklientaelement> <ns1:daneklienta> <ns1:ulica></ns1:ulica> <ns1:emailkontakt></ns1:emailkontakt> <ns1:imie></ns1:imie> <ns1:numer></ns1:numer> <ns1:nazwisko></ns1:nazwisko> <ns1:nrdom></ns1:nrdom> <ns1:nrlokal></ns1:nrlokal> <ns1:kod></ns1:kod> <ns1:nrext></ns1:nrext> <ns1:nazwa>anet</ns1:nazwa> <ns1:telkontakt></ns1:telkontakt> <ns1:nip></ns1:nip> <ns1:czyfirma></ns1:czyfirma> <ns1:kodkraju></ns1:kodkraju> <ns1:miasto></ns1:miasto> <ns1:fax></ns1:fax> <ns1:telefonkom></ns1:telefonkom> <ns1:czynadawca></ns1:czynadawca> </ns1:daneklienta> <ns1:klucz>688ebf5d509e5fe310fcc304e0570425</ns1:klucz> <ns1:tryb>2</ns1:tryb> </ns1:szukajklientaelement> </soap:body> </soap:envelope> Gdzie: daneklienta struktura z danymi klienta Klucz klucz API do usług WS Tryb tryb wyszukiwania wartości 1 lub 2 patrz uwagi do opisu metody 17 Lista kodów błędu zwracanych przez metody wykorzystane w WebService7. 0001 Proszę jeszcze raz sprawdzić wypełniony formularz. <!-- %s //--> 0002 Pole %s ma za długą wartość. 0003 Pole "%s" jest za długie (>%s). 0004 Pole "%s" ma zły format. 22
0005 Pole "%s" jest wymagane. 1001 Rodzaj przesyłki "lokalna" realizowany jest w obrębie miasta Warszawa, zmień Rodzaj przesyłki na "krajowa". 1002 Błędne dane nadawcy - zła stacja nadania. 1003 Błędne dane odbiorcy - zła stacja odbioru. 1004 Nie wybrano nadawcy. 1005 Nie wybrano odbiorcy. 1006 Nie wybrano płatnika. 1007 Nie wybrano osoby kontaktowej nadawcy. 1008 Nie wybrano osoby kontaktowej odbiorcy. 1009 Nie wybrano osoby kontaktowej płatnika. 1010 Brak wprowadzonej nazwy pełnej odbiorcy. 1011 Brak wprowadzonej ulicy odbiorcy. 1012 Brak wprowadzonego nr domu odbiorcy. 1013 Brak lub błędny kod pocztowy odbiorcy. 1014 Brak wprowadzonego miasta odbiorcy. 1015 Błędny NIP odbiorcy. 1016 Łączna ilość paczek i palet przy imporcie nie może przekraczać %s. 1017 Brak określonej liczby paczek lub palet. 1018 Łączna ilość paczek i palet nie może przekraczać %s. 1019 Przy pobraniu i formie pobrania konto należy podać numer konta. 1020 Numer konta jest za krótki. Numer konta powinien zawierać 26 cyfr. 1021 Numer konta jest niepoprawny lub niezgodny ze standardami NRB lub IBAN. 1022 Przesyłka za pobraniem musi być ubezpieczona. 1023 Przy pobraniu należy zdeklarować wartość pobrania. 1024 Maksymalna kwota pobrania to 11 000, 00 zł. 1025 Kwota pobrania musi być formatu 99,99. 1026 Przy ubezpieczeniu należy zdeklarować wartość przesyłki. 1027 Kwota ubezpieczenia musi być formatu 99,99. 1028 Maksymalna kwota ubezpieczenia to 100 000, 00 zł. 1029 Kwota ubezpieczenia nie może być mniejsza jak kwota pobrania. 1030 Przy ubezpieczeniu należy podać zawartość paczki. 1031 Data nadania musi być następującego formatu RRRR-MMDD GG:MI. 1032 Brak daty nadania. 1033 Godzina nadania musi być różna od 00:00. 1034 Nieaktualna data nadania. 1035 Data nadania nie może wybiegać w przyszłość dalej niż 14 dni. 1036 Brak podpisu nadawcy. 1037 Podpis nadawcy musi zawierać co najmniej dwa znaki. 1038 Brak wprowadzonej łącznej wagi paczek. 1039 Łączna waga paczek jest za duża. 1040 Brak wprowadzonej łącznej wagi paczek powyżej 30 kg. 1041 Waga paczek powyżej 30 kg jest za mała. 1042 Brak wprowadzonej łącznej wagi palet. 1043 Łączna waga palet jest za duża. 23
1044 Godzina przy zastrzeżeniu doręczenia musi być z zakresu 00-23. 1045 W tabeli wag i ilości paczek któreś z pól ma niepoprawną wartość. 1046 Brak wprowadzonej ilości dni przy usłudze składowanie. 1047 Brak wprowadzonego telefonu odbiorcy. 1048 Brak wprowadzonego telefonu nadawcy. 1049 Przy wybranej usłudze 'Potwierdzenie dostawy na SMS' należy podać poprawny numer telefonu komórkowego (9 cyfr bez numeru kierunkowego). 1050 Brak wprowadzonego e-mail nadawcy. 1051 Wprowadzony e-mail nadawcy jest niepoprawny. 1052 Brak wprowadzonego e-mail odbiorcy. 1053 Wprowadzony e-mail odbiorcy jest niepoprawny. 1054 Brak wprowadzonej odległości. 1055 Odległość musi być dodatnia. 1056 Odległość musi być liczbą. 1057 Ilość dni przy składowaniu musi być dodatnia. 1058 Ilość dni przy składowaniu musi być liczbą. 1059 Usługa "Paleta Next Day" nie może zostać wybrana, gdyż nie nadano Żadnych palet. 1060 Nadawca może płacić tylko przelewem. 1061 Odbiorca może płacić tylko gotówką. 1062 Trzeci płatnik może płacić tylko przelewem. 1063 Dla przesyłek za pobraniem większym niż 6000zł obowiązuje odbiór własny. 1064 Wprowadzono kopertę/paletę, opcja kształt dostępna jest tylko dla paczek, zmień typ podpaczki! 1065 Dla ilości paczek większej niż 1, dane dotyczące kształtu/wymiarów paczki należy wprowadzić w oknie podpaczek. 1066 Numer kuriera ma niewłaściwy format. 1067 Musisz podać numer kuriera. 1068 Nie można wybrać jednocześnie usług: "Doręczenie Market" i "Doręczenie Osoba fizyczna". 1069 Nie można nadać przesyłki zagranicznej. Usługa niedostępna. 2001 Brak nazwiska. 2002 Brak imienia. 2003 Brak nazwy klienta. 2004 Brak NIPu. 2005 NIP jest niepoprawny. 2006 Brak kodu pocztowego. 2007 Kod pocztowy jest niepoprawny. 2008 Brak miasta. 2009 Brak ulicy. 2010 Brak nr domu. 2011 Brak telefonu. 2012 Wprowadzony e-mail jest niepoprawny. 2013 Wprowadzony e-mail osoby kontaktowej jest niepoprawny. 2014 Musisz podać nazwisko osoby kontaktowej. 2015 Wprowadzony telefon komórkowy osoby kontaktowej jest 24
niepoprawny (9 cyfr bez numeru kierunkowego). 2016 Wprowadzony telefon komórkowy jest niepoprawny (9 cyfr bez numeru kierunkowego). 3001 Wprowadzony e-mail osoby kontaktowej jest niepoprawny. 3002 Musisz podać nazwisko osoby kontaktowej. 3003 Wprowadzony telefon komórkowy osoby kontaktowej jest niepoprawny (9 cyfr bez numeru kierunkowego). 4001 Nie wybrano Żadnej podpaczki. 4002 Błędna waga podpaczki nr %s. 4003 Błędna długość podpaczki nr %s. 4004 Błędna szerokość podpaczki nr %s. 4005 Błędna wysokość podpaczki nr %s. 4006 Brak podanej wagi dla paczki nr %s. 4007 Brak podanej długości podpaczki nr %s. 4008 Brak podanej szerokości podpaczki nr %s. 4009 Brak podanej wysokości podpaczki nr %s. 4010 Podany wymiar podpaczki nr %s musi zawierać się w przedziale 81-200 cm. 4011 Dla podpaczki typu kształt (podpaczka nr %s) należy podać długość lub wszystkie trzy wymiary. 4012 Podane wymiary podpaczki nr %s nie przekraczają sumy 200 cm lub Żaden z wymiarów nie jest zawarty w przedziale 81-200cm. 4013 Typ kształt może mieć tylko paczka (podpaczka nr %s). 4014 Waga podpaczki nr %s nie może przekraczać 800kg. 25
18 Testowanie WebService7 w WebMobile7 Aby ułatwić testowanie usług WebService7 utworzone zostało środowisko testowe (adresy poniżej) pozwalające na nieograniczone korzystanie z usług aby mogli Państwo w łatwy i szybki sposób przystosować swoje oprogramowanie do korzystania z usług WebService7. Dane autoryzacyjne (numer klienta / klucz API) zawarte w specyfikacji mogą nie być aktualne. 18.1 Testowa usługa WebService7 udostępniona jest na środowisku testowym pod linkami: Aplikacja WebMobile7: http://testws.siodemka.com/mm7web/pub/login.do Usługa WebService7: http://testws.siodemka.com/mm7ws/siodemkaservicesoaphttpport WSDL usługi WebService7: http://testws.siodemka.com/mm7ws/siodemkaservicesoaphttpport?wsdl 18.2 Praca produkcyjna z WebService7 w WebMobile7 Aplikacja WebMobile7: http://webmobile7.siodemka.com/mm7web/pub/login.do Usługa WebService7: http://webmobile7.siodemka.com/mm7ws/siodemkaservicesoaphttpport WSDL usługi WebService7: http://webmobile7.siodemka.com/mm7ws/siodemkaservicesoaphttpport?wsdl 2 6
19 Dodatek A: ograniczenia pól w metodzie listnadanie Lp Nazwa pola Wartości dozwolone Czy wyma gane Opis sekcja <ns1:przesylka> Dane o przesyłce 1.1 <ns1:nrprzesylki> - N nr przesyłki uzupełniany po prawidłowym wywołaniu metody numerem listu nadawanym przez firmę Siódemka S.A. 1.2 <ns1:nrext> 30 znaków N numer zewnętrzny np. alfanumerycznych zlecenia klienta. Pole do 1.3 <ns1:mpk> 10 znaków alfanumerycznych dyspozycji klienta N miejsce powstawania kosztów. Pole do dyspozycji klienta do wykorzystania w ramach rozliczeń międzyoddziałowych 1.4 <ns1:rodzajprzesylki> 1 litera T rodzaj przesyłki: K krajowa, L lokalna, Z zagraniczna 1.5 <ns1:placi> 1 cyfra T kto płaci za usługę: 1 nadawca, 2 odbiorca, 3 trzeci płatnik 1.6 <ns1:formaplatnosci> 1 litera T forma płatności za przesyłkę: G gotówka, P przelew 1.7 <ns1:uwagi> 200 znaków N uwagi klienta odnośnie przesyłki sekcja <ns1:nadawca> dane nadawcy 2.1 <ns1:numer> 10 cyfr T numer nadawcy 2.2 <ns1:nazwisko> 100 znaków N nazwisko osoby nadającej przesyłkę 2.3 <ns1:imie> 50 znaków N imię osoby nadającej przesyłkę 2.4 <ns1:telkontakt> 20 znaków N telefon kontaktowy osoby nadającej przesyłkę 2.5 <ns1:emailkontakt> 80 znaków N email osoby nadającej przesyłkę sekcja <ns1:odbiorca> - dane odbiorcy 27
Lp Nazwa pola Wartości dozwolone Czy wyma gane Opis 3.1 <ns1:numer> - N numer odbiorcy w systemie firmy Siódemka uzupełniany po dodaniu nowego kontrahenta do bazy danych 3.2 <ns1:nrext> 10 znaków alfanumerycznych N numer zewnętrzny (np. w systemie nadawcy). Pole do dyspozycji klienta 3.3 <ns1:czyfirma> 1 cyfra T znacznik czy odbiorca jest firmą 1 tak 0 nie 3.4 <ns1:nazwa> 150 znaków T nazwa odbiorcy 3.5 <ns1:nip> 10 cyfr N numer NIP odbiorcy (bez kresek) 3.6 <ns1:nazwisko> 95 znaków N nazwisko odbiorcy 3.7 <ns1:imie> 50 znaków N imię odbiorcy 3.8 <ns1:kodkraju> zgodnie z ISO 3166- T kod kraju odbiorcy 1 alfa-2 3.9 <ns1:kod> 6 znaków T kod pocztowy odbiorcy w formacie XX-XXX (gdzie x jest cyfrą od 0 do 9) 3.10 <ns1:miasto> 70 znaków T miasto odbiorcy 3.11 <ns1:ulica> 70 znaków T ulica odbiorcy 3.12 <ns1:nrdom> 20 znaków T nr domu odbiorcy 3.13 <ns1:nrlokal> 10 znaków N nr lokalu odbiorcy 3.14 <ns1:telkontakt> 20 znaków N telefon kontaktowy odbiorcy 3.15 <ns1:emailkontakt> 40 znaków N adres email odbiorcy sekcja <ns1:platnik> - dane płatnika 4.1 <ns1:numer> 10 cyfr T/N numer klienta płatnika w systemie firmy Siódemka S.A. 4.2 <ns1:telkontakt> 50 znaków N telefon kontaktowy do płatnika sekcja <ns1:uslugi> - dane usług 5.1 <ns1:nrbezpiecznejkoperty> 50 znaków N numer opakowania klienta 5.2 <ns1:zkld> 1 cyfra T usługa Potwierdzenie Doręczenia : 0 brak 1 PD email 2 PD kurier 3 PD email i PD kurier 2 8
Lp Nazwa pola Wartości dozwolone Czy wyma gane Opis 5.3 <ns1:zd> 1 cyfra T usługa Dokumenty zwrotne : 0 nie 1 tak sekcja <ns1:ubezpieczenie> - Dana o ubezpieczeniu przesyłki 5.4.1 <ns1:kwotaubezpieczenia> T/N kwota ubezpieczenia przesyłki 5.4.2 <ns1:opiszawartosci> 200 znaków T/N opis zawartości przesyłki sekcja <ns1:pobranie> - dane o pobraniu 5.5.1 <ns1:kwotapobrania> Max 8 cyfr w tym dwie po przecinku wymagany ubezpieczeniu T/N kwota pobrania (separator dziesiętny przecinek). Max. 11 000 PLN. Powyżej 6000 PLN wymagane zaznaczenie usługi <ns1:odbwlas> 5.5.2 <ns1:formapobrania> 1 litera T/N forma zwrotu pobrania do nadawcy P przekaz pocztowy, B przelew bankowy (konieczne podanie numeru konta) N pobranie NextDay (konieczne podanie numeru konta) 5.5.3 <ns1:nrkonta> 26 cyfr T/N numer konta w formacie IBAN 5.6 <ns1:awizacjatelefoniczna> 1 cyfra T Usługa nieaktywna: zawsze 0 5.7 <ns1:potwnademail> 1 cyfra T potwierdzenie nadania przesyłki na adres podany adres Dopuszczalne wartości 0 nie 1 - tak 5.8 <ns1:potwdostemail> 1 cyfra T Serwis EMAIL. Dopuszczalne wartości 0 nie 1 - tak 5.9 <ns1:potwdostsms> 1 cyfra T Serwis SMS. Dopuszczalne wartości 0 nie 1 - tak przy e-mail. 2 9
Lp Nazwa pola Wartości dozwolone Czy wyma gane Opis 5.10 <ns1:skladowanie> 3 cyfry T składowanie wartość większa od 0 oznacza liczbę dni składowania przesyłki 5.11 <ns1:nadodbpkp> 1 cyfra T nadanie / odebranie przesyłki do / z pociągu. Dopuszczalne wartości 0 nie 1 tak 5.12 <ns1:odbnadgodziny> 1 cyfra T podjęcie przesyłki w godzinach niestandardowych. Dopuszczalne wartości 0 nie 1 tak 5.13 <ns1:odbwlas> 1 cyfra T odbiór własny przesyłki przez klienta. Dopuszczalne wartości 0 nie 1 tak 5.14 <ns1:palnextday> 1 cyfra T doręczenie palety w strefie B na dzień następny. Dopuszczalne wartości 0 nie 1 tak 5.15 <ns1:osobafiz> 1 cyfra T doręczenie przesyłki do osoby fizycznej. Dopuszczalne wartości 0 nie 1 tak 5.16 <ns1:market> 1 cyfra T doręczenie przesyłki do marketu. Dopuszczalne wartości 0 nie 1 tak 5.17 <ns1:zastrzdornagodz> GG T zastrzeżenie doręczenie przesyłki na godzinę, Dopuszczalne wartości pełne godziny np. 7 lub 14. 00:00 brak usługi 0 brak usługi 10 Siódemka NextDay 10 12 Siódemka NextDay 12 3 0
Lp Nazwa pola Wartości dozwolone Czy wyma gane Opis 5.18 <ns1:zastrzdornadzien> 1 litera T zastrzeżenie doręczenie przesyłki na dzień wolny, Dopuszczalne wartości B brak usługi N niedziela S sobota sekcja <ns1:paczki> - lista paczek składająca się z powtarzających się sekcji <ns1:paczka>. Musi wystąpić przynajmniej jedna sekcja <ns1:paczka> 6.1 <ns1:nrpp> 13 cyfr - nr paczki uzupełniany po prawidłowym wywołaniu metody przez firmę Siódemka S.A. 6.2 <ns1:typ> 2 litery T typ paczki. Dopuszczalne wartości PC paczka PL paleta KP koperta 6.3 <ns1:waga> 5 cyfr (w tym jedna T waga paczki cyfra po przecinku) 6.4 <ns1:gab1> max. 5 cyfr T długość (w cm) 6.5 <ns1:gab2> max. 5 cyfr T szerokość (w cm) 6.6 <ns1:gab3> max. 5 cyfr T wysokość (w cm) 6.7 <ns1:ksztalt> 1 cyfra T czy paczka posiada nietypowy kształt (np. 6.8 <ns1:wagagabaryt> max 5 cyfr (w tym jedna cyfra po przecinku) pole wyliczane sekcja <ns1:potwierdzenienadania> 7.1 <ns1:datanadania> YYYY-MM-DD HH24:MI wystające Dopuszczalne wartości 0 nie 1 - tak elementy). - waga gabarytowa paczki (obliczana (gab1 * gab2 * gab3) / 6000) T data nadania przesyłki w formacie YYYY-MM-DD HH24:MI np. 2009-08-25 17:00 Data nie może być mniejsza niż obecna. 7.2 <ns1:numerkuriera> 6 cyfr T numer kuriera podejmującego przesyłkę 7.3 <ns1:podpisnadawcy> 50 znaków T podpis nadawcy (np. nazwisko osoby nadającej przesyłkę) 31
20 Dodatek B: Prefixy używane do walidacji telefonu komórkowego Lp. Prefix Operator sieci komórkowych 1 500 PTK Centertel Orange 2 530 P4 Play 3 531 P4 Play 4 533 P4 Play 5 535 P4 Play 6 600 Polska Telefonia Cyfrowa Era 7 601 Polkomtel Plus 8 602 Polska Telefonia Cyfrowa Era 9 603 Polkomtel Plus 10 604 Polska Telefonia Cyfrowa Era 11 605 Polkomtel Plus 12 606 Polska Telefonia Cyfrowa Era 13 607 Polkomtel Plus 14 608 Polska Telefonia Cyfrowa Era 15 609 Polkomtel Plus 16 660 Polska Telefonia Cyfrowa Era 17 661 Polkomtel Plus 18 662 Polska Telefonia Cyfrowa Era 19 663 Polkomtel Plus 20 664 Polska Telefonia Cyfrowa Era 21 665 Polkomtel Plus 22 6660 Polska Telefonia Cyfrowa Era 23 6661 Polska Telefonia Cyfrowa Era 24 6662 Polska Telefonia Cyfrowa Era 25 6663 Polska Telefonia Cyfrowa Era 26 6664 Polska Telefonia Cyfrowa Era 27 6665 Polska Telefonia Cyfrowa Era 28 6666 Telekomunikacja Kolejowa (dla GSM-R, 29 6667 Polska Telefonia Cyfrowa Era 30 6668 Polska Telefonia Cyfrowa Era 31 6669 Polska Telefonia Cyfrowa Era 32 667 Polkomtel Plus 33 668 Polska Telefonia Cyfrowa Era 34 669 Polkomtel Plus 35 6901 PTK Centertel sieć NMT 36 6902 PTK Centertel sieć NMT 37 6903 PTK Centertel sieć NMT 38 6904 PTK Centertel sieć NMT 39 6905 PTK Centertel sieć NMT 32
Lp. Prefix Operator sieci komórkowych 40 6906 PTK Centertel sieć NMT 41 691 Polkomtel Plus 42 692 Polska Telefonia Cyfrowa Era 43 693 Polkomtel Plus 44 694 Polska Telefonia Cyfrowa Era 45 695 Polkomtel Plus 46 696 Polska Telefonia Cyfrowa Era 47 697 Polkomtel Plus 48 698 Polska Telefonia Cyfrowa Era 49 69900 Cyfrowy Polsat Cyfrowy Polsat 50 69901 WOLNY, poprzednio: Tele2 (prefiks 51 69902 Cyfrowy Polsat Cyfrowy Polsat 52 69903 Cyfrowy Polsat Cyfrowy Polsat 53 69904 Cyfrowy Polsat Cyfrowy Polsat 54 69905 Cyfrowy Polsat Cyfrowy Polsat 55 69906 Cyfrowy Polsat Cyfrowy Polsat 56 69907 Cyfrowy Polsat Cyfrowy Polsat 57 69908 Cyfrowy Polsat Cyfrowy Polsat 58 69909 Cyfrowy Polsat Cyfrowy Polsat 59 6991 Cyfrowy Polsat Cyfrowy Polsat 60 69920 Cyfrowy Polsat Cyfrowy Polsat 61 69921 Cyfrowy Polsat Cyfrowy Polsat 62 69922 E-Telko (prefiks nieużywany) 63 69923 Cyfrowy Polsat Cyfrowy Polsat 64 69924 Cyfrowy Polsat Cyfrowy Polsat 65 69925 Cyfrowy Polsat Cyfrowy Polsat 66 69926 Cyfrowy Polsat Cyfrowy Polsat 67 69927 Cyfrowy Polsat Cyfrowy Polsat 68 69928 Cyfrowy Polsat Cyfrowy Polsat 69 69929 Cyfrowy Polsat Cyfrowy Polsat 70 6993 Cyfrowy Polsat Cyfrowy Polsat 71 6994 Cyfrowy Polsat Cyfrowy Polsat 72 6995 Telefonia Dialog SA (prefiks 73 69960 GTS Energis (prefiks nieużywany) 74 69961 Cyfrowy Polsat Cyfrowy Polsat 75 69962 Cyfrowy Polsat Cyfrowy Polsat 76 69963 Cyfrowy Polsat Cyfrowy Polsat 77 69964 Cyfrowy Polsat Cyfrowy Polsat 78 69965 Cyfrowy Polsat Cyfrowy Polsat 79 69966 Cyfrowy Polsat Cyfrowy Polsat 80 69967 mpay (prefiks nieużywany) 81 69968 Cyfrowy Polsat Cyfrowy Polsat 82 69969 mpay (prefiks nieużywany) 83 6997 Telefonia Dialog SA (prefiks 33
Lp. Prefix Operator sieci komórkowych 84 6998 Telefonia Dialog SA (prefiks 85 6999 Telefonia Dialog SA (prefiks 86 720 CenterNet wrodzinie 87 721 Polkomtel Plus 88 7220 Polkomtel Plus 89 7221 Polkomtel Plus 90 7222 Polkomtel Plus 91 7223 Polkomtel Plus 92 7224 Polkomtel Plus 93 7225 Polkomtel Carrefour Mova 94 7226 Polkomtel Plus 95 7227 Polkomtel Plus 96 7228 Polkomtel Carrefour Mova 97 7229 Polkomtel Carrefour Mova 98 723 Polkomtel Plus 99 724 Polkomtel Plus 100 725 Polkomtel 36i6 101 726 Polkomtel 36i6 102 7271 Nordisk Polska Nordisk 103 7272 Polska Telefonia Cyfrowa TuBiedronka 104 7273 Polska Telefonia Cyfrowa TuBiedronka 105 7274 Polkomtel (prefiks nieużywany) 106 7275 Polkomtel Plus 107 7276 Polkomtel (prefiks nieużywany) 108 7277 Polkomtel (prefiks nieużywany) 109 7278 Polkomtel (prefiks nieużywany) 110 7279 Polkomtel FM Mobile 111 7280 Mobyland (prefiks nieużywany) 112 7281 Polska Telefonia Cyfrowa Era 113 7282 Polska Telefonia Cyfrowa Era 114 7283 Polska Telefonia Cyfrowa Era 115 7284 Polska Telefonia Cyfrowa Era 116 7285 Polska Telefonia Cyfrowa Era 117 7286 Polska Telefonia Cyfrowa Era 118 7287 Polska Telefonia Cyfrowa Era 119 7288 Polska Telefonia Cyfrowa Era 120 7289 Polska Telefonia Cyfrowa Era 121 7290 Gadu Gadu GaduAIR 122 7291 Gadu Gadu GaduAIR 123 780 PTK Centertel Aster 124 781 Polkomtel Plus 125 782 Polkomtel Plus 126 7830 Polkomtel Plus 127 7831 Polkomtel Plus 3 4