Gränssnitt visning av transportinstruktion, fraktsedel och kvittens (e-pod)

Transkript

1 Datum: Sida 1 av 5 Gränssnitt visning av transportinstruktion, fraktsedel och kvittens 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. service.action A String WDR 10 Värde search service.method A String WDR 10 Värde search 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 ("oskar") service.version O String WDR - Versionsnummer (1.0) data_list_count O Int WDR - Antal i data_list data_list.0.image_info_list O Array WDR Lista över matchande bildinformation för angivna fraktsedlar. system.error.id O Int WDR Felkoder: 0 OK 102 Felaktigt användar-id eller lösenord 302 Felaktigt argument. 303 Felaktig container 304 Argument saknas. 306 Action ej implementerad. 307 Metod ej implementerad. 507 Övriga fatala fel från anropad Service. system.error.message String WDR Felmeddelande system.error.description String WDR Beskrivning

2 Datum: Sida 2 av 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 Felkoder: 0 OK 302 Felaktigt argument. 303 Felaktig container 304 Argument saknas. 306 Action ej implementerad. 307 Metod ej implementerad. 507 Övriga fatala fel från anropad Service. 902 Behörighet saknas. error.message String WDR 100 Felmeddelande system.error.description String WDR Beskrivning 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, ex E-handelssystemet X statistics.remote.admin_e_mail O String WDR - 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. FSBild_2 statistics.request.service.action O String WDR - search statistics.request.service.method O String WDR - search

3 Datum: Sida 3 av 5 2 Meddelanden Innehåller information om förfrågan.. Addera prefixet data_list.0. till variablerna. 2.1 Inloggning Gör en autentisering med användarens kundnummer och lösenord. Innehåller information till tjänsten. I fältet obligatoriskt står det ett O. Detta fält är obligatoriskt. data_list.0.customernumber O String Kundnummer/användar-id data_list.0.password O String Lösenord data_list.0.searchtype O String Typ av sökning Gral =sökning EDI-info och om ej träff vidare i scannade fraktsedlar Oskar =sökning scannade fraktsedlar 2.2 Svar 2.1 Sökning sändningsinformation Innehåller information till tjänsten. I fältet obligatoriskt står det ett A. Detta fält är obligatoriskt. data_list.0.type O String Typ av sökning Sändningsnummer Fakturanummer data_list.0.waybillnumber O String Sändningsnummer data_list.0.searchtype O String Typ av sökning Gral =sökning EDI-info och om ej träff vidare i scannade fraktsedlar Oskar =sökning scannade fraktsedlar request.service.action O String Värde "display" request.service.method O String Värde "display" data_list.0.dok_id O String Dokument id. 1 Fraktsedel. P Kvittens. data_list.0.faktura O String Typ av sökning J Sökning av faktura N Sökning av sändningsinfo data_list.0.invoicenumber O String Fakturanummer

4 Datum: Sida 4 av 5 3 Versionshistorik Tillägg av sträng &data_list.0.consignors_reference_number= för sökning på referensnummer /Göran Stierner Ändrat URL /Göran Stierner Tillägg av exempel på direkta url-anrop /KaBr Tillägg av anrop till StatisticsLogger_001 /KaBr Lagt till sökning på kvittenser. /KaBr Lagt till text om systemkrav på inloggningssidan. /KaBr Lagt till sökning på sändningsinformation i Gral. /KaBr 4 Exempel Anropet måste göras i två steg, först en inloggning och därefter en sökning. Inscannade fraktsedlar och kvittenser lagras i 70 dagar. Inloggning: data_list.0.customernumber= data_list.0.password=xxxxxxxx arch&data_list.0.customernumber= &data_list.0.password=xxxxxxxx&data_list.0.searchtype =Gral&request.format.mime=&system.statistics.remote.ip_address=2&system.statistics.user.language _code=sv&system.statistics.remote.country_code=se&system.statistics.user.return_mime_format=ht ml&system.statistics.remote.send_data_format=web2&system.statistics.service.api_version=2.0&syst em.statistics.remote.access_type=a&&syste m.statistics.remote.admin_e_mail=systemadministrator@dittforetag.se&system.statistics.service.nam e=fsbild_2&

5 Datum: Sida 5 av 5 Visa transportinstruktion/fraktsedel, sökning först i EDI-information och sedan i scannade fraktsedlar: splay&request.format.mime=&data_list.0.type=0&data_list.0.dok_id=1&data_list.0.searchtype=gral& data_list.0.faktura=n&system.statistics.remote.ip_address= &system.statistics.user.language _code=sv&system.statistics.remote.country_code=se&system.statistics.user.return_mime_format=ht ml&system.statistics.remote.send_data_format=web2&system.statistics.user.organization_id= &system.statistics.service.api_version=2.0&system.statistics.remote.access_type=A&system.stat istics.remote.application_name=er_applikation&system.statistics.remote.admin_e_mail=systemadmini strator@dittforetag.se&system.statistics.service.name=fsbild_2&data_list.0.waybillnumber= &data_list.0.invoicenumber=&data_list.0.consignors_reference_number= Sök transportinstruktion, EDI-information splay&request.format.mime=&data_list.0.type=0&data_list.0.dok_id=1&data_list.0.searchtype=gral& data_list.0.faktura=n&system.statistics.remote.ip_address=2&system.statistics.user.language_code=s v&system.statistics.remote.country_code=se&system.statistics.user.return_mime_format=html&syste m.statistics.remote.send_data_format=web2&&sys tem.statistics.service.api_version=2.0&system.statistics.remote.access_type=a&system.statistics.rem ote.application_name=er_applikation&system.statistics.remote.admin_e_mail=systemadministrator@ dittforetag.se&system.statistics.service.name=fsbild_2&&data _list.0.invoicenumber=&data_list.0.consignors_reference_number= Sök kvittens, e-pod splay&request.format.mime=&data_list.0.type=0&data_list.0.dok_id=p&data_list.0.searchtype=oskar &data_list.0.faktura=n&system.statistics.remote.ip_address=2&system.statistics.user.language_code =sv&system.statistics.remote.country_code=se&system.statistics.user.return_mime_format=html&syst em.statistics.remote.send_data_format=web2&&s ystem.statistics.service.api_version=2.0&system.statistics.remote.access_type=a&system.statistics.re ata_list.0.invoicenumber=