Transportinstruktion / Kvittens Gränssnittsdokumentation Version 3.10
Datum: 2008-05-20 Sida 2 av 36 INNEHÅLLSFÖRTECKNING 1 ADRESS FÖR TJÄNST... 3 2 INPUT/OUTPUT DATAFORMAT... 3 3 INPUT/OUTPUT DATASTRUKTUR... 4 3.1 Request... 4 3.2 Response... 5 3.3 System... 5 4 ÖVERBLICK AV TJÄNSTENS METODMEDDELANDE... 6 4.1 search_transport_documents... 6 4.2 get_transport_document... 6 4.3 get_transport_instruction... 7 4.4 get_waybill... 7 4.5 get_epod... 7 5 DEFINITIONER FÖR MEDDELANDEN... 8 5.1 search_transport_documents... 8 5.1.1 Input... 8 5.1.2 Output... 10 5.2 get_transport_document... 12 5.2.1 Input... 12 5.2.2 Output... 14 5.3 get_transport_instruction... 14 5.3.1 Input... 14 5.3.2 Output... 19 5.4 get_waybill... 25 5.4.1 Input... 25 5.4.2 Output... 29 5.5 get_epod... 29 5.5.1 Input... 29 5.5.2 Output... 34 5.6 Xml output vid no hits... 35 5.7 Xml output vid fel (error)... 35 granssnitt_schenker_ti-kvittens_31.doc 2(36)
Datum: 2008-05-20 Sida 3 av 36 5.8 Xml output vid valideringsfel... 36 5.9 Unika felkoder hos tjänsten (service)... 36 Ändringar Versionshistorik: Version Datum Kommentarer 3.10 3.02 2008-05-20 2007-06-29 Lagt till ett reference_type värde cw. Kap. 5.5.1.1 Kap. 5.1.1.1: consignor_reference_number tillagt. Kap 5.5.1.3 Nytt kapitel. Kap. 4.1, 5.1.1.1: Sökning med pallsaldobesked 3.01 2006-10-30 Kap. 5.2.1.1, 5.3.1.1: Deklarerad is_include_delivery_note som obligatorisk (M). 1 Adress för tjänst Tjänsten hittas på URL: http://was.webtrp.com/trpdocweb/trpdocservlet_1? 2 Input/output dataformat Tjänstens input-parametrar och output-meddelanden har format som är i överenstämmelse med Schenker Web Development Rules v2.2 (WDR) (eller 2.1 i det fall där 2.2 inte är färdigställt). Input-parametrar är namnsatta utifrån WDR hqf format.det PRIMÄRT replikerade formatet av ett icke pdf RETURN är xml (MIME-format text/xml), men tjänsten stöder också WDR-format hqf (MIME-format text/plain. Bilder returneras som Base64 kodad pdf inbäddat i xml.. I detta dokument är input-parametrarna representerade i pdf-format (inget annat format stöds) emedan svarsmeddelanden presenteras i xml (det vanliga returformatet). Konsultera WDR för översättning till hqf.. Tjänsten hanterar både GET och POST http request. granssnitt_schenker_ti-kvittens_31.doc 3(36)
Datum: 2008-05-20 Sida 4 av 36 3 Input/output datastruktur I enlighet med WDR byggs gränssnittets datastruktur upp av fyra allmänna containers (xmlelement) vilka grupperar datan i logiska enheter : Request (begäran), består av information till tjänsten, Response (svar), består av information från tjänsten, System, innehåller felinformation som genereras av systemet, data_list (datalista), är en samling bestående av aktuella meddelanden. Request, response och system containers har några standardfält som appliceras till alla meddelanden. Notera att ett meddelande kan innehålla tilläggsdata som inte definieras i detta dokument. 3.1 Request Hgf-fältet nedan är inkluderat i request-containern. Name M Typ Standard Förklaring service.action M Sträng WDR Säger vad tjänsten skall göra service.method M Sträng WDR Är en specificering av service.action Säger till tjänsten vilken slag av vald händelse som skall utföras service.type M Sträng WDR Är en specificering av service.method format.mime M Sträng WDR Säger till tjänsten vilket format som skall användas i svaret Format som stöds är: 1 text/xml för xml returer 2 text/plain för hqf returer 3 text/html för html returer format.type Sträng WDR Är en specificering av format.mime. user.login_name M Sträng WDR Användar-ID som används för behörighetskontroll. user.password M Sträng WDR Användarens lösenord. Används för behörighetskontroll. M = Obligatoriskt (mandatory) granssnitt_schenker_ti-kvittens_31.doc 4(36)
Datum: 2008-05-20 Sida 5 av 36 3.2 Response Xml-meddelandet nedan är inbäddat i response container. Lägg till elementet <xml><response> till fälten för att få en fullständig sökväg för xml Name M Typ Standard Förklaring <service><name> M Sträng WDR Tjänstens namn; transport_document <service><version> M Sträng WDR Tjänstens version <data_list_count> M Int WDR Antal containers i data_list M = Obligatoriskt (mandatory) 3.3 System Xml-fältet nedan är inrymt I systemcontainern. Lägg till element <xml><system> till fälten för att fullfölja xml-sökvägen. Name M TYP Standard Förklaring <error><id> M Int WDR Felkod 0 betyder OK (inga fel) 10 betyder att tjänsten är stängd 210 betyder valideringsfel Se WDR för en fullständig listning av felkoder.. <error><message> Sträng WDR Felmeddelande. <error><service><error><id> Int WDR Speciella felkoder för tjänsten. Se Service unique error codes. <error><validation_list><valida tion index= n ><field_name> <error><validation_list><valida tion index= n ><error><id> <error><validation_list><valida tion index= n ><old_value> M* Sträng WDR Hqf-namn för ett ogiltigt input-fält. M* Int WDR Valideringsfelkod (se WDR) M* Sträng WDR Koden för ett ogiltigt input-fält. M = Obligatoriskt (mandatory) M* = Obligatoriskt vid valideringsfel (error.id=210) granssnitt_schenker_ti-kvittens_31.doc 5(36)
Datum: 2008-05-20 Sida 6 av 36 4 Överblick av tjänstens metodmeddelande Detta är de tillgängliga metoderna : 1 search_transport_documents 2 get_transport_document 3 get_transport_instruction 4 get_waybill 5 get_epod 4.1 search_transport_documents Söker efter numren hos transportdokumenten (uppdrags-id=sändingsnummer=fraktsedelsnummer) knutet till en faktura, debiteringsbesked eller pallsaldobesked. Input (data_list-array size=1): Fakturanummer, pallsaldo eller debiteringsmeddelande DB-key Output: Om (If) det finns fler än en träff listas numren på transportdokumenten identifierar transportinstruktioner eller fraktsedel knutet till faktura/debiteringsbesked Annars (else) om en träff identifierar en transportinstruktion den kopplade transportinstruktionen Annars (else) om en träff identifierar en fraktsedel Den associerade fraktsedeln (som base 64 kodad pdf) Annars (else) standard WDR inget träffsvar (eller felmeddelande) 4.2 get_transport_document Fångar en specifik transportinstruktion eller fraktsedel. Input (data_list-array size=1): Transportdokumentnummer eller Kolli-id Output: Om(If) transportinstruktion hittas: transportinstruktionen annars (else) om fraktsedel hittas: den associerade fraktsedeln (som base 64 encoded pdf) annars (else): standard-wdr ingen träff (eller felmeddelande) granssnitt_schenker_ti-kvittens_31.doc 6(36)
Datum: 2008-05-20 Sida 7 av 36 4.3 get_transport_instruction Får en eller flera specifika transportinstruktioner Input (data_list-array size=n): transportdokumentnummer och valfritt typspecifikation för svarsformat (obligatoriskt om data_listarray size>1) Output: om (if) typspecifikation för svarsformat är pdf transportinstruktionen för varje transportdokument i det begärda (request) data_list-array (en eller flera) som ett hopslaget (merged) base 64 kodat pdf (om hittat, annars ingen träff/felmeddelande) Annars (else) transportinstruktion för det första transportdokumentnumret I den begärda (request) data_listarray (om hittat, annars ingen träff/felmeddelande) 4.4 get_waybill Erhåller ett eller fler specifika transportfraktsedlar Input (data_list-array size=n): transportdokumentnummer Output: fraktsedel för varje transportdokument I den begärda (request) data_list-array (en eller flera) som ett hopslaget (merged) base 64 kodat pdf (om hittat, annars ingen träff/felmeddelande) 4.5 get_epod Erhåller en eller flera specifika kvittenser Input (data_list-array size=n): transportdokumentnummer Output: Kvittens för varje transportdokument I den begärda (request) base 64 kodat pdf (om hittat, annars ingen träff/felmeddelande) granssnitt_schenker_ti-kvittens_31.doc 7(36)
Datum: 2008-05-20 Sida 8 av 36 5 Definitioner för meddelanden I detta kapitel definieras input hqf parametrar och output xml-meddelanden för varje metod som stöds av tjänsten. 5.1 search_transport_documents 5.1.1 Input 5.1.1.1 Parametrar I tabellen nedan definieras parametrar för input hqf för att söka efter transportdokumentnummer (uppdrags-id=sändingsnummer=fraktsedelsnummer) som är associerade med faktura, debiteringseller pallsaldobesked. Namn M Typ Standard Värde / Förklaring Request container. Add the prefix request. to the parameters. Service.action M Sträng WDR Värde = select Service.method M Sträng WDR Värde = search_transport_documents Format.mime M Sträng WDR Det förväntade returnerade formatet user.login_name M Sträng WDR Användar-ID som används för behörighetskontroll. user.password M Sträng WDR Användarens lösenord. Används för behörighetskontroll. Innehåll datalista container. Lägg till prefixet data_list.0. till parametrarna. Notera: Tjänsten innehåller bara en data container (den första, index=0). Ytterligare data containers ignoreras. reference_number M Sträng RFF Referensnummer (sökargument) definierad av en reference function code qualifier (reference_type) consignor_reference_number M Sträng RFF Kundnummer. Endast obligatorisk (M) då reference_type=pallet_balance reference_type M Sträng RFF Reference function code qualifier (sökargument). Kod som ger en särskild betydelse till ett referensnummer (skickat i reference_number) Giltiga värden: iv, zdnoid, pallet_balance RFF 1153 IV Fakturanummer (Invoice Number) Referensnummer tilldelad från säljaren till en kommersiell faktura (Commercial Invoice). granssnitt_schenker_ti-kvittens_31.doc 8(36)
Datum: 2008-05-20 Sida 9 av 36 Ingen standard zdnoid Debiteringsbesked identifiering.db unik nyckelidentifiering identifierar ett debiteringsbesked. Ingen standard pallet_balance pallsaldoidentifiering.db unik nyckelidentifiering identifierar ett pallsaldo. Alla kan associeras med ett eller flera transportdokuments nummer (fraktsedel/sändning) Statistiska parametrar. Lägg till prefix system. till parametrarna. statistics.remote.country_code M Sträng WDR Landskod för kund, ex. se eller us statistics.user.language_code M Sträng WDR Språkkod för kund, ex. sv_se statistics.remote.send_data_fo rmat M Sträng WDR Kundens sätt att skicka sin begäran, xml eller hqf (Http Query Format) statistics.remote.access_type M Sträng WDR Kundens sätt att kommunicera, A (webbläsare) statistics.remote.application_n ame statistics.user.return_mime_for mat M Sträng WDR Namnet på klientapplikationen som kommunicerar M Sträng WDR Formatet som kunden vill att svaret skall levereras på text/plain, text/html eller text/xml statistics.user.organization_id M Sträng WDR Kundens momsregistreringsnummer statistics.service.api_version M Sträng WDR 2.0 statistics.remote.admin_e_mail M Sträng WDR E-postadress till den som är ansvarig för kundens applikation M = Obligatoriskt (mandatory) granssnitt_schenker_ti-kvittens_31.doc 9(36)
Datum: 2008-05-20 Sida 10 av 36 5.1.1.2 Exempel URL för sökning med fakturanummer Byt följande ut mot aktuella värden: <ApplikationsURL> <Användar_ID> <Användar_lösenord> <Referensnummer> <Kundens_momsregistreringsnummer> Exempel-URL för hämtning av transportdokument: <ApplikationsURL>?request.service.action=select&request.service.method=search_transport_docu ments&request.format.mime=text/xml&request.user.login_name=<användar_id>&request.user.pa ssword=<användar_lösenord>&data_list.0.reference_number=<referensnummer>&data_list.0.ref erence_type=iv&system.statistics.remote.country_code=se&system.statistics.remote.send_data_fo rmat=hqf&system.statistics.remote.access_type=a&system.statistics.remote.application_name=te st&system.statistics.user.organization_id=<kundens_momsregistreringsnummer>&system.statistic s.user.language_code=sv&system.statistics.user.return_mime_format=xml 5.1.2 Output Xml exemplet nedan visar svar (respons) då transportdokument (sändning/fraktsedel) hittas. Transportdokumentnummer identifierar fraktsedlar och instruktioner returneras i samma data-array med en klassificerare. Några transportdokumentnummer kan förekomma två gånger med olika klassificerare (träff i två backend system). Klassificerare kan lätt användas för urval i xpath.a Om inga transportdokument hittas returneras ett no hits. Se avsnitt Xml output vid "no hits. Om ett valideringsfel sker vid uppstart returneras ett valideringsfelmeddelande. Se avsnitt Xml output vid valideringsfel. Valideringsfelkoder beror på typ av fel (se WDR) Om andra typer av fel inträffar returneras ett generellt felmeddelande. Se avsnitt Xml output vid fel. Typ av felkod beror på typ av fel (Se WDR). Notera även tjänstespecifika felmeddelande kan returneras. Se Unika felkoder hos tjänsten (service). Exempel: <?xml version="1.0" encoding="iso-8859-1"?> <xml> <data_list> <data index= 0 > <transport_document_number>123456</transport_document_number> <transport_document_association> instruction </transport_document_association> <acceptance_date>20050112</acceptance_date> </data> granssnitt_schenker_ti-kvittens_31.doc 10(36)
Datum: 2008-05-20 Sida 11 av 36 <data index= 1 > <transport_document_number>123456</transport_document_number> <transport_document_association> waybill </transport_document_association> <acceptance_date>20050225</acceptance_date> </data> <data index= 2 > <transport_document_number>4564</transport_document_number> <transport_document_association> waybill </transport_document_association> <acceptance_date>20050113</acceptance_date> </data> <data index= 3 > <transport_document_number>98756</transport_document_number> <transport_document_association> instruction </transport_document_association> <acceptance_date>20050301</acceptance_date> </data> </data_list> <system> <error> <id>0</id> </error> </system> <respose> <service> <name>xxx</name> <version>1.0</version> </service> <data_list_count>4</data_list_count> </response> </xml> 5.1.2.1 Parametrar Tabellen nedan definierar hqf output parametrar i data_list array. Addera prefixet data_list.n. till parametrarna. granssnitt_schenker_ti-kvittens_31.doc 11(36)
Datum: 2008-05-20 Sida 12 av 36 Namn Typ Standard Värde/Förklaring transport_document_number RFF-AAS Uppdrags-ID (används även som sändnings- och fraktsedelsnummer). Referens tilldelad åkaren eller hans agent av transportdokument transport_document_associati on Ingen standard Klassificerare som anger om ett transport_document_number i ett dataelement är associerat med en transportinstruktion eller en fraktsedel. Tillåtna värden: Instruction, waybill acceptance_date Cons-DTM 2005-143 DE 2380 Transportdatum Acceptans datum/tid av godset [2126]. Datum då godset tas över av åkaren vid platsen för acceptans (CMR 4) 5.2 get_transport_document 5.2.1 Input 5.2.1.1 Parametrar Tabellen nedan definierar hqf input parametrar för att få en specifik transportinstruktion (primärt) eller fraktsedel (sekundärt). Namn M Typ Standard Värde/Förklaring Request container. Lägg till prefixet request. till parametrarna. service.action M Sträng WDR Värde = select service.method M Sträng WDR Värde = get_transport_document format.mime M Sträng WDR Det önskade returformatet. user.login_name M Sträng WDR Användar-ID som används för behörighetskontroll. user.password M Sträng WDR Användarens lösenord. Används för behörighetskontroll. Innehåll datalista container. Lägg till prefixet data_list.0. till parametrarna. Notera: Tjänsten innehåller bara en data container (den första, index=0). Ytterligare data granssnitt_schenker_ti-kvittens_31.doc 12(36)
Datum: 2008-05-20 Sida 13 av 36 containers ignoreras. reference_number M Sträng RFF Referensnummer (sök argument) definierad av en referens funktions kod (reference_type) reference_type M Sträng RFF Referensfunktionskvalificerare (sök argument). Koden ger mening till referensnumret (referece_number) Tillåtna värden: aas, cw RFF 1153 AAS Transport document nummer number [1188] Referens tilldelad av åkaren eller hans agent av transporten.. Uppdrags-id IFTMBF: RFF+AAS IFTMIN: RFF+AAS FS: Fraktsedel nr TI: Sändningsnr STE: Sändnings-id/Consignment ID RFF 1153 CW Paket nummer (7070) Referensnummer som identifierar ett paket eller kartong inom sändningen. is_include_delivery_note M Boolean Härrör från WDR och RFF1153 DQ Statistiska parametrar. Lägg till prefixet system. till parametrarna. Booleansk flagga som avgör om följesedelskall inkluderas i transportinstruktions svaret. Om ifylld och värdet är 1(true) inkludera. statistics.remote.country_code M Sträng WDR Landskod för kunden, ex se eller us. statistics.user.language_code M Sträng WDR Språkkod för kunden, ex sv_se statistics.remote.send_data_fo rmat M Sträng WDR Kundens sätt att sända förfrågan, xml eller hqf (Http Query Format) statistics.remote.access_type M Sträng WDR Kundens typ av anrop, A (webbläsare) statistics.remote.application_n M Sträng WDR Namnet på den applikation hos kund som granssnitt_schenker_ti-kvittens_31.doc 13(36)
Datum: 2008-05-20 Sida 14 av 36 ame statistics.user.return_mime_for mat gör anropet. M Sträng WDR Formatet som kunden vill ha svaret på. text/plain, text/html eller text/xml. statistics.user.organization_id M Sträng WDR Kundens momsregistreringsnummer statistics.service.api_version M Sträng WDR 2.0 statistics.remote.admin_e_mail M Sträng WDR E-post adressen till den ansvarige för kundens applikation M = obligatoriska(mandatory) 5.2.2 Output Om instruktion/fraktsedel inte hittas returneras ett no hits. Se kapitel XML output vid no hits. Om ett valideringsfel uppträder returneras ett valideringsfel. Se kapitel XML output vid valideringsfel. Valideringsfelskoder beror på felet (se WDR). Om något annat fel inträffar returneras ett generellt felmeddelande. Se kapitel XML output vid fel. Felkoden beror på felet (se WDR). Notera: även service specifika felmeddelanden kan returneras. Se Service unika felkoder. 5.3 get_transport_instruction 5.3.1 Input 5.3.1.1 Parametrar Tabellen nedan definierar input hqf parametrar för att få en eller flera transportinstruktioner. Namn M Typ Standard Värde/Förklaring Request container. Lägg till prefixet request. till parametrarna. service.action M Sträng WDR Värde = select service.method M Sträng WDR Värde = get_transport_instruction format.mime M Sträng WDR Det önskade returformatet. format.type M 1 Sträng WDR Används när instruktion skall returneras när base64 encoded pdf anges i xml. Tillåtet värde = application/pdf user.login_name M Sträng WDR Användar-ID som används för behörighetskontroll. user.password M Sträng WDR Användarens lösenord. Används för behörighetskontroll. granssnitt_schenker_ti-kvittens_31.doc 14(36)
Datum: 2008-05-20 Sida 15 av 36 Innehåll datalista container. Lägg till prefixet data_list.n. till parametrarna. Notera: När request.format.type=application/pdf hanterar tjänsten multipla containers, annars hanteras bara en container (den första, index = 0) ev. övriga containers blir ignorerade. reference_number M Sträng RFF Referensnummer (sök argument) definierad av en referens funktions kod (reference_type) reference_type M Sträng RFF Referensfunktionskvalificerare (sök argument). Koden ger mening till referensnumret (referece_number) Tillåtna värden: aas, cw RFF 1153 AAS Transport document nummer number [1188] Referens tilldelad av åkaren eller hans agent av transporten.. Uppdrags-id IFTMBF: RFF+AAS IFTMIN: RFF+AAS FS: Fraktsedelsnummer TI: Sändningsnummer STE: Sändnings-ID/Consignment ID RFF 1153 CW Paket nummer (7070) Referensnummer som identifierar ett paket eller kartong inom sändningen. is_include_delivery_note M Boolean Härrör från WDR och RFF11 53DQ Statistiska parametrar. Lägg till prefixet system. till parametrarna. Booleansk flagga som avgör om följesedelskall inkluderas i transportinstruktions svaret. Om ifylld och värdet är 1(true) inkludera. statistics.remote.country_code M Sträng WDR Landskod för kunden, ex se eller us. statistics.user.language_code M Sträng WDR Språkkod för kunden, ex sv_se statistics.remote.send_data_fo rmat M Sträng WDR Kundens typ av anrop A (webbläsare) statistics.remote.access_type M Sträng WDR Kundens typ av anrop A (webbläsare) granssnitt_schenker_ti-kvittens_31.doc 15(36)
Datum: 2008-05-20 Sida 16 av 36 statistics.remote.application_n ame statistics.user.return_mime_for mat M Sträng WDR Namnet på den applikation hos kund som gör anropet. M Sträng WDR Formatet som kunden vill ha svaret på. text/plain, text/html eller text/xml. statistics.user.organization_id M Sträng WDR Kundens momsregistreringsnummer statistics.service.api_version M Sträng WDR 2.0 statistics.remote.admin_e_mail M Sträng WDR E-post adressen till den ansvarige för kundens applikation M = obligatorisk (mandatory) M 1 = obligatorisk (mandatory) när data_list-array size > 1 granssnitt_schenker_ti-kvittens_31.doc 16(36)
Datum: 2008-05-20 Sida 17 av 36 5.3.1.2 Exempel URL för sökning med sändningsnummer Byt följande ut mot aktuella värden: <ApplikationsURL> <Användar_ID> <Användar_lösenord> <Referensnummer> <Kundens_momsregistreringsnummer> <Epost_adress> Exempel-URL för hämtning av 1 transportinstruktion som PDF: <ApplikationsURL>?request.service.action=select&request.service.method=get_transport_instructi on&request.format.mime=text/html&request.format.type=application/pdf&request.user.login_name= <Användar_ID>&request.user.password=<Användar_lösenord>&data_list.0.reference_number=<R eferensnummer>&data_list.0.reference_type=aas&data_list.0.is_include_delivery_note=false&syst em.statistics.remote.country_code=se&system.statistics.remote.send_data_format=hqf&system.sta tistics.remote.access_type=a&system.statistics.remote.application_name=test&system.statistics.u ser.organization_id=<kundens_momsregistreringsnummer>&system.statistics.user.language_code =sv&system.statistics.user.return_mime_format=xml&system.statistics.remote.send_data_format= web2&system.statistics.service.api_version=2.0&system.statistics.remote.admin_e_mail=<epost_a dress>&system.statistics.service.name=trpdoc Exempel-URL för hämtning av 1 transportinstruktion som XML: <ApplikationsURL>?request.service.action=select&request.service.method=get_transport_instructi on&request.format.mime=text/xml&request.format.type=text/xml&request.user.login_name=<anvä ndar_id>&request.user.password=<användar_lösenord>&data_list.0.reference_number=<referen snummer>&data_list.0.reference_type=aas&data_list.0.is_include_delivery_note=false&system.sta tistics.remote.country_code=se&system.statistics.remote.send_data_format=hqf&system.statistics. remote.access_type=a&system.statistics.remote.application_name=test&system.statistics.user.or ganization_id=<kundens_momsregistreringsnummer>&system.statistics.user.language_code=sv& system.statistics.user.return_mime_format=xml&system.statistics.remote.send_data_format=web2 &system.statistics.service.api_version=2.0&system.statistics.remote.admin_e_mail=<epost_adress >&system.statistics.service.name=trpdoc Exempel-URL för hämtning av 1 transportinstruktion som XML med PDF-sträng: <ApplikationsURL>?request.service.action=select&request.service.method=get_transport_instructi on&request.format.mime=text/xml&request.format.type=application/pdf&request.user.login_name= <Användar_ID>&request.user.password=<Användar_lösenord>&data_list.0.reference_number=<R eferensnummer>&data_list.0.reference_type=aas&data_list.0.is_include_delivery_note=false&syst em.statistics.remote.country_code=se&system.statistics.remote.send_data_format=hqf&system.sta tistics.remote.access_type=a&system.statistics.remote.application_name=test&system.statistics.u ser.organization_id=<kundens_momsregistreringsnummer>&system.statistics.user.language_code =sv&system.statistics.user.return_mime_format=xml&system.statistics.remote.send_data_format= granssnitt_schenker_ti-kvittens_31.doc 17(36)
Datum: 2008-05-20 Sida 18 av 36 web2&system.statistics.service.api_version=2.0&system.statistics.remote.admin_e_mail=<epost_a dress>&system.statistics.service.name=trpdoc granssnitt_schenker_ti-kvittens_31.doc 18(36)
Datum: 2008-05-20 Sida 19 av 36 5.3.2 Output Xml exemplet nedan illustrerar svaret när en instruktion är funnen. Om ingen fraktsedel är funnen kommer ett no hits meddelande att returneras. Se avsnitt XML output vid "no hits". Om ett valideringsfel uppträder kommer ett valideringsfelmeddelande att returneras. Se avsnitt XML output vid valideringsfel. Om något annat fel inträffar kommer ett generellt felmeddelande att returneras. Se avsnitt XML output vid fel. Felkoden beror på typen av fel (se WDR). Notera: även tjänstespecifika felmeddelanden kan returneras. Se avsnitt Service unika felmeddelanden. När request.format.type!=application/pdf (och data_list-array size == 1) <?xml version="1.0" encoding="iso-8859-1"?> <xml> <data_list> <data index= 0 > <transport_document_number>123456</transport_document_number> etc <package_details_list> <package_details index="n"> <package_identification> etc </package_details> </package_details_list> <additional_service_list> <additional_service index="0"> <additional_service_transport_code/> etc <additional_service_details_list> <additional_service_details index="n"> <additional_service_details/> </additional_service_details> </additional_service> </additional_service_list> <delivery_instructions_list> <delivery_instructions index="n"> <delivery_instructions/> </delivery_instructions> </delivery_instructions_list> <senders_instruction_to_carrier_list> <senders_instruction_to_carrier index="0"> granssnitt_schenker_ti-kvittens_31.doc 19(36)
Datum: 2008-05-20 Sida 20 av 36 <senders_instruction_to_carrier/> </senders_instruction_to_carrier> </senders_instruction_to_carrier_list> <information_for_consignee_list> <information_for_consignee index="0"> <information_for_consignee/> </information_for_consignee> </information_for_consignee_list> </data> </data_list> <system> <error> <id>0</id> </error> </system> <response> <service> <name>xxx</name> <version>1.0</version> </service> <data_list_count>1</data_list_count> </response> </xml> Komplett XML exempel: get_transport_instruction_response.xml När request.format.type=application/pdf <?xml version="1.0" encoding="iso-8859-1"?> <xml> <data_list> <data index= 0 > <transport_instruction_pdf> base64 encoded (multi page) pdf </transport_instruction_pdf </data> </data_list> <system> <error> <id>0</id> </error> </system> <response> granssnitt_schenker_ti-kvittens_31.doc 20(36)
Datum: 2008-05-20 Sida 21 av 36 <service> <name>xxx</name> <version>1.0</version> </service> <data_list_count>1</data_list_count> </response> </xml> 5.3.2.1 Parametrar Tabellen nedan definierar output hqf parametrar i data_list-listan. Lägg till prefixet data_list.n. till parametrarna. Namn Typ Standard Värde/Förklaring transport_document_number RFF-AAS Referens tilldelad åkaren eller hans agent av transportdokument acceptance_date Cons- DTM2005-143DE 2380 Acceptans datum/tid av godset [2126]. Datum då godset tas över av åkaren vid platsen för acceptans (CMR 4) object_update_date_time no standard Datum och tid när posten var uppdaterad i databasen. consignor_name Sträng (35) NAD 3035-CZ DE 3036 Namnet på avsändaren consignor_address Sträng (35) NAD 3035-CZ DE 3042:1 Adressen på avsändaren consignor_address2 Sträng (35) NAD 3035-CZ DE 3042:2 Adressen(del 2) på avsändaren consignor_address3 Adressen(del 3) på avsändaren consignor_zip_number Sträng (9) NAD 3035-CZ DE 3251 Avsändarens postnummer consignor_city_name Sträng (35) NAD 3035-CZ DE 3164 Avsändarens ortsnamn eller IATA-kod där den är lokaliserad. consignor_reference_number Sträng (17) RFF-1153- CU Kundordernummer. Referensnummer tilldelad av avsändaren till en specifik leverans för eget bruk eller för mottagaren. Förkortad som cu när den används som referensfunktions kod granssnitt_schenker_ti-kvittens_31.doc 21(36)
Datum: 2008-05-20 Sida 22 av 36 kvalificerare. consignor_identification consignor_pallet_identification consignor_telephone_number consignor_telefax_number consignee_name consignee_address consignee_address2 Sträng (17) Sträng (17) Sträng (35) Sträng (35) Sträng (35) NAD 3035-CZ DE 3039 NAD-CZ 3155-TE DE 3148 NAD 3035-CN DE 3036 NAD 3035-CN DE 3042:1 NAD 3035-CN DE 3042:2 Avsändarens identifierare Avsändarens pall identifierare Avsändarens telefonnummer Avsändarens faxnummer Namnet på mottagaren Mottagarens adress Mottagarens adress (del 2) consignee_address3 Mottagarens adress (del 3) consignee_zip_number consignee_city_name consignee_shipment_referenc e_number consignee_identification consignee_pallet_identification consignee_telephone_number consignee_telefax_number contract_condition_code freight_payer_identification consignment_eur_pallet_count Sträng (9) Sträng (35) Sträng (17) Sträng (17) NAD 3035-CN DE 3251 NAD 3035-CN DE 3164 NAD 3035-CN DE 3039 NAD-CN 3155-TE DE 3148 consignment_package_count Int (7) Cons-CNT 6069-11 DE 6066 Mottagarens postnummer Mottagarens ortsnamn eller IATA-kod där den är lokaliserad. Mottagarens sändningsnummer Mottagarens identifierare Mottagarens pallidentifiering Mottagarens telefonnummer Mottagarens faxnummer Produkten Identifiering av fraktbetalaren Antalet europapallar Totalt antal paket i sändningen granssnitt_schenker_ti-kvittens_31.doc 22(36)
Datum: 2008-05-20 Sida 23 av 36 consignment_package_count_ calculated Kalkylerat antal paket i sändningen consignment_gross_weight Num (9,3) Cons-CNT 6069 7 DE 6066 Unit 6411 Totala vikten i sändningen, inkluderat förpackningar, men exkluderat åkarens utrustning. consignment_gross_weight_ca lculated Totala kalkylerad vikt i sändningen, inkluderat förpackningar, men exkluderat åkarens utrustning. consignment_gross_weight_ob served_calculated Observerade kalkylerade vikten i sändningen, inkluderat förpackningar, men exkluderat åkarens utrustning. consignment_cube Num (7,3) Cons-CNT 6069-15 DE 6066 Unit 6411 Totala volymen (storlek eller mätning i tre dimensioner) på godset i sändningen. consignment_cube_calculated Totala kalkylerade volymen (storlek eller mätning i tre dimensioner) på godset i sändningen. consignment_cube_observed_ calculated Totala observerade kalkylerade volymen (storlek eller mätning i tre dimensioner) på godset i sändningen. consignment_loading_meters consignment_loading_meters_ calculated consignment_loading_meters_ observed_calculated consignment_item_count consignment_pallet_space is_waybill_available waybill_object_identification is_epod_available epod_object_identification package_details_list no standard Array _observed anger att det är det observerade/verkliga värdet till skillnad från det värde som angetts i edimeddelandet. _calculated anger att det är summan av de verkliga värdena för varje kolli. Lastat antal meter i sändningen. Kalkylerat lastat antal meter i sändningen. Observerat kalkylerat lastat antal meter i sändningen. Antal artiklar (styckegods) Antalet pallutrymme i sändningen Om en fraktsedel är tillgänglig. Har värdet 1 om det är så. Bildnyckeln till lagringssystemet. Om kvittens är tillgängligt Identifieraren av kvittens-objektet package_details Container Detaljer om alla paketen granssnitt_schenker_ti-kvittens_31.doc 23(36)
Datum: 2008-05-20 Sida 24 av 36 package_identification type_of_packages goods_description package_gross_weight package_gross_weight_observ ed package_cube package_cube_observed package_loading_meters package_loading_meters_obs erved additional_service_list Sträng (10) Sträng (35) Num (9,3) Num (9,3) Num (7,2) GID DE 7064 GID DE 7064 GID 6313-G DE 6314 Unit 6411 GID 6311-VOL DE 6314 Unit 6411 GID 6311-LMT DE 6314 Unit 6411 Array Identifieringen av ett paket Godstypen som text. Ex pall, box, behållare Beskrivning av godsartiklen Vikten av en godsartikel, inkluderat förpackning, men exkluderat åkarens utrustning Observerad vikt Volym (storlek eller mätning i tre dimensioner) av ett enstaka paket. Nytt! För att användas när paket detaljer implementeras. Observerad volym Längden i ett fordon, då hela bredden och höjden över längden behövs för gods artikeln. Observerad längd i fordonet additional_service Container Ytterligare tjänster additional_service_transport_c ode additional_service_contact_na me additional_service_contact_tel ephone_number additional_service_details_list additional_service_details additional_service_details delivery_instructions_list TSR CTA 3139 zzz Array Container TSR ASD E959 Array Transportkoden för de ytterligare tjänsterna Kontaktnamnet för en ytterligare tjänst Telefonnummer till en ytterligare tjänst Mera detaljer för den ytterligare tjänsten Detaljer för den ytterligare tjänsten delivery_instructions Container Leveransinstruktioner granssnitt_schenker_ti-kvittens_31.doc 24(36)
Datum: 2008-05-20 Sida 25 av 36 delivery_instructions DIN Leveransinstruktionen senders_instruction_to_carrier _list Array senders_instruction_to_carrier Container Sändarens instruktion till åkaren senders_instruction_to_carrier information_for_consignee_list Sträng (999*70 ) FTX 4451-SIC DE 4440 Array Sändarens instruktion till åkaren (fri text) information_for_consignee Container Information till mottagaren information_for_consignee ICN Information till mottagaren 5.4 get_waybill 5.4.1 Input 5.4.1.1 Parametrar I tabellen nedan definieras input hqf parametrar för fångst av fraktsedel (som base64 i pdf-kod inbäddat I xml) Name M Typ Standard Värde / Förklaring Request container. Lägg till prefixet request till parametrarna service.action M Sträng WDR Värde = select service.method M Sträng WDR Värde = get_waybill format.mime M Sträng WDR Önskat returformat. user.login_name M Sträng WDR Användar-ID som används för behörighetskontroll. user.password M Sträng WDR Användarens lösenord. Används för behörighetskontroll. Data container array. Lägg till prefixet data_list.n. till parametrarna. reference_number M Sträng RFF Referensnummer (sökargument) definierat genom referens funktions kodskvalificerare (referens_type) reference_type M Sträng RFF referens funktions kodskvalificerare (sökargument) Kod ger en särskild betydelse åt ett referensnummer (i reference_number ) Giltigt värde:: aas, zwoid AAS Transportdokumentnummer granssnitt_schenker_ti-kvittens_31.doc 25(36)
Datum: 2008-05-20 Sida 26 av 36 [1188] Referens tilldelad av rederi (carrier) eller dennes agent till transportdokumentet. Uppdrags-id IFTMBF: RFF+AAS IFTMIN: RFF+AAS FS: Fraktsedelsnummer TI: Sändningsnummer STE: Sändnings-ID/Consignment ID Statistiska parametrar. Lägg till prefixet system. till parametrarna. zwoid = inget standardfraktsedelsobjekt identifiering statistics.remote.country_code M Sträng WDR Landskod för kund, ex. se eller us statistics.user.language_code M Sträng WDR Språkkod för kunden, ex. sv_se statistics.remote.send_data_fo rmat M Sträng WDR Kundens sätt att skicka förfrågan (Request), xml or hqf (Http Query Format) statistics.remote.access_type M Sträng WDR Kundens typ av anrop, A (webbläsare) statistics.remote.application_n ame statistics.user.return_mime_for mat M Sträng WDR Namnet på den applikation hos kund som gör anropet.. M Sträng WDR Formatet som kunden önskar svara på.. text/plain, text/html or text/xml statistics.user.organization_id M Sträng WDR Kundens momsregistreringsnummer statistics.service.api_version M Sträng WDR 2.0 statistics.remote.admin_e_mail M Sträng WDR E-post adress till den som ansvarar för kundens applikation M = obligatoriskt granssnitt_schenker_ti-kvittens_31.doc 26(36)
Datum: 2008-05-20 Sida 27 av 36 5.4.1.2 Exempel URL för sökning med 1 sändningsnummer Byt följande ut mot aktuella värden: <ApplikationsURL> <Användar_ID> <Användar_lösenord> <Referensnummer> <Kundens_momsregistreringsnummer> <Epost_adress> URL för hämtning av 1 fraktsedel som XML: <ApplikationsURL>?request.service.action=select&request.service.method=get_waybill&request.fo rmat.mime=text/xml&request.user.login_name=<användar_id>&request.user.password=<använda r_lösenord>&data_list.0.reference_number=<referensnummer>&data_list.0.reference_type=aas& system.statistics.remote.country_code=se&system.statistics.remote.send_data_format=hqf&syste m.statistics.remote.access_type=a&system.statistics.remote.application_name=test&system.statis tics.user.organization_id=<kundens_momsregistreringsnummer>&system.statistics.user.language _code=sv&system.statistics.user.return_mime_format=xml&system.statistics.remote.send_data_for mat=web2&system.statistics.service.api_version=2.0&system.statistics.remote.admin_e_mail=<ep ost_adress>&system.statistics.service.name=trpdoc URL för hämtning av 1 fraktsedel som PDF: <ApplikationsURL>?request.service.action=select&request.service.method=get_waybill&request.fo rmat.mime=text/html&request.format.type=application/pdf&request.user.login_name=<användar_i D>&request.user.password=<Användar_lösenord>&data_list.0.reference_number=<Referensnum mer>&data_list.0.reference_type=aas&system.statistics.remote.country_code=se&system.statistics.remote.send_data_format=hqf&system.statistics.remote.access_type=a&system.statistics.remote. application_name=test&system.statistics.user.organization_id=<kundens_momsregistreringsnum mer>&system.statistics.user.language_code=sv&system.statistics.user.return_mime_format=xml&s ystem.statistics.remote.send_data_format=web2&system.statistics.service.api_version=2.0&syste m.statistics.remote.admin_e_mail=<epost_adress>&system.statistics.service.name=trpdoc granssnitt_schenker_ti-kvittens_31.doc 27(36)
Datum: 2008-05-20 Sida 28 av 36 5.4.1.3 Exempel URL för sökning med 2 sändningsnummer Byt följande ut mot aktuella värden: <ApplikationsURL> <Användar_ID> <Användar_lösenord> <Referensnummer_1> <Referensnummer_2> <Kundens_momsregistreringsnummer> <E_postadress> Exempel-URL för hämtning av 2 fraktsedlar som XML: <ApplikationsURL>?request.service.action=select&request.service.method=get_waybill&request.fo rmat.mime=text/xml&request.user.login_name=<användar_id>&request.user.password=<använda r_lösenord>&data_list.0.reference_number=<referensnummer_1>&data_list.0.reference_type=aas &data_list.1.reference_number=<referensnummer_2>&data_list.1.reference_type=aas&system.st atistics.remote.country_code=se&system.statistics.remote.send_data_format=hqf&system.statistic s.remote.access_type=a&system.statistics.remote.application_name=test&system.statistics.user. organization_id=<kundens_momsregistreringsnummer>&system.statistics.user.language_code=sv &system.statistics.user.return_mime_format=xml&system.statistics.remote.send_data_format=web 2&system.statistics.service.api_version=2.0&system.statistics.remote.admin_e_mail=<E_postadres s>&system.statistics.service.name=trpdoc Exempel-URL för hämtning av 2 fraktsedlar som PDF: <ApplikationsURL>?request.service.action=select&request.service.method=get_waybill&request.fo rmat.mime=text/html&request.format.type=application/pdf&request.user.login_name=<användar_i D>&request.user.password=<Användar_lösenord>&data_list.0.reference_number=<Referensnum mer_1>&data_list.0.reference_type=aas&data_list.1.reference_number=<referensnummer_2>&da ta_list.1.reference_type=aas&system.statistics.remote.country_code=se&system.statistics.remote. send_data_format=hqf&system.statistics.remote.access_type=a&system.statistics.remote.applicati on_name=test&system.statistics.user.organization_id=<kundens_momsregistreringsnummer>&sy stem.statistics.user.language_code=sv&system.statistics.user.return_mime_format=xml&system.st atistics.remote.send_data_format=web2&system.statistics.service.api_version=2.0&system.statisti cs.remote.admin_e_mail=<e_postadress>&system.statistics.service.name=trpdoc granssnitt_schenker_ti-kvittens_31.doc 28(36)
Datum: 2008-05-20 Sida 29 av 36 5.4.2 Output Xml exemplet nedan illustrerar svar då en fraktsedel hittats. Om inga fraktsedlar hittas, returneras ett no hits -meddelande. Se sektion Xml output at no hits. Om ett valideringsfel sker vid uppstart returneras ett valideringsfelmeddelande. Se avsnitt Xml output vid valideringsfel. Valideringsfelkoder beror på typ av fel (se WDR) Om andra typer av fel inträffar returneras ett generellt felmeddelande. Se avsnitt Xml output vid fel. Typ av felkod beror på typ av fel (Se WDR). Notera även tjänstespecifika felmeddelande kan returneras. Se Unika felkoder hos tjänsten (service). <?xml version="1.0" encoding="iso-8859-1"?> <xml> <data_list> <data index= 0 > <waybill_pdf> base64 encoded (multi page) pdf </waybill_pdf> </data> </data_list> <system> <error> <id>0</id> </error> </system> <response> <service> <name>xxx</name> <version>1.0</version> </service> <data_list_count>1</data_list_count> </response> </xml> 5.5 get_epod 5.5.1 Input 5.5.1.1 Parametrar I tabellen nedan definieras input hqf parametrar för att fånga en enskild fraktsedel (as base64 encoded pdf embedded in xml). granssnitt_schenker_ti-kvittens_31.doc 29(36)
Datum: 2008-05-20 Sida 30 av 36 Namn M Typ Standard Värde / Förklaring Request container. Lägg till prefix request. till parametrarna. service.action M Sträng WDR Värde = select service.method M Sträng WDR Värde = get_epod format.mime M Sträng WDR Förväntat retur format. user.login_name M Sträng WDR Användar-ID som används för behörighetskontroll. user.password M Sträng WDR Användarens lösenord. Används för behörighetskontroll. Data container array. Lägg till prefix data_list.n. till parametrarna. reference_number M Sträng RFF Referensnummer (Sökargument) definierad genom en referens funktion kodskvalificerare (reference_type). reference_type M Sträng RFF Referens funktions kodskvalificerare (sökargument). Kod ges en särskild innebörd till ett referensnummer (sent in reference_number ). Godkänt värde: aas, zepoid, cw. AAS Transportdokumentsnummer [1188] Referens tilldelad Referens tilldelad av rederi (carrier) eller dennes agent till transportdokumentet Uppdrags-id IFTMBF: RFF+AAS IFTMIN: RFF+AAS FS: Fraktsedelsnummer TI: Sändningsnummer STE: Sändnings-ID/Consignment ID zepoid = icke-standard kvittens objektsidentifiering Statistiska parametrar. Lägg till prefix system. till parametrarna. statistics.remote.country_code M Sträng WDR Kundens landskod, ex. se eller us statistics.user.language_code M Sträng WDR Kundens språkkod, ex. sv_se statistics.remote.send_data_fo rmat M Sträng WDR Kundens sätt att sända förfrågan, xml eller hqf (Http Query Format) statistics.remote.access_type M Sträng WDR Kundens typ av anrop, A (webbläsare) statistics.remote.application_n ame statistics.user.return_mime_for mat M Sträng WDR Namnet på den applikation hos kund som gör anropet. M Sträng WDR Formatet som kunden önskar svara på. text/plain, text/html or text/xml granssnitt_schenker_ti-kvittens_31.doc 30(36)
Datum: 2008-05-20 Sida 31 av 36 statistics.user.organization_id M Sträng WDR Kundens momsregistreringsnummer statistics.service.api_version M Sträng WDR 2.0 statistics.remote.admin_e_mail M Sträng WDR E-postadress till den som ansvarar för kundens applikation M = Obligatoriskt (mandatory) granssnitt_schenker_ti-kvittens_31.doc 31(36)
Datum: 2008-05-20 Sida 32 av 36 5.5.1.2 Exempel URL för sökning med sändningsnummer Byt följande ut mot aktuella värden: <ApplikationsURL> <Användar_ID> <Användar_lösenord> <Referensnummer> <Kundens_momsregistreringsnummer> <E_postadress> Exempel-URL för hämtning av 1 kvittens som XML: <ApplikationsURL>?request.service.action=select&request.service.method=get_epod&request.for mat.mime=text/xml&request.user.login_name=<användar_id>&request.user.password=<användar _lösenord>&data_list.0.reference_number=<referensnummer>&data_list.0.reference_type=aas&s ystem.statistics.remote.country_code=se&system.statistics.remote.send_data_format=hqf&system. statistics.remote.access_type=a&system.statistics.remote.application_name=test&system.statistic s.user.organization_id=<kundens_momsregistreringsnummer>&system.statistics.user.language_c ode=sv&system.statistics.user.return_mime_format=xml&system.statistics.remote.send_data_form at=web2&system.statistics.service.api_version=2.0&system.statistics.remote.admin_e_mail=<e_po stadress>&system.statistics.service.name=trpdoc Exempel-URL för hämtning av 1 kvittens som PDF: <ApplikationsURL>?request.service.action=select&request.service.method=get_epod&request.for mat.mime=text/html&request.format.type=application/pdf&request.user.login_name=<användar_id >&request.user.password=<användar_lösenord>&data_list.0.reference_number=<referensnumm er>&data_list.0.reference_type=aas&system.statistics.remote.country_code=se&system.statistics.r emote.send_data_format=hqf&system.statistics.remote.access_type=a&system.statistics.remote.a pplication_name=test&system.statistics.user.organization_id=<kundens_momsregistreringsnumm er>&system.statistics.user.language_code=sv&system.statistics.user.return_mime_format=xml&sy stem.statistics.remote.send_data_format=web2&system.statistics.service.api_version=2.0&system. statistics.remote.admin_e_mail=<e_postadress>&system.statistics.service.name=trpdoc 5.5.1.3 Exempel URL för sökning med kolli-id Byt följande ut mot aktuella värden: <ApplikationsURL> <Användar_ID> <Användar_lösenord> <Kolli-ID> <Kundens_momsregistreringsnummer> <E_postadress> granssnitt_schenker_ti-kvittens_31.doc 32(36)
Datum: 2008-05-20 Sida 33 av 36 Exempel-URL för hämtning av 1 kvittens som XML: <ApplikationsURL>?request.service.action=select&request.service.method=get_epod&request.for mat.mime=text/xml&request.user.login_name=<användar_id>&request.user.password=<användar _lösenord>&data_list.0.reference_number=<kolliid>&data_list.0.reference_type=cw&system.statis tics.remote.country_code=se&system.statistics.remote.send_data_format=hqf&system.statistics.re mote.access_type=a&system.statistics.remote.application_name=test&system.statistics.user.orga nization_id=<kundens_momsregistreringsnummer>&system.statistics.user.language_code=sv&sy stem.statistics.user.return_mime_format=xml&system.statistics.remote.send_data_format=web2&s ystem.statistics.service.api_version=2.0&system.statistics.remote.admin_e_mail=<e_postadress> &system.statistics.service.name=trpdoc Exempel-URL för hämtning av 1 kvittens som PDF: <ApplikationsURL>?request.service.action=select&request.service.method=get_epod&request.for mat.mime=text/html&request.format.type=application/pdf&&request.user.login_name=<användar_i D>&request.user.password=<Användar_lösenord>&data_list.0.reference_number=<KolliID>&data _list.0.reference_type=cw&system.statistics.remote.country_code=se&system.statistics.remote.sen d_data_format=hqf&system.statistics.remote.access_type=a&system.statistics.remote.application_ name=test&system.statistics.user.organization_id=<kundens_momsregistreringsnummer>&syste m.statistics.user.language_code=sv&system.statistics.user.return_mime_format=xml&system.statis tics.remote.send_data_format=web2&system.statistics.service.api_version=2.0&system.statistics.r emote.admin_e_mail=<e_postadress>&system.statistics.service.name=trpdoc granssnitt_schenker_ti-kvittens_31.doc 33(36)
Datum: 2008-05-20 Sida 34 av 36 5.5.2 Output Xml exemplet nedan illustrerar svar då en kvittens hittats. Om inga fraktsedlar hittas, returneras ett no hits -meddelande. Se sektion Xml output vid no hits. Om ett valideringsfel sker vid uppstart returneras ett valideringsfelmeddelande. Se avsnitt Xml output vid valideringsfel. Valideringsfelkoder beror på typ av fel (se WDR) Om andra typer av fel inträffar returneras ett generellt felmeddelande. Se avsnitt Xml output vid fel. Typ av felkod beror på typ av fel (Se WDR). Notera även tjänstespecifika felmeddelande kan returneras. Se Unika felkoder hos tjänsten (service). <?xml version="1.0" encoding="iso-8859-1"?> <xml> <data_list> <data index= 0 > <proof_of_delivery_pdf> base64 encoded (multi page) pdf </proof_of_delivery_pdf> </data> </data_list> <system> <error> <id>0</id> </error> </system> <response> <service> <name>xxx</name> <version>1.0</version> </service> <data_list_count>1</data_list_count> </response> </xml> 5.5.2.1 Parametrar I tabellen nedan definieras output hqf parameters i data_list-array. Lägg till prefix data_list.n. till parametrarna. Namn Typ Standard Värde / Förklaring proof_of_delivery_pdf Base64 encoded binary pdf Kvittens som PDF. granssnitt_schenker_ti-kvittens_31.doc 34(36)
Datum: 2008-05-20 Sida 35 av 36 5.6 Xml output vid no hits Då en vald händelse inte hittar något att returnera (inget fel men inte heller någon träff) i betydelsen leveranssökning, returneras ett standard no hit -meddelande (definierad I WDR). Xmlversionen av detta meddelande återfinns nedan: <?xml version="1.0" encoding="iso-8859-1"?> <xml> <system> <error> <id>0</id> </error> </system> <response> <service> <name>xxx</name> <version>1.0</version> </service> <data_list_count>0</data_list_count> </response> </xml> 5.7 Xml output vid fel (error) Då ett fel (annat än valideringsfel) uppstår, returneras ett standardfelmeddelande (definierat I WDR) Strukturen är alltid densamma, enbart fel kod/meddelande skiljer (felkoder/meddelande hittas i WDR). Ett exempel hittas nedan: <?xml version="1.0" encoding="iso-8859-1"?> <xml> <system> <error> <id>507</id> </error> </system> <response> <service> <name>xxx</name> <version>1.0</version> </service> <data_list_count>0</data_list_count> </response> </xml> granssnitt_schenker_ti-kvittens_31.doc 35(36)
Datum: 2008-05-20 Sida 36 av 36 5.8 Xml output vid valideringsfel Då tjänsten ges ett felaktigt input returneras ett valdideringsfelmeddelande. Strukturen hos meddelandet är alltid detsamma (definieras i WDR). Ett xml-exempel ges nedan (de obligatoriska parametrarna request.service.action och request.service.method saknas i request): <?xml version="1.0" encoding="iso-8859-1"?> <xml> <system> <error> <id>210</id> <message>invalid data</message> <validation_list> <validation index="0"> <field_name>request.service.action</field_name> <old_value /> <error> <id>304</id> </error> </validation> <validation index="1"> <field_name>request.service.method </field_name> <old_value /> <error> <id>304</id> </error> </validation> </validation_list> </error> </system> <response> <service> <name>xxx</name> <version>1.0</version> </service> <data_list_count>0</data_list_count> </response> </xml> 5.9 Unika felkoder hos tjänsten (service) system.error.service.error.id/message är nya fält i WDR v 2.2. De är till för applikationsspecifika koder. Inte enbart felkoder, utan även varningar och dylikt. Giltiga värden för dessa fält är ej specificerade i WDR:en, utan specificerade unikt för varje tjänst. granssnitt_schenker_ti-kvittens_31.doc 36(36)