Mercedes.Agency.Orchestration.API

CancelOrderVoucherRequest

The following routes are available for this service:
PUT	/v1/order/voucher/cancel	Cancel order voucher usage	Cancels the voucher usage for an order

<?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 CancelOrderVoucherResponse implements JsonSerializable
{
    public function __construct(
        /** @var bool|null */
        public ?bool $Success=null
    ) {
    }

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

class CancelOrderVoucherRequest implements IPut, JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $OrderId=0
    ) {
    }

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

PHP CancelOrderVoucherRequest 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.

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

<CancelOrderVoucherRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mercedes.Agency.Orchestration.API.ServiceModel.Orders">
  <OrderId>0</OrderId>
</CancelOrderVoucherRequest>

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

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