Connect WebService -

Søk på kunder

Denne tjenesten gjør det mulig å hente ut informasjon om en eller flere kunder. Søkeresultat kan være en eller flere kunder, avhengig av hva slags argumenter man bruker i søket og hva som faktisk er registrert i databasen.

I kombinasjon med kundenr og navn kan man også fylle ut produkt. Dette vil "skrumpe inn" søke resultatet.

Webservice URI: /client/{clientId}/customerSearch
HTTP-metode: POST (med søke-xml i POST-body)
(eksempel: /client/1/customerSearch)

Eksempler på søk

<?xml version="1.0" encoding="UTF-8"?>
<customerSearch>
        <productCode/>
        <companyName>Unite AS</companyName>
        <department/>
        <firstName/>
        <middleName/>
        <lastName/>
        <coName/>
        <street/>
        <streetNumber/>
        <entrance/>
        <postalCode>0975</postalCode>
        <postalPlace>Oslo</postalPlace>
        <country/>
        <phoneNumber/>
        <email/>                
</customerSearch>

Beskrivelse av de forskjellige XML-elementene når du skal gjøre et søk mot kunder:

Elementnavn	Elementets forelder (parent)	Elementbeskrivelse	Datatype
<customerSearch>	-	Rot-element	-
<productCode>	<customerSearch>	Produkt / tittel <productCode> elementet inneholder produkt kode som kan brukes for å begrense søket	Tekst
<companyName>	<customerSearch>	Firmanavn Fylles bare ut dersom firmakunde	Tekst
<department>	<customerSearch>	Avdeling ved firmakunder Fylles bare ut dersom firmakunde	Tekst
<firstName>	<customerSearch>	Fornavn	Tekst
<middleName>	<customerSearch>	Mellomnavn	Tekst
<lastName>	<customerSearch>	Etternavn	Tekst
<coName>	<customerSearch>	Co navn	Tekst
<street>	<customerSearch>	Gatenavn	Tekst
<streetNumber>	<customerSearch>	Gatenummer	Heltall
<entrance>	<customerSearch>	Oppgang	Tekst
<postalCode>	<customerSearch>	Postnummer	Tekst
<postalPlace>	<customerSearch>	Poststed	Tekst
<country>	<customerSearch>	Land	Tekst
<phoneNumber>	<customerSearch>	Telefonnummer Søk gjøres på alle kundens telefonnumre, som kan være privat, arbeid, fax, eller mobil	Tekst
<email>	<customerSearch>	Epost adresse Søk gjøres på alle kundens mailadresser	Tekst

Et søk må et et sett med minimums verdier utfylt, slik at ikke resultatet blir for stort og unøyaktig. Skjematisk kan dette settes opp på følgende måte;

Firmanavn <companyName> eller etternavn <lastName> må være utfylt
Gatenavn <street> må være utfylt
Postnummer <postalCode> eller poststed <postalPlace> må være utfylt
Dersom man ikke søker på navn og adresse kan følgende være utfylt;
telefonnummer <phoneNumber>
email-adresser <email>

Svar

<?xml version="1.0" encoding="UTF-8"?>
<customers>
        <customer>
                <customerNumber>123</customerNumber>
                <customerDetails url="/client/c1/customer/123"/>
                <name>Autopower DA</name>
                <address>Stanseveien 6</address>
                <postalCode>0975</postalCode>
                <postalPlace>Oslo</postalPlace>
                <countryCode>NO</countryCode>
        </customer>
        <customer>
                <customerNumber>42</customerNumber>
                <customerDetails url="/client/c1/customer/42"/>
                <name>Unite AS</name>
                <address>Eilert Smiths vei 1</address>
                <postalCode>0975</postalCode>
                <postalPlace>Oslo</postalPlace>
                <countryCode>NO</countryCode>
        </customer>
</customers>

Elementnavn	Elementets forelder (parent)	Elementbeskrivelse	Datatype
<customers>	-	Rot-element Kan inneholde et eller flere <customer> elementer	-
<customer>	<customers>	Kunde Inneholder alle elementer for en bestemt kunde	-
<customerNumber>	<customer>	Kundenr	Heltall
<customerDetails>	<customer>	Kundeinformasjon Inneholder ett attributt: url som gir mer detaljert informasjon om kunden	-
<name>	<customer>	Navn Inneholder navn på kunden	Tekst
<address>	<customer>	Adresse Inneholder adresse til kunden	Tekst
<postalCode>	<customer>	Postnummer	Tekst
<postalPlace>	<customer>	Poststed	Tekst
<countryCode>	<customer>	Landkode ISO 3166 - alpha-2	Tekst