Mercedes.Agency.Orchestration.API

ValidateVoucherCodeRequest

Voucher

The following routes are available for this service:
POST	/v1/voucher/validate	Validates a voucher code for a campaign

"use strict";
export class VoucherCodeValidationResponse {
    /** @param {{IsValid?:boolean,Message?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {boolean} */
    IsValid;
    /** @type {string} */
    Message;
}
export class ValidateVoucherCodeRequest {
    /** @param {{CampaignId?:number,VoucherCode?:string,OrderGuid?:string,Vin?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    CampaignId;
    /** @type {string} */
    VoucherCode;
    /** @type {?string} */
    OrderGuid;
    /** @type {string} */
    Vin;
}

JavaScript ValidateVoucherCodeRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /v1/voucher/validate HTTP/1.1 
Host: prod-api-agency-orch-mb-dhc.rapp-customers.co.uk 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ValidateVoucherCodeRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mercedes.Agency.Orchestration.API.ServiceModel.Voucher">
  <CampaignId>0</CampaignId>
  <OrderGuid>00000000-0000-0000-0000-000000000000</OrderGuid>
  <Vin>String</Vin>
  <VoucherCode>String</VoucherCode>
</ValidateVoucherCodeRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<VoucherCodeValidationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mercedes.Agency.API.Shared.POCO">
  <IsValid>false</IsValid>
  <Message>String</Message>
</VoucherCodeValidationResponse>