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
ValidateVoucherCodeRequest Parameters:
NameParameterData TypeRequiredDescription
CampaignIdbodyintNo
VoucherCodebodystringYes
OrderGuidbodyGuid?No
VinbodystringYes
VoucherCodeValidationResponse Parameters:
NameParameterData TypeRequiredDescription
IsValidformboolNo
MessageformstringYes

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
Content-Type: application/json
Content-Length: length

{"CampaignId":0,"VoucherCode":"String","OrderGuid":"00000000000000000000000000000000","Vin":"String"}

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

{"IsValid":false,"Message":"String"}