Mercedes.Agency.Orchestration.API

<back to all web services

UpdateBackOrderRequest

BackOrder
Requires Authentication
The following routes are available for this service:
PUT/v1/backorder/{Guid}Update Back Order by Guid
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Mercedes.Agency.Orchestration.API.ServiceModel.BackOrders;
using Mercedes.Agency.API.Shared.POCO;
using Mercedes.Agency.Orchestration.API.Clients.AgencyApi.Responses;

namespace Mercedes.Agency.API.Shared.POCO
{
    public partial class CriteriaBase
        : JsonVersion
    {
        public virtual string[] Transmission { get; set; } = [];
        public virtual string[] Fuel { get; set; } = [];
        public virtual string[] Upholstery { get; set; } = [];
        public virtual string[] Equipment { get; set; } = [];
        public virtual string[] Line { get; set; } = [];
        public virtual string[] BodyStyle { get; set; } = [];
        public virtual string[] ColourGroup { get; set; } = [];
        public virtual string[] Packages { get; set; } = [];
        public virtual List<CriteriaModel> Model { get; set; } = [];
        public virtual string UrlReferrer { get; set; }
        public virtual string PreferredDeliveryDate { get; set; }
        [ApiMember(ExcludeInSchema=true)]
        public virtual bool IsNewModel { get; set; }

        [ApiMember(ExcludeInSchema=true)]
        public virtual bool IsSmart { get; set; }

        [ApiMember(ExcludeInSchema=true)]
        public virtual bool IsSpecialised { get; set; }

        [ApiMember(ExcludeInSchema=true)]
        public virtual CriteriaDifference CriteriaDifference { get; set; }
    }

    public partial class CriteriaDifference
    {
        public virtual bool Model { get; set; }
        public virtual bool Transmission { get; set; }
        public virtual bool Fuel { get; set; }
        public virtual bool Upholstery { get; set; }
        public virtual bool Equipment { get; set; }
        public virtual bool Line { get; set; }
        public virtual bool BodyStyle { get; set; }
        public virtual bool ColourGroup { get; set; }
        public virtual bool Packages { get; set; }
        public virtual bool Engine { get; set; }
        public virtual bool AdditionalInformation { get; set; }
        public virtual bool UrlReferrer { get; set; }
        public virtual bool PreferredDeliveryDate { get; set; }
        public virtual bool IsSmart { get; set; }
        public virtual bool IsSpecialised { get; set; }
    }

    public partial class CriteriaModel
    {
        public virtual string Description { get; set; }
        public virtual int Id { get; set; }
    }

    public partial class JsonVersion
        : IJsonVersion
    {
        public virtual int Version { get; set; }
    }

    public partial class V2Criteria
        : CriteriaBase
    {
        public virtual List<V2EngineCriteria> Engine { get; set; } = [];
    }

    public partial class V2EngineCriteria
    {
        public virtual string Badge { get; set; }
        public virtual string Brand { get; set; }
    }

}

namespace Mercedes.Agency.Orchestration.API.Clients.AgencyApi.Responses
{
    public partial class UpdateBackOrderResponse
    {
    }

}

namespace Mercedes.Agency.Orchestration.API.ServiceModel.BackOrders
{
    public partial class UpdateBackOrderRequest
        : IPut
    {
        public virtual Guid Guid { get; set; }
        public virtual V2Criteria AgentCriteria { get; set; }
        public virtual string AdditionalInformation { get; set; }
        public virtual string ConfigCode { get; set; }
        public virtual int? MotabilityPricingId { get; set; }
        public virtual int? AssistanceProviderId { get; set; }
        public virtual string AssistanceDetail { get; set; }
        public virtual bool IsCOPConverter { get; set; }
        public virtual string ConfiguratorCode { get; set; }
        public virtual bool IsOneAdminUpdate { get; set; }
    }

}

C# UpdateBackOrderRequest 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/backorder/{Guid} HTTP/1.1 
Host: prod-api-agency-orch-mb-dhc.rapp-customers.co.uk 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<UpdateBackOrderRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mercedes.Agency.Orchestration.API.ServiceModel.BackOrders">
  <AdditionalInformation>String</AdditionalInformation>
  <AgentCriteria xmlns:d2p1="http://schemas.datacontract.org/2004/07/Mercedes.Agency.API.Shared.POCO">
    <d2p1:Version>0</d2p1:Version>
    <d2p1:BodyStyle xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </d2p1:BodyStyle>
    <d2p1:ColourGroup xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </d2p1:ColourGroup>
    <d2p1:CriteriaDifference>
      <d2p1:AdditionalInformation>false</d2p1:AdditionalInformation>
      <d2p1:BodyStyle>false</d2p1:BodyStyle>
      <d2p1:ColourGroup>false</d2p1:ColourGroup>
      <d2p1:Engine>false</d2p1:Engine>
      <d2p1:Equipment>false</d2p1:Equipment>
      <d2p1:Fuel>false</d2p1:Fuel>
      <d2p1:IsSmart>false</d2p1:IsSmart>
      <d2p1:IsSpecialised>false</d2p1:IsSpecialised>
      <d2p1:Line>false</d2p1:Line>
      <d2p1:Model>false</d2p1:Model>
      <d2p1:Packages>false</d2p1:Packages>
      <d2p1:PreferredDeliveryDate>false</d2p1:PreferredDeliveryDate>
      <d2p1:Transmission>false</d2p1:Transmission>
      <d2p1:Upholstery>false</d2p1:Upholstery>
      <d2p1:UrlReferrer>false</d2p1:UrlReferrer>
    </d2p1:CriteriaDifference>
    <d2p1:Equipment xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </d2p1:Equipment>
    <d2p1:Fuel xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </d2p1:Fuel>
    <d2p1:IsNewModel>false</d2p1:IsNewModel>
    <d2p1:IsSmart>false</d2p1:IsSmart>
    <d2p1:IsSpecialised>false</d2p1:IsSpecialised>
    <d2p1:Line xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </d2p1:Line>
    <d2p1:Model>
      <d2p1:CriteriaModel>
        <d2p1:Description>String</d2p1:Description>
        <d2p1:Id>0</d2p1:Id>
      </d2p1:CriteriaModel>
    </d2p1:Model>
    <d2p1:Packages xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </d2p1:Packages>
    <d2p1:PreferredDeliveryDate>String</d2p1:PreferredDeliveryDate>
    <d2p1:Transmission xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </d2p1:Transmission>
    <d2p1:Upholstery xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </d2p1:Upholstery>
    <d2p1:UrlReferrer>String</d2p1:UrlReferrer>
    <d2p1:Engine>
      <d2p1:V2EngineCriteria>
        <d2p1:Badge>String</d2p1:Badge>
        <d2p1:Brand>String</d2p1:Brand>
      </d2p1:V2EngineCriteria>
    </d2p1:Engine>
  </AgentCriteria>
  <AssistanceDetail>String</AssistanceDetail>
  <AssistanceProviderId>0</AssistanceProviderId>
  <ConfigCode>String</ConfigCode>
  <ConfiguratorCode>String</ConfiguratorCode>
  <Guid>00000000-0000-0000-0000-000000000000</Guid>
  <IsCOPConverter>false</IsCOPConverter>
  <IsOneAdminUpdate>false</IsOneAdminUpdate>
  <MotabilityPricingId>0</MotabilityPricingId>
</UpdateBackOrderRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<UpdateBackOrderResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mercedes.Agency.Orchestration.API.Clients.AgencyApi.Responses" />