Mercedes.Agency.Orchestration.API

<back to all web services

ValidateVoucherCodeRequest

Voucher
Requires Authentication
The following routes are available for this service:
POST/v1/voucher/validateValidates a voucher code for a campaign
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    public static class ValidateVoucherCodeRequest implements IPost
    {
        public Integer CampaignId = null;
        public String VoucherCode = null;
        public UUID OrderGuid = null;
        public String Vin = null;
        
        public Integer getCampaignId() { return CampaignId; }
        public ValidateVoucherCodeRequest setCampaignId(Integer value) { this.CampaignId = value; return this; }
        public String getVoucherCode() { return VoucherCode; }
        public ValidateVoucherCodeRequest setVoucherCode(String value) { this.VoucherCode = value; return this; }
        public UUID getOrderGuid() { return OrderGuid; }
        public ValidateVoucherCodeRequest setOrderGuid(UUID value) { this.OrderGuid = value; return this; }
        public String getVin() { return Vin; }
        public ValidateVoucherCodeRequest setVin(String value) { this.Vin = value; return this; }
    }

    public static class VoucherCodeValidationResponse
    {
        public Boolean IsValid = null;
        public String Message = null;
        
        public Boolean getIsValid() { return IsValid; }
        public VoucherCodeValidationResponse setIsValid(Boolean value) { this.IsValid = value; return this; }
        public String getMessage() { return Message; }
        public VoucherCodeValidationResponse setMessage(String value) { this.Message = value; return this; }
    }

}

Java ValidateVoucherCodeRequest DTOs

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

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	CampaignId: 0,
	VoucherCode: String,
	OrderGuid: 00000000000000000000000000000000,
	Vin: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	IsValid: False,
	Message: String
}