Oppslag på kunde

Denne tjenesten gjør det mulig å hente ut informasjon om en angitt kunde (navn, adresse, abonnementsinformasjon)

Webservice URI: /client/{clientId}/customer/{customerNumber}
HTTP-metode: GET
(eksempel: /client/1/customer/42)

Svar:

<?xml version="1.0" encoding="UTF-8"?>
<customer>
        <customerNumber>123</customerNumber>
        <companyName>Unite AS</companyName>
        <department/>
        <firstName>Navn</firstName>
        <middleName/>
        <lastName>Navnesen</lastName>
        <coName/>
        <street>Veien</street>
        <streetNumber>12</streetNumber>
        <entrance/>
        <floorType/>
        <floor/>
        <suite/>
        <postalCode>0975</postalCode>
        <postalPlace>Oslo</postalPlace>
        <postalAddress/>
        <postalAddressPostalCode/>
        <postalAddressPostalPlace/>
        <countryCode>NO</countryCode>
        <countryName>Norge</countryName>
        <phoneNumbers>
                <phoneNumber type="work">99999</phoneNumber>
        <phoneNumbers>
        <emails>
                <email>navn@navnesen.com</email>
        </emails>
        <recurringProducts>
                <recurringProduct>
                        <productCode>DONALD</productCode>
                        <status>active</status>
                        <fulfillmentRule>SB</fulfillmentRule>
                        <period type="issue">
                                <originalStart>2008-11</originalStart>
                                <start>2009-11</start>
                                <end>2010-10</end>
                        </period>
                        <paid>yes</paid>
                </recurringProduct>
        </recurringProducts>
</customer>

Beskrivelse av de forskjellige XML-elementene når du har gjort oppslag på en kunde:

ElementnavnElementets forelder 
(parent)		ElementbeskrivelseDatatype
<customer>-Rot-element-
<customerNumber><customer>KundenummerHeltall
<companyName><customer>Firmanavn (dersom firmakunde)Tekst - maks 40 tegn
<department><customer>Avdelingsnavn (dersom firmakunde)Tekst - maks 40 tegn
<firstName><customer>Fornavn (obs! Kan også være registrert på firmakunder)Tekst - maks 30 tegn
<middleName><customer>MellomnavnTekst - maks 30 tegn
<lastName><customer>EtternavnTekst - maks 30 tegn
<coName><customer>Co navnTekst - maks 40 tegn
<street><customer>GatenavnTekst - maks 40 tegn
<streetNumber><customer>GatenummerHeltall
<entrance><customer>OppgangTekst - maks 12 tegn
<floorType><customer>Etasje type  
H=hovedetasje  
L=loft  
U=underetasje  
K=kjeller		Tekst - maks 1 tegn
<floor><customer>EtasjeHeltall
<suite><customer>LeilighetsnummerTekst - maks 10 tegn
<postalCode><customer>PostnummerTekst - maks 10 tegn
<postalPlace><customer>PoststedTekst - maks 30 tegn
<postalAddress><customer>Postboks adresse, dersom forskjellig fra leveringsadresseTekst - maks 40 tegn
<postalAddressPostalCode><customer>Postboks adresse postnr - ufylt dersom postboks adresse forskjellig fra gateadresseTekst - maks 10 tegn
<postalAddressPostalPlace><customer>Postboks adresse postnr - utfylt dersom postboks adresse forskjellig fra gateadresseTekst - maks 10 tegn
<countryCode><customer>Landkode ISO 3166 - alpha-2Tekst - maks 3 tegn
<countryName><customer>Land navnTekst - maks 30 tegn
<phoneNumbers><customer>Telefonnummer Inneholder en liste med 0, 1 eller mange <phoneNumber> elementer-
<phoneNumber><phoneNumbers>Telefonnummer Inneholder ett attributt: type som angir hvilken type telefonnummer det er. Gyldige verdier for attributtet: work, private, fax eller mobileTekst - maks 20 tegn
<emails><customer>Epost Inneholder en liste med 0, 1 eller mange <email> elementer-
<email><emails>Epost Inneholder en epost adresseTekst - maks 60 tegn
<recurringProducts><customer>Abonnementsprodukter Inneholder ingen eller flere <recurringProduct> elementer som representerer tilknyttede abonnementsprodukter.-
<recurringProduct><recurringProducts>Inneholder informasjon om et abonnement-
<productCode><recurringProduct>Produkt Produkt-kodeTekst - maks 12 tegn
<status><recurringProduct>Status Status på abonnementetTekst: active eller passive

Følgende elementer kan sendes med dersom systemt blir konfigurert for dette:

ElementnavnElementets forelder 
(parent)		ElementbeskrivelseDatatype
<fulfillmentRule><recurringProduct>FullførselsregelTekst
<period><recurringProduct>Periode Inneholder et attributt type med følgende gyldige verdier: issue eller date
<originalStart><period>Opprinnelig start Opprinnelig start for kundens aktuelle abonnements-løp.
<start><period>Start Periodens start.
<end><period>Slutt Periodens slutt.
<paid><recurringProduct>Betalt Angir om perioden er betalt.Tekst: yes eller no

Oppslag på kunde og produkt

Denne tjenesten gjør det mulig å hente ut informasjon om en angitt kunde (navn, adresse, abonnementsinformasjon) og informasjon om angitt produkt

Webservice URI: /client/{clientId}/customer/{customerNumber}/product/{productCode}
HTTP-metode: GET
(eksempel: /client/1/customer/42/product/DONALD)

Svaret er det samme som i Oppslag på kunde med den forskjellen at <recurringProducts> elementet inneholder 0 eller 1 <recurringProduct> element avhengig om kunden er abonnent på angitt produkt eller ikke.

Oppdatering av kunde

Denne tjenesten brukes til å oppdatere adressen til en kunde. Merk at det bare er mulig å oppdatere adressen til en passiv kunde.

Benytt <customer>-elementet som returneres ved oppslag. (Elementet <recurringProducts> benyttes ikke og blir ignorert hvis det sendes med.)

Webservice URI: /client/{clientId}/customer/{customerNumber}
HTTP-metode: POST
(eksempel: /client/1/customer/42)

Svar:

<?xml version="1.0" encoding="UTF-8"?>
<result>
        <updated>true</updated>
</result>

Svaret er en enkel status på om oppdateringen ble fulført:

ElementnavnElementets forelder 
(parent)		ElementbeskrivelseDatatype
<result>-Rot-element-
<updated><result>Flagg som forteller om forekomsten ble oppdatert.Boolsk verdi (true/false)