Connect WebService -

Produkt-retur

Denne tjenesten håndterer en retur i systemet. Dersom årsaks-koden tilsier det vil abonnementet bli stoppet og åpen faktura kanselleres.

Webservice URI:/client/clientId/productReturn
HTTP-metode: POST
(eksempel: /client/1/productReturn)

Eksempel på input:

<?xml version="1.0" encoding="UTF-8"?>
<productReturns>
        <productReturn>
                <companyCode>EGSF</companyCode>
                <invoiceNumber>123456</invoiceNumber>
                <returnReason>STOP</returnReason>
        </productReturn>
        <productReturn>
                <companyCode>EGSF</companyCode>
                <invoiceNumber>341256</invoiceNumber>
                <returnReason>OTHER</returnReason>
        </productReturn>
</productReturns>

Beskrivelse av de forskjellige XML-elementene når du skal registrere en retur:

Elementnavn	Elementets forelder (parent)	Elementbeskrivelse	Datatype
<productReturns>	-	Rot-element - Dette er rot-elementet som inneholder alle retur-elementene	-
<productReturn>	<productReturns>	Hoved-element - Dette angir en retur, du kan ha n antall <productReturn> elementer som barn av <productReturns> elementet i et XML dokument.	-
<companyCode>	<productReturn>	Firma Angir firmakoden som faktura er knyttet til.	Tekst - maks 12 tegn
<invoiceNumber>	<productReturn>	Faktura-nummer Unik ID innenfor firma-koden for en faktura.	Heltall
<returnReason>	<productReturn>	Retur-kode Kode som angir hvordan retur skal håndteres. STOP - abonnement stoppes og faktura kanselleres. Alle andre verdier ignoreres.	Tekst - maks 12 tegn

Svar:

<?xml version="1.0" encoding="UTF-8"?>
<productReturns>
        <productReturn>
                <companyCode>EGSF</companyCode>
                <invoiceNumber>123456</invoiceNumber>
                <result>OK</result>
        </productReturn>
        <productReturn>
                <companyCode>EGSF</companyCode>
                <invoiceNumber>341256</invoiceNumber>
                <result>OK</result>
        </productReturn>
</productReturns>

Beskrivelse av de forskjellige XML-elementene i et svar fra CWS når du har registrert en retur:

Elementnavn	Elementets forelder (parent)	Elementbeskrivelse	Datatype
<productReturns>	-	Rot-element - Dette er rot-elementet som inneholder alle retur-elementene	-
<productReturn>	<productReturns>	Hoved-element - Dette angir en retur, du kan ha n antall <productReturn> elementer som barn av <productReturns> elementet i et XML dokument.	-
<companyCode>	<productReturn>	Firma Angir firmakoden som faktura er knyttet til.	Tekst
<invoiceNumber>	<productReturn>	Faktura-nummer Unik ID innenfor firma-koden for en faktura.	Heltall
<result>	<productReturn>	Resultat OK dersom input ble behandlet ok. NO ACTION dersom ukjent retur-kode. Ellers, ERROR med en beskrivende feilmelding.	Tekst