Mercedes.Agency.Orchestration.API

<back to all web services

CancelOrderVoucherRequest

Requires Authentication
The following routes are available for this service:
PUT/v1/order/voucher/cancelCancel order voucher usageCancels the voucher usage for an order
import 'package:servicestack/servicestack.dart';

class CancelOrderVoucherResponse implements IConvertible
{
    bool Success;

    CancelOrderVoucherResponse({this.Success});
    CancelOrderVoucherResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Success = json['Success'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Success': Success
    };

    getTypeName() => "CancelOrderVoucherResponse";
    TypeContext? context = _ctx;
}

class CancelOrderVoucherRequest implements IPut, IConvertible
{
    int OrderId = 0;

    CancelOrderVoucherRequest({this.OrderId});
    CancelOrderVoucherRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        OrderId = json['OrderId'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'OrderId': OrderId
    };

    getTypeName() => "CancelOrderVoucherRequest";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'prod_api_agency_orch_mb_dhc.rapp_customers.co.uk', types: <String, TypeInfo> {
    'CancelOrderVoucherResponse': TypeInfo(TypeOf.Class, create:() => CancelOrderVoucherResponse()),
    'CancelOrderVoucherRequest': TypeInfo(TypeOf.Class, create:() => CancelOrderVoucherRequest()),
});

Dart 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>