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

<?php namespace dtos;

use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};


class VoucherCodeValidationResponse implements JsonSerializable
{
    public function __construct(
        /** @var bool|null */
        public ?bool $IsValid=null,
        /** @var string */
        public string $Message=''
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['IsValid'])) $this->IsValid = $o['IsValid'];
        if (isset($o['Message'])) $this->Message = $o['Message'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->IsValid)) $o['IsValid'] = $this->IsValid;
        if (isset($this->Message)) $o['Message'] = $this->Message;
        return empty($o) ? new class(){} : $o;
    }
}

class ValidateVoucherCodeRequest implements IPost, JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $CampaignId=0,
        /** @var string */
        public string $VoucherCode='',
        /** @var string|null */
        public ?string $OrderGuid=null,
        /** @var string */
        public string $Vin=''
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['CampaignId'])) $this->CampaignId = $o['CampaignId'];
        if (isset($o['VoucherCode'])) $this->VoucherCode = $o['VoucherCode'];
        if (isset($o['OrderGuid'])) $this->OrderGuid = $o['OrderGuid'];
        if (isset($o['Vin'])) $this->Vin = $o['Vin'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->CampaignId)) $o['CampaignId'] = $this->CampaignId;
        if (isset($this->VoucherCode)) $o['VoucherCode'] = $this->VoucherCode;
        if (isset($this->OrderGuid)) $o['OrderGuid'] = $this->OrderGuid;
        if (isset($this->Vin)) $o['Vin'] = $this->Vin;
        return empty($o) ? new class(){} : $o;
    }
}

PHP ValidateVoucherCodeRequest DTOs

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"}