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
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Mercedes.Agency.Orchestration.API.ServiceModel.Voucher
Imports Mercedes.Agency.API.Shared.POCO

Namespace Global

    Namespace Mercedes.Agency.API.Shared.POCO

        Public Partial Class VoucherCodeValidationResponse
            Public Overridable Property IsValid As Boolean
            Public Overridable Property Message As String
        End Class
    End Namespace

    Namespace Mercedes.Agency.Orchestration.API.ServiceModel.Voucher

        Public Partial Class ValidateVoucherCodeRequest
            Implements IPost
            Public Overridable Property CampaignId As Integer
            Public Overridable Property VoucherCode As String
            Public Overridable Property OrderGuid As Guid?
            Public Overridable Property Vin As String
        End Class
    End Namespace
End Namespace

VB.NET 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
}