1 Generella variabler

(1)

Gränssnitt Turlista

1 Generella variabler

De generella variablerna är till för för att administrera kommunikationen och är gemensamma för all kommunikation.

De tre är: request, response, system

Den fjärde är data_list som är en vektor av information med själva meddelanden.

Rubriken ’O’ står för obligatoriskt fält.

1.1 Request

Innehåller information till tjänsten. I fältet obligatoriskt står det ett ’A’. Detta fält är obligatoriskt.

Addera prefixet ’request.’ till variablerna.

Namn O Typ Standard Längd Förklaring

service.action O String WDR 10 Värde ’select’

service.method O String WDR 10 Värde ’calculate’

user.name String WDR 30 Användarnamn

user.e_mail String WDR 40 Användarens epost-adress

1.2 Response

Innehåller information från tjänsten..

Addera prefixet ’response.’ till variablerna.

service.name O String WDR - Namn på tjänsten service.version O String WDR - Versionsnummer (1.0) data_list_count O Int WDR - Antal i data_list

(2)

1.3 System

Innehåller felkod från systemet. error.id = 0 betyder OK.

Innehåller statistikvariabler till systemet.

Addera prefixet ’system.’ till variablerna.

error.id O Int WDR 5 Felkod

error.message String WDR 100 Felmeddelande statistics.remote.ip_address O String WDR - Klientens ip-adress

statistics.remote.country_code O String WDR - Landskod för klient, ex. ’se’ eller ’us’

statistics.remote.send_data_format O String WDR - Klientens sätt att skicka sin Request, ’xml’ eller

’hqf’ (Http Query Format) statistics.remote.access_type O String WDR - Klientens anropstyp, ’A’ (browser) statistics.remote.application_name O String WDR - Klientens sida/modul som anropar statistics.remote.admin_e_mail O String WDR - E-mail till adm. för klient

statistics.user.return_mime_format O String WDR - Klientens önskade svarsformat, ’text/plain’,

’text/html’ eller ’text/xml’

statistics.user.organization_id O String WDR - Klientens organisationsnummer statistics.user.language_code O String WDR - Språkkod för klient, ex. ’sv_se’

statistics.service.api_version O String WDR - Gränssnittsversion, ex ’2.0’

statistics.service.name O String WDR - Namn på applikation som anropas, ex.

’Turlista_002’

statistics.request.service.action O String WDR - ’select’

statistics.request.service.method O String WDR - ’calculate’

(3)

2 Meddelande Hämta Turlista

Innehåller information om turlisteförfrågan..

Addera prefixet ’data_list.0.’ till variablerna.

2.1 Anrop

I fältet Obligatoriskt finns två fält markerade med ett ’A’. Ett av dessa måste anges. Om

’departure_weekday_number’ anges, så beräknas 'departure_date’ utifrån detta och dagens datum.

Anges båda, är det 'departure_date’ som gäller.

contract_condition_code O String TSR 4065-PAR 4065-COM 4065-BUD

3 Produktnamn: Välj en av PAR = Parcel

COM = Comfort BUD = Budget departure_place_name O String TDT

3227-5 DE 3224

13 Avsändningsort)

destination_place_name O String TDT 3227-8 DE 3224

13 Mottagarort

departure_date A Date TDT 2005-133 DE 2380

8 Avgångsdatum

departure_weekday_number A Int TDT 2005-133 DE 2380 Form 813

1 Avgångsdag.

Kod 813 anger att datumformatet är veckodag.

Måndag =1, tisdag = 2, etc departure_zip_code O Int TDT

3227-5 DE 3225 Unit 1131

5 Avsändningsort i postnummerformat. 5 siffror utan mellanslag.

destination_zip_code O Int TDT 3227-8 DE 3225 Unit 1131

5 Ankomstort i postnummerformat. 5 siffror utan mellanslag.

2.2 Svar

departure_place_name String TDT 3227-5 DE 3224

- Avsändningsort

destination_place_name String TDT 3227-8 DE 3224

- Mottagarort

departure_date Date TDT 2005-133 DE 2380

- Avgångsdatum

departure_carrier_office_number String NAD-CA 3139-TR DE 3413

- Kontorsnummer avgående kontor, max 4 siffror

departure_carrier_office_name String NAD-CA 3139-TR

- Avgående_kontors_namn

(4)

DE 3412 destination_carrier_office_number String NAD-CA

3139-TR DE 3413

- Ankommande kontorsnummer, max 4 siffror

destination_carrier_office_name String NAD-CA 3139-TR DE 3412

- Ankommande kontorsnamn

destination_weekday_number Int TDT 2005-132 DE 2380 Form 813

- Avser dag på destinationen baserat på acceptance_date (även beräknad)

Kod 813 anger att datumformatet är veckodag.

Måndag =1, tisdag = 2, etc departure_place_x_coordinate Int . - Avsändningsort-x-koordinat departure_place_y_coordinate Int - Avsändningsort-y-koordinat destination_place_x_coordinate Int - Mottagningsort-x-koordinat destination_place_y_coordinate Int - Mottagningsort-y-koordinat chargeable_distance Int QTY

6063 - 49

- Avstånd mellan orter för taxering (Km) is_express_possible Boole

an

TSR 7273=EXP

- Är express möjlig (1/0) Tilläggstjänst.

Kod är unik Schenker

calculate_list Array - Turlista per veckodag, 1 (måndag) – 5 (fredag) Dagen (index) avser avgående dag. Se 2.3

2.3 Svar Calculate_list

Detta är en vektor i ’data_list.0.’ med index 1-5 för avgångsdagarna måndag till fredag. Index 0 används ej.

Exempel:

Gods som avgår en tisdag(2) och anländer på torsdag(4) ger:

data_list.0.calculate_list.2.destination_weekday_number=4

Transport_workday_count Int QTY – 6063-77 DE 6060

- Antal dagar som transporten tar

Destination_weekday_number Int TDT 2005-132 DE 2380 Form 813

- Transport_ankommer veckodag,

Kod 813 anger att datumformatet är veckodag, 1 (måndag) – 5 (fredag)

Is_one_week_or_more Boole an

- 1 = om transporten tar en vecka eller mer (samma som transport_workday_count > 4),

0 = mindre än en vecka.

3 Versionshistorik

2.1 020610

Stöd för nya variabler data_list.0.departure_zip_code och data_list.0.destination_zip_code i anrop.

2.00 010816

Tillägg av statistikvariabler under ’system’.

1.40 000302

Korrigerat referenser i standardfältet 1.30 000112

(5)

Korrigerat enligt WDR

Ändrat request.service.type -> request.service.method

(6)

4 Exempel

Hämta Turlista Skara-Kiruna för produkten Comfort. Sökning med ortsnamn http://cgi.webtrp.com/cgi-bin/cgiwrap/w01btl/prod2/online/turlistan/delivery_time_table.pl?

data_list.0.contract_condition_code=COM

&data_list.0.departure_place_name=Skara

&data_list.0.destination_place_name=Kiruna

&data_list.0.departure_date=

&data_list.0.departure_weekday_number=1

&request.service.action=select

&request.service.method=schedule

&request.format.mime=text%2Fplain

&request.format.type=url_simple

&system.statistics.service.name=Turlista_002

&system.statistics.remote.ip_address=195.67.27.130

&system.statistics.service.api_version=2.0

&system.statistics.user.return_mime_format=html

&system.statistics.remote.send_data_format=web2

&system.statistics.user.organization_id=[ert organisationsnummer]

&system.statistics.user.language_code=sv

&system.statistics.remote.country_code=se

&system.statistics.remote.admin_e_mail=[er systemadministratörs e-post adress]

&system.statistics.remote.access_type=A

&system.statistics.remote.application_name=[er applikations namn varifrån requesten skickas]

För att returnera HTML, ändra request.format.mime=text%2Fhtml och request.format.type=full Hämta Turlista 43362-87052 för produkten Comfort. Sökning med postnummer

http://cgi.webtrp.com/cgi-bin/cgiwrap/w01btl/prod2/online/turlistan/delivery_time_table.pl?