Mercedes.Agency.Orchestration.API

<back to all web services

ValidateOutRightPurchaseRequest

OutrightPurchase
Requires Authentication
The following routes are available for this service:
POST/v1/outrightpurchase/validateValidate Outright Purchase
<?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 OutrightPurchaseDiscount implements JsonSerializable
{
    public function __construct(
        /** @var string */
        public string $BaumusterNST='',
        /** @var float */
        public float $DiscountPercentage=0.0
    ) {
    }

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

class OutrightPurchaseFleetCustomer implements JsonSerializable
{
    public function __construct(
        /** @var string */
        public string $CustomerIdentifier='',
        /** @var string */
        public string $CompanyName='',
        /** @var string */
        public string $Title='',
        /** @var string */
        public string $FirstName='',
        /** @var string */
        public string $LastName='',
        /** @var string */
        public string $Email='',
        /** @var string */
        public string $PhoneNumber='',
        /** @var string */
        public string $HouseNumber='',
        /** @var string */
        public string $AddressLine2='',
        /** @var string */
        public string $Town='',
        /** @var string */
        public string $County='',
        /** @var string */
        public string $PostCode='',
        /** @var array<OutrightPurchaseDiscount>|null */
        public ?array $OutrightPurchaseCustomerDiscounts=null,
        /** @var bool|null */
        public ?bool $ImportSucessful=null,
        /** @var bool|null */
        public ?bool $IsEligibleCOPConverter=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['CustomerIdentifier'])) $this->CustomerIdentifier = $o['CustomerIdentifier'];
        if (isset($o['CompanyName'])) $this->CompanyName = $o['CompanyName'];
        if (isset($o['Title'])) $this->Title = $o['Title'];
        if (isset($o['FirstName'])) $this->FirstName = $o['FirstName'];
        if (isset($o['LastName'])) $this->LastName = $o['LastName'];
        if (isset($o['Email'])) $this->Email = $o['Email'];
        if (isset($o['PhoneNumber'])) $this->PhoneNumber = $o['PhoneNumber'];
        if (isset($o['HouseNumber'])) $this->HouseNumber = $o['HouseNumber'];
        if (isset($o['AddressLine2'])) $this->AddressLine2 = $o['AddressLine2'];
        if (isset($o['Town'])) $this->Town = $o['Town'];
        if (isset($o['County'])) $this->County = $o['County'];
        if (isset($o['PostCode'])) $this->PostCode = $o['PostCode'];
        if (isset($o['OutrightPurchaseCustomerDiscounts'])) $this->OutrightPurchaseCustomerDiscounts = JsonConverters::fromArray('OutrightPurchaseDiscount', $o['OutrightPurchaseCustomerDiscounts']);
        if (isset($o['ImportSucessful'])) $this->ImportSucessful = $o['ImportSucessful'];
        if (isset($o['IsEligibleCOPConverter'])) $this->IsEligibleCOPConverter = $o['IsEligibleCOPConverter'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->CustomerIdentifier)) $o['CustomerIdentifier'] = $this->CustomerIdentifier;
        if (isset($this->CompanyName)) $o['CompanyName'] = $this->CompanyName;
        if (isset($this->Title)) $o['Title'] = $this->Title;
        if (isset($this->FirstName)) $o['FirstName'] = $this->FirstName;
        if (isset($this->LastName)) $o['LastName'] = $this->LastName;
        if (isset($this->Email)) $o['Email'] = $this->Email;
        if (isset($this->PhoneNumber)) $o['PhoneNumber'] = $this->PhoneNumber;
        if (isset($this->HouseNumber)) $o['HouseNumber'] = $this->HouseNumber;
        if (isset($this->AddressLine2)) $o['AddressLine2'] = $this->AddressLine2;
        if (isset($this->Town)) $o['Town'] = $this->Town;
        if (isset($this->County)) $o['County'] = $this->County;
        if (isset($this->PostCode)) $o['PostCode'] = $this->PostCode;
        if (isset($this->OutrightPurchaseCustomerDiscounts)) $o['OutrightPurchaseCustomerDiscounts'] = JsonConverters::toArray('OutrightPurchaseDiscount', $this->OutrightPurchaseCustomerDiscounts);
        if (isset($this->ImportSucessful)) $o['ImportSucessful'] = $this->ImportSucessful;
        if (isset($this->IsEligibleCOPConverter)) $o['IsEligibleCOPConverter'] = $this->IsEligibleCOPConverter;
        return empty($o) ? new class(){} : $o;
    }
}

class ValidateOutRightPurchaseResponse implements JsonSerializable
{
    public function __construct(
        /** @var OutrightPurchaseFleetCustomer|null */
        public ?OutrightPurchaseFleetCustomer $OutrightPurchaseFleetCustomer=null,
        /** @var bool|null */
        public ?bool $IsBackOrder=null
    ) {
    }

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

class ValidateOutRightPurchaseRequest extends ValidateOutRightPurchaseRequest implements IPost, JsonSerializable
{
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = parent::jsonSerialize();
        return empty($o) ? new class(){} : $o;
    }
}

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

POST /v1/outrightpurchase/validate HTTP/1.1 
Host: prod-api-agency-orch-mb-dhc.rapp-customers.co.uk 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ValidateOutRightPurchaseRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mercedes.Agency.Orchestration.API.ServiceModel.OutrightPurchases">
  <Criteria xmlns:d2p1="http://schemas.datacontract.org/2004/07/Mercedes.Agency.API.Shared.POCO" xmlns="http://schemas.datacontract.org/2004/07/Mercedes.Agency.Orchestration.API.Clients.AgencyApi.Requests">
    <d2p1:Bm7NST>String</d2p1:Bm7NST>
    <d2p1:IsBackOrder>false</d2p1:IsBackOrder>
    <d2p1:Reference>String</d2p1:Reference>
  </Criteria>
</ValidateOutRightPurchaseRequest>

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

<ValidateOutRightPurchaseResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mercedes.Agency.Orchestration.API.Clients.AgencyApi.Responses">
  <IsBackOrder>false</IsBackOrder>
  <OutrightPurchaseFleetCustomer xmlns:d2p1="http://schemas.datacontract.org/2004/07/Mercedes.Agency.API.Shared.POCO">
    <d2p1:AddressLine2>String</d2p1:AddressLine2>
    <d2p1:CompanyName>String</d2p1:CompanyName>
    <d2p1:County>String</d2p1:County>
    <d2p1:CustomerIdentifier>String</d2p1:CustomerIdentifier>
    <d2p1:Email>String</d2p1:Email>
    <d2p1:FirstName>String</d2p1:FirstName>
    <d2p1:HouseNumber>String</d2p1:HouseNumber>
    <d2p1:ImportSucessful>false</d2p1:ImportSucessful>
    <d2p1:IsEligibleCOPConverter>false</d2p1:IsEligibleCOPConverter>
    <d2p1:LastName>String</d2p1:LastName>
    <d2p1:OutrightPurchaseCustomerDiscounts>
      <d2p1:OutrightPurchaseDiscount>
        <d2p1:BaumusterNST>String</d2p1:BaumusterNST>
        <d2p1:DiscountPercentage>0</d2p1:DiscountPercentage>
      </d2p1:OutrightPurchaseDiscount>
    </d2p1:OutrightPurchaseCustomerDiscounts>
    <d2p1:PhoneNumber>String</d2p1:PhoneNumber>
    <d2p1:PostCode>String</d2p1:PostCode>
    <d2p1:Title>String</d2p1:Title>
    <d2p1:Town>String</d2p1:Town>
  </OutrightPurchaseFleetCustomer>
</ValidateOutRightPurchaseResponse>