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 GuidUpdate Back Order by Guid
import Foundation
import ServiceStack

public class UpdateBackOrderRequest : IPut, Codable
{
    public var guid:String
    public var agentCriteria:V2Criteria
    public var additionalInformation:String
    public var configCode:String
    public var motabilityPricingId:Int?
    public var assistanceProviderId:Int?
    public var assistanceDetail:String
    public var isCOPConverter:Bool
    public var configuratorCode:String
    public var isOneAdminUpdate:Bool

    required public init(){}
}

public class V2Criteria : CriteriaBase
{
    public var engine:[V2EngineCriteria] = []

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case engine
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        engine = try container.decodeIfPresent([V2EngineCriteria].self, forKey: .engine) ?? []
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if engine.count > 0 { try container.encode(engine, forKey: .engine) }
    }
}

public class CriteriaBase : JsonVersion
{
    public var transmission:[String] = []
    public var fuel:[String] = []
    public var upholstery:[String] = []
    public var equipment:[String] = []
    public var line:[String] = []
    public var bodyStyle:[String] = []
    public var colourGroup:[String] = []
    public var packages:[String] = []
    public var model:[CriteriaModel] = []
    public var urlReferrer:String
    public var preferredDeliveryDate:String
    public var bM7NST:String
    public var modelYearCode:String
    public var halfModelYearCode:String
    // @ApiMember(ExcludeInSchema=true)
    public var isNewModel:Bool

    // @ApiMember(ExcludeInSchema=true)
    public var isSmart:Bool

    // @ApiMember(ExcludeInSchema=true)
    public var isSpecialised:Bool

    // @ApiMember(ExcludeInSchema=true)
    public var criteriaDifference:CriteriaDifference

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case transmission
        case fuel
        case upholstery
        case equipment
        case line
        case bodyStyle
        case colourGroup
        case packages
        case model
        case urlReferrer
        case preferredDeliveryDate
        case bM7NST
        case modelYearCode
        case halfModelYearCode
        case isNewModel
        case isSmart
        case isSpecialised
        case criteriaDifference
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        transmission = try container.decodeIfPresent([String].self, forKey: .transmission) ?? []
        fuel = try container.decodeIfPresent([String].self, forKey: .fuel) ?? []
        upholstery = try container.decodeIfPresent([String].self, forKey: .upholstery) ?? []
        equipment = try container.decodeIfPresent([String].self, forKey: .equipment) ?? []
        line = try container.decodeIfPresent([String].self, forKey: .line) ?? []
        bodyStyle = try container.decodeIfPresent([String].self, forKey: .bodyStyle) ?? []
        colourGroup = try container.decodeIfPresent([String].self, forKey: .colourGroup) ?? []
        packages = try container.decodeIfPresent([String].self, forKey: .packages) ?? []
        model = try container.decodeIfPresent([CriteriaModel].self, forKey: .model) ?? []
        urlReferrer = try container.decodeIfPresent(String.self, forKey: .urlReferrer)
        preferredDeliveryDate = try container.decodeIfPresent(String.self, forKey: .preferredDeliveryDate)
        bM7NST = try container.decodeIfPresent(String.self, forKey: .bM7NST)
        modelYearCode = try container.decodeIfPresent(String.self, forKey: .modelYearCode)
        halfModelYearCode = try container.decodeIfPresent(String.self, forKey: .halfModelYearCode)
        isNewModel = try container.decodeIfPresent(Bool.self, forKey: .isNewModel)
        isSmart = try container.decodeIfPresent(Bool.self, forKey: .isSmart)
        isSpecialised = try container.decodeIfPresent(Bool.self, forKey: .isSpecialised)
        criteriaDifference = try container.decodeIfPresent(CriteriaDifference.self, forKey: .criteriaDifference)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if transmission.count > 0 { try container.encode(transmission, forKey: .transmission) }
        if fuel.count > 0 { try container.encode(fuel, forKey: .fuel) }
        if upholstery.count > 0 { try container.encode(upholstery, forKey: .upholstery) }
        if equipment.count > 0 { try container.encode(equipment, forKey: .equipment) }
        if line.count > 0 { try container.encode(line, forKey: .line) }
        if bodyStyle.count > 0 { try container.encode(bodyStyle, forKey: .bodyStyle) }
        if colourGroup.count > 0 { try container.encode(colourGroup, forKey: .colourGroup) }
        if packages.count > 0 { try container.encode(packages, forKey: .packages) }
        if model.count > 0 { try container.encode(model, forKey: .model) }
        if urlReferrer != nil { try container.encode(urlReferrer, forKey: .urlReferrer) }
        if preferredDeliveryDate != nil { try container.encode(preferredDeliveryDate, forKey: .preferredDeliveryDate) }
        if bM7NST != nil { try container.encode(bM7NST, forKey: .bM7NST) }
        if modelYearCode != nil { try container.encode(modelYearCode, forKey: .modelYearCode) }
        if halfModelYearCode != nil { try container.encode(halfModelYearCode, forKey: .halfModelYearCode) }
        if isNewModel != nil { try container.encode(isNewModel, forKey: .isNewModel) }
        if isSmart != nil { try container.encode(isSmart, forKey: .isSmart) }
        if isSpecialised != nil { try container.encode(isSpecialised, forKey: .isSpecialised) }
        if criteriaDifference != nil { try container.encode(criteriaDifference, forKey: .criteriaDifference) }
    }
}

public class JsonVersion : IJsonVersion, Codable
{
    public var version:Int

    required public init(){}
}

public class CriteriaModel : Codable
{
    public var Description:String
    public var id:Int

    required public init(){}
}

public class CriteriaDifference : Codable
{
    public var model:Bool
    public var transmission:Bool
    public var fuel:Bool
    public var upholstery:Bool
    public var equipment:Bool
    public var line:Bool
    public var bodyStyle:Bool
    public var colourGroup:Bool
    public var packages:Bool
    public var engine:Bool
    public var additionalInformation:Bool
    public var urlReferrer:Bool
    public var preferredDeliveryDate:Bool
    public var isSmart:Bool
    public var isSpecialised:Bool

    required public init(){}
}

public class V2EngineCriteria : Codable
{
    public var badge:String
    public var brand:String

    required public init(){}
}

public class UpdateBackOrderResponse : Codable
{
    required public init(){}
}


Swift UpdateBackOrderRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
Content-Type: application/json
Content-Length: length

{"Guid":"00000000000000000000000000000000","AgentCriteria":{"Engine":[{"Badge":"String","Brand":"String"}],"Transmission":["String"],"Fuel":["String"],"Upholstery":["String"],"Equipment":["String"],"Line":["String"],"BodyStyle":["String"],"ColourGroup":["String"],"Packages":["String"],"Model":[{"Description":"String","Id":0}],"UrlReferrer":"String","PreferredDeliveryDate":"String","BM7NST":"String","ModelYearCode":"String","HalfModelYearCode":"String","IsNewModel":false,"IsSmart":false,"IsSpecialised":false,"CriteriaDifference":{"Model":false,"Transmission":false,"Fuel":false,"Upholstery":false,"Equipment":false,"Line":false,"BodyStyle":false,"ColourGroup":false,"Packages":false,"Engine":false,"AdditionalInformation":false,"UrlReferrer":false,"PreferredDeliveryDate":false,"IsSmart":false,"IsSpecialised":false},"Version":0},"AdditionalInformation":"String","ConfigCode":"String","MotabilityPricingId":0,"AssistanceProviderId":0,"AssistanceDetail":"String","IsCOPConverter":false,"ConfiguratorCode":"String","IsOneAdminUpdate":false}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{}