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
import Foundation
import ServiceStack

public class ValidateOutRightPurchaseRequest : ValidateOutRightPurchaseRequest, IPost
{
    required public init(){ super.init() }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
    }
}

public class ValidateOutRightPurchaseResponse : Codable
{
    public var outrightPurchaseFleetCustomer:OutrightPurchaseFleetCustomer
    public var isBackOrder:Bool?

    required public init(){}
}

public class OutrightPurchaseFleetCustomer : Codable
{
    public var customerIdentifier:String
    public var companyName:String
    public var title:String
    public var firstName:String
    public var lastName:String
    public var email:String
    public var phoneNumber:String
    public var houseNumber:String
    public var addressLine2:String
    public var town:String
    public var county:String
    public var postCode:String
    public var outrightPurchaseCustomerDiscounts:[OutrightPurchaseDiscount] = []
    public var importSucessful:Bool
    public var isEligibleCOPConverter:Bool

    required public init(){}
}

public class OutrightPurchaseDiscount : Codable
{
    public var baumusterNST:String
    public var discountPercentage:Double

    required public init(){}
}


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