GetArticleInfo. Beschrijving van de webservice voor het opvragen van artikelinformatie. Auteur: Ron Kessels Datum: maandag 6 april 2009 Versie: 1.

Transcriptie

1 GetArticleInf Beschrijving van de webservice vr het pvragen van artikelinfrmatie. Auteur: Rn Kessels Datum: maandag 6 april 2009 Versie: 1.7

2 1 Functineel Deze webservice geeft infrmatie ver het artikel, de (nett)prijs en de beschikbaarheid van een f meerdere artikel(en) vr een gevraagd aantal en levermment. Middels deze functie kunnen van een set artikelen de artikel-, prijs- en beschikbaarheidsinfrmatie geupdated wrden. De inrichting van deze functie is afhankelijk van de tepassing in de sftware: - Updaten artikelbestand - Verkrijgen infrmatie bij het inveren van artikelen in een fferte/rder/bestelling - Updaten van een set artikelen in bijvrbeeld een calculatie Galvan Grthandel BV Pagina 2 R.M.J. Kessels

3 2 Uitwerking functinaliteit Middels het aanrepen van een webservice kunnen de artikel-, prijs- en beschikbaarheidsinfrmatie van een f meerdere artikelen geupdated wrden. Hiernder vlgt een beschrijving van de webservice. 2.1 Webservice Er is een webservice gedefinieerd met een methd: getarticleinf. Bij de aanrep van de webservice wrdt een drietal gegevens verwacht: struserid: de inlgnaam van de gebruiker p de website van Galvan strpasswrd: het wachtwrd behrende bij de inlgnaam strxmlarticleinf: de xmlstructuur met de gegevens ver de artikelen waarvr de artikelinfrmatie pgevraagd wrdt. Deze structuur wrdt in de vlgende subparagraaf beschreven. De xmlstructuur vr de methd getarticleinf is vastgelegd in een XSD. In de bijlage is een afdruk van deze structuur terug te vinden Opvragen artikelinfrmatie (getarticleinf) Bij de aanrep van de methd getarticleinf dienen de vlgende inputvariabelen meegegeven te wrden: - Settings ApplicatinId: (XSD:Integer) Een cde die aangeeft welke sftware de webservice aanrept. VersinId: (XSD:String, 20AN) Versienummer van de sftware welke de webservice aanrept. LanguageCde: (XSD:String, 2AN) Niet verplicht. Taalcde waarin de webservice de gegevens terug wil ntvangen, mgelijke cdes zijn: NL: Nederlands (default, indien niet meegegeven) EN: Engels DE: Duits FR: Frans - Functins Afhankelijk van de tepassing van deze webservice in de lcale sftware zijn bepaalde gegevens wel f niet gewenst. Onder deze nde kan aangegeven wrden welke gegevens wel / niet teruggegeven dienen te wrden. Waneer niet meegegeven wrdt uitgegaan van de waarde false. Descriptins: (XSD:blean) Wel f geen artikelmschrijvingen teruggeven PriceInf: (XSD:blean) Wel f geen prijsinfrmatie teruggeven StckInf: (XSD:blean) Wel f geen vrraadinfrmatie teruggeven - Articles Hiernder wrden de artikelen drgegeven waarvr de infrmatie pgevraagd wrdt. Let p: in een aanrep kunnen maximaal 100 artikelen tegelijkertijd pgevraagd wrden. Article Galvan Grthandel BV Pagina 3 R.M.J. Kessels

4 ArticleId: (XSD:Integer) Artikelnummer waarnder het artikel besteld kan wrden bij Galvan QuantityAsked: (XSD:Duble) Niet verplicht. Het aantal stuks gewenst van dit artikel in besteleenheden. Van belang vr prijs- en beschikbaarheidsberekening. Indien leeg / niet meegegeven standaard 1. DeliveryDateAsked: (XSD:datetime) Gevraagde leverdatum, van belang bij de beschikbaarheidsbepaling. Indien niet gevuld wrdt uitgegaan van de vlgende werkdag. Afhankelijk van de gekzen Functins wrden de hiernder genemde velden uit de utput wel/niet teruggegeven. Een aantal velden uit de utput wrdt altijd teruggegeven, dit is tussen blkhaken vermeld: - Articles Article ArticleId: (XSD:Integer) [altijd] QuantityAsked (XSD:Duble) [altijd] DeliveryDateAsked: (XSD:datetime) Unit: (XSD: String) [altijd] De besteleenheid van het artikel waarin Quantity uitgedrukt is Cnversinfactr: (XSD:duble) [altijd] Een mrekenfactr van besteleenheid naar gebruikseenheid. Bevat het aantal gebruikseenheden per besteleenheid (Wanneer er dus 25 Meter (gebruikseenheid) p 1 Rl (besteleenheid) zit, dan is de Cnversinfactr: 25). Om het aantal gebruikseenheden uit te rekenen dien de Cnversinfactr vermenigvuldigd te wrden met de Quantity. In de sftware van de klant dient dus ingesteld te wrden f er gerekend wrdt in bestel- f gebruikseenheden, de sftware dient vervlgens de gegevens uit deze webservice juist te interpreteren. UserUnit: (XSD:String, 15AN) [altijd] De gebruikseenheid CllectinId : (XSD :Int) [altijd] Indicatie srt artikel: 0 = Uniek artikelnummer 2 = Verzamelnummer 3 = Semi-verzamelnummer Deze indicatie is vral ndzakelijk vr sftware die maar 1 artikelmschrijving vast kan leggen. Bij cde 2 en 3 gaat het m artikelnummers waarnder meerdere artikelen besteld kunnen wrden (p basis van de mschrijving). Afhankelijk van de cde dienen bepaalde gegevens niet geupdated te wrden, te weten: 2: niet updaten mschrijving en prijsinfrmatie 3: niet updaten mschrijving ShrtDescriptin: (XSD:String, 100AN) [Descriptins] Krte mschrijving van de artikelregel (ptineel) LngDescriptin: (XSD: String, 145AN) [Descriptins] Uitgebreide artikelmschrijving vna de artikelregel. Deze mschrijving is leidend! Brand: (XSD:String, 25AN) [Descriptins] Merknaam van het artikel Serie: (XSD:String, 25AN) [Descriptins] Serienaam van het artikel PrductDescriptin: (XSD:String, 50AN) [Descriptins] Prductmschrijving van het artikel Clr: (XSD: 25AN) [Descriptins] Kleur van het prduct PrductCde: (XSD:String, 20AN) [Descriptins] Artikelnummer fabrikant Galvan Grthandel BV Pagina 4 R.M.J. Kessels

5 EANcde: (XSD:Int) [Descriptins] EAN / GTIN ArticleGrup: (XSD:Int) [PriceInf] De artikelgrep van het artikel vr de nettprijsberekening. GrssUnitPrice: (XSD:duble) [PriceInf] De brut stukprijs van het artikel per besteleenheid. De prijs per gebruikseenheid kan uitgerekend wrden dr dit veld te delen dr de CnversinFactr. NetUnitPrice: (XSD:duble) [PriceInf] De nett stukprijs van het artikel per besteleenheid. NetTtalPrice: (XSD:duble) [PriceInf] Dit is de nett ttaalprijs vr het aantal uit het Quantity veld. NetPriceDescriptin: (XSD:String, 50AN) [PriceInf] Deze mschrijving geeft aan he de gereturneerde nettprijs berekend is. StcktypeId: (XSD: Int) [StckInf] Geeft aan wat vr srt artikel het is, mgelijke uitkmsten zijn: 1. Vrraadartikel 2. Speciaal te bestellen artikel 3. Uitlpend artikel Availabilitytype: (XSD: Int) [StckInf] Geeft aan f het artikel in de gevraagde heveelheid p de gevraagde datum beschikbaar is. Mgelijke uitkmsten zijn: 1. Beschikbaar 2. Beperkt beschikbaar 3. Niet beschikbaar QuantityAvailable: (XSD: Int) [StckInf] Geeft het beschikbare aantal artikelen. Indien het gevraagde aantal vlledig beschikbaar is wrdt hier het gevraagde aantal gemeld. Indien het gevraagde aantal beperkt beschikbaar is staat hier het aantal dat mmenteel vrradig is. Indien het artikel niet vrradig is staat hier 0. FirstDeliveryweek: (XSD: String) [StckInf] Eerst mgelijke leverweek van het artikel indien het speciaal besteld wrdt. Frmaat: ww-yyyy. AvailabilityDescriptin: (XSD: String) [StckInf] Deze geeft een mschrijving ver de beschikbaarheid van het artikel. De mschrijving dient aan de gebruiker getnd te wrden. DeliveryDay: (XSD: Int) [StckInf] De levertijd van het artikel in dagen. ErrrArticleInf Deze nde wrdt alleen teruggegeven indien er een errr p artikelniveau plaatsvindt. Errrid: (xsd:int) Futcde Descriptin: (xsd:string) Omschrijving van de fut, mgelijk futmeldingen zijn: ErrrId Descriptin 1 Artikel niet (meer) leverbaar 3 Ongeldig artikelnummer Field: (xsd:string) Veld waarin de fut ptrad Errrafhandeling Indien er een futieve aanrep plaatsvindt, zal er een errrnde teruggestuurd wrden met de vlgende structuur: - ErrrArticle Galvan Grthandel BV Pagina 5 R.M.J. Kessels

6 Errrid: (XSD:Int) Futcde Descriptin: (XSD:String) Omschrijving van de fut Field: (XSD:String) Veld waarin de fut ptrad (wrdt vertaald in descriptin) We nderkennen de vlgende errrs: ErrrId Descriptin 1 Aanrep mislukt, de service is mmenteel niet beschikbaar, prbeer het later pnieuw 2 Inlggen mislukt, de cmbinatie gebruikersnaam en wachtwrd is njuist 3 Authrisatie mislukt, u heeft niet de juiste bevegdheid 4 Aanrep mislukt, ApplicatinId ngeldig 8 Aanrep mislukt; u kunt vr maximaal 100 artikelen tegelijk infrmatie pvragen Galvan Grthandel BV Pagina 6 R.M.J. Kessels

7 I. XSD Webservice getarticleinf Galvan Grthandel BV Pagina 7 R.M.J. Kessels