Bussgods Web Service Spec RA3

8/8/2019 Bussgods Web Service Spec RA3

1/31

1/31

Webservice-grnssnittfrkommunikationmedBussgods

version1


2/31

2/31

Revisioner

Datum APIversion

Dokumentversion

Sign Revision

20090622 1 RA1 A Skapad.Skapatstrukturfrdokumentsamtdokumenteratgrundlggandefunktioner.

20090821 1 RA2 A Dokumenteratresterandefunktionersomskallvaramediversion1.

20090925 1 RA3 A


3/31

3/31

Innehllsfrteckning

INTRODUKTION............................................................................................................................................. 4

FLDEFRFUNKTIONSANROP...................................................................................................................... 5

BESKRIVNINGAVFUNKTIONER...................................................................................................................... 6

ANSLUTNINGSTEST.................................................................................................................................................. 6AUTENTISERING...................................................................................................................................................... 6

FunktionAuth_TicketAuth_Request_Ticket(string username,stringpassword)..........................................6

FunktionboolAuth_Check_Ticket(Auth_Ticketticket).................................................................................. 7

FunktionboolAuth_Free_Ticket(Auth_Ticketticket).................................................................................... 7

FUNKTIONER

RRANDE

STATIONER

.............................................................................................................................

8

FunktionData_ResultStations_List(Auth_Ticketticket)............................................................................... 8

FunktionstringStations_List_xml(AuthTicketticket).................................................................................... 8

FunktionData_ResultStations_List(Auth_Ticketticket,intCountyCode).....................................................8

FunktionstringStations_List_xml(Auth_Ticketticket,intcountyCode)........................................................9

FunktionData_ResultStation_Info(Auth_Ticketticket,intstationID).......................................................... 9

FunktionstringStation_Info_xml(stringticket,intStationID)....................................................................... 9

FUNKTIONERRRANDELN..................................................................................................................................... 10FunktionData_ResultCounties_List(AuthTicketticket)............................................................................... 10

FunktionstringCounties_List(string ticket)................................................................................................. 10

FunktionData_ResultCounty_Info(Auth_Ticketticket,intcountyCode)...................................................10

FunktionstringCounty_Info_xml(stringticket,intcountyCode)................................................................ 11

FUNKTIONERRRANDEFRAKTER.............................................................................................................................. 12FunktionData_ResultShipment_Info(Auth_Ticketticket,stringShipmentIDs).........................................12FunktionstringShipment_Info_xml(string ticket,stringShipmentIDs)......................................................12

FunktionFunction_ResultShipment_Add(Auth_Ticketticket,stringxmlData)..........................................12

BILAGA1.WSDL.......................................................................................................................................... 14

BILAGA2.KLASSERFRIN OCHUTDATA.................................................................................................... 26

FUNCTION_RESULT............................................................................................................................................... 26.NETklass.................................................................................................................................................... 26

Xmlformat.................................................................................................................................................. 26

AUTH_TICKET....................................................................................................................................................... 26.NETklass.................................................................................................................................................... 26

XMLformat

.................................................................................................................................................

26

DATA_RESULT...................................................................................................................................................... 27.NETklass.................................................................................................................................................... 27

XMLformat................................................................................................................................................. 28

AUTH_RESULT...................................................................................................................................................... 28.NETklass.................................................................................................................................................... 28

XMLformat................................................................................................................................................. 28

BILAGAX.DATAFLTFRNFUNKTIONERRRANDESTATIONER.................................................................. 29

BILAGA3.STATUSKODER............................................................................................................................. 30

BILAGA4.LNSKODER................................................................................................................................ 31


4/31

4/31

Introduktion

Dettadokumentbeskriverettwebservicegrnssnitt(API)somBussgodsSverigeek.frening

ppnarmotexternaanvndare.

GrnssnittetrutvecklatiMicrosoft.NETochkananvndasfrattfutinformationom

Bussgodsstationer,frakter,priser,m.m.

Idefalldatareturnerasurfunktionermed.NETspecifikaklasserharenextrafunktionlagts

tillsomreturnerarmotsvarandedatasomrenxml.

Allkommunikation

sker

med

SOAP

1.1

mot

https://apiv1.bussgods.se


5/31

5/31

Fldefrfunktionsanrop

Begr inloggningsticketAuth_Request_Ticket

AnropaFunktioner medmottagen ticket

Lagra ticket(klientsida)

Avallokera ticketAuth_Free_Ticket

Klar?

Nej

Ja


6/31

6/31

Beskrivningavfunktioner.

AnslutningstestFunktionstringTestConnection()

FunktionenTestConnection()kananvndasfrattprovaanslutningenmotbussgodssystem.

Funktionenreturneraraktuelltklockslagochdatum.

AutentiseringFrattkunnaanvndagrnssnittetsmsteklientsystemetverifierasig/loggainmot

bussgodssystem.

Verifiering/inloggningskergenomattklientsystemetskickarsittanvndarnamnoch

lsenordienbegranomattfloggain.

Systemetreturnerarettobjektmedinformationominloggningen.

AnvndarnamnochlsenordkvitterasutfrnBussgods.

FunktionAuth_Ticket

Auth_Request_Ticket(string

username,

string

password)ReturnerarenAuthticketfrspecificeratanvndarnamn/lsenord.

Indata

Namn Typ Beskrivning

Username String Anvndarnamnerhlletfrnbussgods

Password String Lsenorderhlletfrnbussgods

SOAPmeddelandefrindata

Utdata

Typ Beskrivning

Auth_Ticket ObjektavklassenAuth_Ticketmedinformationomerhllenticket

SOAPmeddelandefrutdata


7/31

7/31

FunktionboolAuth_Check_Ticket(Auth_Ticketticket)Kontrolleraromeninloggningsticketfortfarandergiltig.

Indata


Ticket Auth_Ticket Inloggningsticketsomskallkontrolleras.ErhllenviafunktionenAuth_Request_Ticket

Utdata

Typ Beskrivning

Bool

TRUE

Ticketen

r

godknd

att

anvndas

FALSETicketenkanejanvndas.

FunktionboolAuth_Free_Ticket(Auth_Ticketticket)AvallokerarenAuthticketfrnsystemet.

Klientsystemetloggasut.

Indata


Ticket

Auth_Ticket

Inloggningsticketsom

skall

avallokeras.

Erhllen

via

funktionenAuth_Request_Ticket

Utdata

Typ Beskrivning

Bool TRUE

FALSETicketenkanejavallokeras.


8/31


9/31

9/31

FunktionstringStations_List_xml(Auth_Ticketticket,intcountyCode)Listarallastationeriettvisstlnsamtallstationsdata.

Returneraren

strng

med

innehllet

som

XML.

Ejimplementerativersion1.

FunktionData_ResultStation_Info(Auth_Ticketticket,intstationID)Hmtarinformationomenvissstation.

Indata


Ticket Auth_Ticket Inloggningsticketsomrallokeradfrklientsystemet.ErhllenviafunktionenAuth_Request_Ticket.

stationsID Int Integersomrepresenterardetstationsnummerfrvilketfunktionenskallreturneradatafr.

Utdata

Typ Beskrivning

Data_Result ObjektavklassenData_Resultsominnehllersvarfrnfunktionen.Sebilagax

FunktionstringStation_Info_xml(stringticket,intStationID)Hmtarinformationomenvissstation.

ReturnerarinnehlletsomenstrngavXML.



10/31

10/31

FunktionerrrandelnFunktionData_ResultCounties_List(AuthTicketticket)Listarallalnochalldatafrlnen.

Indata


Ticket Auth_Ticket Inloggningsticketsomrallokeradfrklientsystemet.ErhllenviafunktionenAuth_Request_Ticket.

Utdata

Typ Beskrivning

Data_Result ObjektavklassenData_Resultsominnehllersvarfrnfunktionen.Se

bilagax

FunktionstringCounties_List(stringticket)Listarallalnochalldatafrlnen.

Returnerarresultatet

som

en

strng

med

XML.


FunktionData_ResultCounty_Info(Auth_Ticketticket,intcountyCode)Listaralldatafrvaltln.

Indata


Ticket Auth_Ticket Inloggningsticketsomrallokeradfrklientsystemet.

ErhllenviafunktionenAuth_Request_Ticket.

CountyCode Int Integersomrepresenterardenlnskodfrvilkenfunktionenskallreturneradatafr.

Utdata

Typ Beskrivning

Data_ResultObjekt

av

klassen

Data_Result

som

innehller

svar

frn

funktionen.

Se

bilagax


11/31

11/31

FunktionstringCounty_Info_xml(stringticket,intcountyCode)Listaralldatafrvaltln.

Returnerarresultatet

som

en

strng

med

XML.



12/31

12/31

FunktionerrrandefrakterFunktionData_ResultShipment_Info(Auth_Ticketticket,stringShipmentIDs)Listarstatusfrenfrakt(enl.webbensskfunktion).

Indata




shipmentIDs

String

Strnginnehllande

den

frakt

som

funktionen

skall

returneradatafr.

Utdata

Typ Beskrivning

Data_Result ObjektavklassenData_Resultsominnehllersvarfrnfunktionen.Se

bilagax

FunktionstringShipment_Info_xml(stringticket,stringShipmentIDs)Listarstatusfrenfrakt(enl.webbensskfunktion).

ReturnerarenstrngmedresultatetsomXML.

FunktionFunction_ResultShipment_Add(Auth_Ticketticket,stringxmlData)LggertillspecificeradfraktmeddatafrnparameternxmlData.

Indata




xmlData String Datafrdenfraktsomskalllggastillenl.separat

dokumentation.

Utdata

Typ Beskrivning

Function_Result ObjektavklassenFunction_Resultsominnehllersvarfrnfunktionen.


13/31

13/31

Sebilagax

Ej

implementerat

i

version

1.


14/31

14/31

Bilaga1.WSDL

AktuellWSDL

(Web

Service

Definition

Language)

r

bifogat

hr

som

referens.

EnfilmedWSDL'enfsavBussgodsvidtecknandetavavtalomtillgngtillgrnssnittet.

-

-

-

-

-

-

-

-

-

-

-

-

-

-


15/31

15/31

- -

-

-

-

-

-

-

-

-

-

- -

-

-


16/31

16/31

-

-

-

-

-

-

-

-

-

-

-

-

-

-

- -

-

-

-

-

-


17/31

17/31

-

-

-

-

-

-

-

-

-

-

-

-

-

-

-


18/31

18/31

-

-

-

-

-

-

-

-

-

-

-

-

-

-

-


19/31

19/31

-

-

-

-

-

-

-

-

-

-

-

-

-

-


20/31

20/31

-

-

-

-

-

-

-

-

-

-

-

-


21/31

21/31

-

-

-

-

-

-

-

-

-

-

-

-

-

-


22/31

22/31

-

-

-

-

-

-

-

-

-

-

-

-

-


23/31

23/31

-

-

-

-

-

-

-

-

-

-

-

-

-

-

-


24/31

24/31

-

-

-

-

-

-

-

-

-

-

-

-

-


25/31

25/31

-

-

-

-

-

-

-

-

-

-

-

-


26/31

26/31

Bilaga2.Klasserfrin- ochutdata.

Function_Result.NET-klass

KlassenFunction_Resultinnehller.

Egenskap Datatyp Beskrivning

resultCode Int Statuskod

resultInfo String Statusinfo

Xml-format

Auth_Ticket.NET

-

klass

KlassenAuth_Ticketinnehller:


TicketID GUID GUIDsomrefererartillaktuellloginticket.

TicketCreated Datetime Timestampmedinfonraktuellloginticketskapades.

TicketExpires Datetime Timestampmedinfonraktuellloginticket.grut.

Ingenutgngstidrimplementeradiversion1.

XML-format

Ticket GUID

Datum + Tid

Datum + Tid


27/31

27/31

Data_Result.NET-klass

KlassenData_Result

innehller




dataResult Dataset Datafrnanropadfunktion


28/31

28/31

XML-format

utdata i xml-format frn respektive funktion

Auth_Result.NET-klass




Ticket Auth_Ticket Begrdauthticket

XML-format

ticket guid


29/31


30/31

30/31

Bilaga3.Statuskoder.FljandestatuskoderreturnerasiegenskapenresultCodefrklassernaAuth_Result,Data_Result.

Statuskod Frklaring

1000 Funktionenutfrdesutanfel.resultInfoinnehllereventuellinfo.

5000 Funktionenkundeinteutfras.resultInfoinnehllerinformationom

felet.

9000 Interntfel.resultInfoinnehllerinformation.


31/31

Bilaga4.Lnskoder.

Lnskod Beskrivning

01 Stockholmsln

03 Uppsalaln

04 Sdermanlandsln

05 stergtalandsln

06 Jnkpingsln

07 Kronobergsln

08 Kalmarln

09 Gotlandsln

10 Blekingeln

12 Skneln

13 Hallandsln

14 Vstragtalandsln

17 Vrmlandsln

18 rebroln

19 Vstmanlandsln

20 Dalarnasln

21 Gvleborgsln

22 Vsternorrlandsln

23 Jmtlandsln

24 Vsterbottensln

25 Norrbottensln

Bussgods Web Service Spec RA3

Documents

Transcript of Bussgods Web Service Spec RA3