Tracking Gränssnittsdokumentation. Version 1.5

Transkript

1 Tracking Gränssnittsdokumentation Version 1.5

2 Datum: Sida 2 av 9 Revisionshistorik Version Datum Kommentarer Dokumentet skapat Uppdaterat med ny URL samt krav på behörighetskonto. Nya fält i request: request.user.id och request.user.password Nya fält i response: status_event_time, estimated_delivery_date, agreed_delivery_date. Nytt värde I request.service, CTTSTYPEA_PLUGIN Uppdaterat med ny URL Lagt till info om att tjänsten är behörighetsskyddad Lagt till HTML-förfrågan Diverse ändringar/rättningar/tillägg av 1.4

3 Datum: Sida 3 av 9 INNEHÅLLSFÖRTECKNING REVISIONSHISTORIK TRACKING GENERELLA VARIABLER INFORMATION OM EN SÄNDNING (WAYBILL) Request anropa Tracking Response - svarsmeddelande EDIFACT STANDARDVARIABLER HÄNDELSEKODER, -TYPER OCH -BESKRIVNINGAR... 9

4 Datum: Sida 4 av 9 1 Tracking Tracking är en tjänst som kräver behörighet. Ansökan görs via formuläret: Tjänsten ger kunder möjlighet att koppla sig till Schenkers system och alltid erhålla uppdaterad och korrekt tracking-information. Gränssnittet ger användaren möjlighet att söka sändningsinformation på sina sändningar utifrån sändningsnummer eller valda referenser. I dokumentationen finns körklara exempel. Klipp ut dem och klistra in direkt i din webbläsares adressfönster för att få en överblick av möjligheterna. Tjänsten kan anropas med hjälp av httprequest via HQF (Http Query Format, textformat) och kan returneras på tre sätt: i HTML, XML eller XMLEdifactformat. Exempel på anrop respektive svar finns i dokumentet. Figur 1 Flödesskiss över tjänstens anrop För mer övergripande information om hur Schenkers e-tjänster är uppbyggda och anropas rekommenderas läsning i vårt separata introduktionsdokument. URL att anropa:

5 Datum: Sida 5 av 9 2 Generella variabler De generella variablerna är till för att administrera kommunikationen och är gemensamma för all kommunikation. Rubriken O i tabellerna står för obligatoriskt fält. 3 Information om en sändning (waybill) 3.1 Request anropa Tracking Innehåller information till tjänsten. Efterfrågar information om godsrörelser på sändningsnummer. Namn O Ty p Standard Längd Förklaring request.service O Värde: CTTSTYPEA_PLUGIN request.method O Värde: search (används för sändningsöversikt tillsammans med reference_type *SHP, *CGN, *FF, *DWB) Värde: detail (används för detaljerad information tillsammans med reference_type *FF eller *COR) request.format O Värde: html används för html-svar Värde: xml används för kompakta xmltaggar Värde: xmledifact används för EDIFACT standardtaggar reference_type 4 Värde: *SHP Avsändarens referens Värde: *CGN Mottagarens referens Värde: *FF Schenkers referens Värde: *DWB Sändningsnummer Värde: *COR Kundorder referens Värde: *PKG Kolli-ID reference_number 240 Sökt referensvärde request.user.id O 10 Obligatoriskt användar-id för CTTSTYPEA_PLUGIN request. request.user.password O Obligatoriskt lösenord för CTTSTYPEA_PLUGIN request. country 3 ISO landskod language 2 ISO språkkod

6 Datum: Sida 6 av 9 Exempel på sökningar med olika reference_type: Fråga på sändningsnummer, format xmledifact (Shipment number) method=search&request.format=xmledifact&reference_type=*dwb&reference_number= &language=sv&country=SE&request.user.id=Användar-ID&request.user.password=lösenord Fråga på sändningsnummer, format html (Shipment number) method=search&request.format=html&reference_type=*dwb&reference_number= &l anguage=sv&country=se&request.user.id=användar-id&request.user.password=lösenord Fråga på avsändarens referens (Shipper reference) method=search&request.format=xmledifact&reference_type=*shp&reference_number=a&langua ge=sv&country=se&request.user.id=användar-id&request.user.password=lösenord Fråga på Schenkers referens (Freight forwarder s reference) method=detail&request.format=xmledifact&reference_type=*ff&reference_number=tku &language=sv&country=SE&request.user.id=Användar-ID&request.user.password=lösenord Fråga på kundorder referens (Client order search) method=detail&request.format=xmledifact&reference_type=*cor&reference_number= &language=sv&country=SE&request.user.id=Användar-ID&request.user.password=lösenord 3.2 Response - svarsmeddelande Innehåller information från tjänsten. Xml response variablerna är likadana för enkla och multipla träffar, förutom att alla händelser returneras vid enkel träff, men vid multipla träffar returneras bara den senaste händelsen. Nedan visas en lista på de xml-variabler som används i Tracking för de bägge formaten xml och xmledifact. request.format=xmledifact - <consignment> <freight_forwarder_reference_number>xxxx</freight_forwarder_reference_number> <domestic_waybill_number>xxxx</domestic_waybill_number> < >xxxx</ > <departure_location /> <departure_postcode /> <destination_location /> <destination_postcode />

7 Datum: Sida 7 av 9 <place_of_departure>xxxx</place_of_departure> <country_of_departure>xxxx</country_of_departure> <place_of_destination>xxxx</place_of_destination> <country_of_destination>xxxx</country_of_destination> <number_of_packages>xxxx</number_of_packages> <weight>xxxx</weight> <estimated_delivery_date>yyyymmdd</estimated_delivery_date> <agreed_delivery_date /> - <status_event_list> - <status_event> <status_event_text>xxxxl</status_event_text> <status_event_type>xxxx</status_event_type> <status_event_code>xxx</status_event_code> <status_event_place_name>xxxxxx</status_event_place_name> <status_event_place_code>xxx</status_event_place_code> <status_event_country_code>xx</status_event_country_code> <status_event_country_name>xxxx</status_event_country_name> <status_event_date>yyyy-mm-dd</status_event_date> <status_event_time>hh:mm</status_event_time> </status_event> - <status_event> </status_event> </status_event_list> </consignment> - <request> <reference_type>xxxx</reference_type> <reference_number>xxxxxxxxxx</reference_number> </request> <record_count>x</record_count> </xml>

8 Datum: Sida 8 av 9 request.format=html Nedan visas ett html-svar för enkel träff. Nedan visas ett html-svar för multipel träff.

9 Datum: Sida 9 av 9 4 Edifact standardvariabler Variabelnamn Standard Förklaring freight_forwarder_reference RFF-1153-FF Schenker s referens domestic_waybill_number RFF-1153-AAM Sändningsnummer consignor_reference_number RFF-1153-CU Avsändarens referens consignee_reference_number RFF-1153-CN Mottagarens referens Schenker kontakt e-post status_event_list status_event STS-C555 status_event_text STS-C Händelsebeskrivning status_event_type Händelsetyp status_event_code STS-C Händelsekod status_event_place_name LOC-3225 Händelse ort status_event_place_code LOC-ZZZ Händelse ortkod status_event_country_name NAD-3207-CA Händelse land status_event_country_code NAD-3229-CA Händelse landskod status_event_date DTM Händelse datum status_event_time Händelse tid reference_type Sök referens typ reference_number Sök referens värde record_count Antal träffar 5 Händelsekoder, -typer och -beskrivningar Event Type Event Code Event Description *001 *800 Booked DOMO COL Collected DOMO DET Delivered to terminal by shipper *101 *800 Departed *101 *950 Arrived DOMD DIS To consignee s disposal DOMD PUP Picked up by consignee DOMD DOT Out for delivery DOMD DLV Delivered DOMD NDL Not delivered