AIM Web Services

<back to all web services

C2BGetInstrumentInfoRequest

C2BGetInstrumentInfo
Requires active-e Contracts Service.

The following routes are available for this service:
POST, GET/api/C2BGetInstrumentInfo
import Foundation
import ServiceStack

/**
* C2BGetInstrumentInfoRequires active-e Contracts Service.
*/
// @DataContract
public class C2BGetInstrumentInfoRequest : BaseSecureRequest
{
    /**
    * ID of the Teacher/Instrument record.
    */
    // @DataMember
    // @ApiMember(DataType="integer", Description="ID of the Teacher/Instrument record.", Format="int64", Name="RsiPk", ParameterType="query")
    public var rsiPk:Int?

    /**
    * ID of the Teacher record.
    */
    // @DataMember
    // @ApiMember(DataType="integer", Description="ID of the Teacher record.", Format="int64", Name="TeacherId", ParameterType="query")
    public var teacherId:Int?

    /**
    * Optional Plan Code Override. If not sent, plancode from the school will be used.
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="Optional Plan Code Override. If not sent, plancode from the school will be used.", Name="PlanCode", ParameterType="query")
    public var planCode:String

    /**
    * If set to false, less details will be sent. Defaults to True.
    */
    // @DataMember
    // @ApiMember(DataType="boolean", Description="If set to false, less details will be sent. Defaults to True.", Name="GetDetails", ParameterType="query")
    public var getDetails:Bool?

    /**
    * If set to true, Out of Stock items will be included.
    */
    // @DataMember
    // @ApiMember(DataType="boolean", Description="If set to true, Out of Stock items will be included.", Name="IncludeOutOfStockItems", ParameterType="query")
    public var includeOutOfStockItems:Bool?

    /**
    * If set to true, each instrument will include a list of accessory options. Defaults to False.
    */
    // @DataMember
    // @ApiMember(DataType="boolean", Description="If set to true, each instrument will include a list of accessory options. Defaults to False.", Name="IncludeAccessoryOptions", ParameterType="query")
    public var includeAccessoryOptions:Bool?

    /**
    * If set to true, each instrument will include a list of delivery options. Defaults to False.
    */
    // @DataMember
    // @ApiMember(DataType="boolean", Description="If set to true, each instrument will include a list of delivery options. Defaults to False.", Name="IncludeDeliveryOptions", ParameterType="query")
    public var includeDeliveryOptions:Bool?

    /**
    * If set to true, each instrument will include a list of maintenance options. Defaults to False.
    */
    // @DataMember
    // @ApiMember(DataType="boolean", Description="If set to true, each instrument will include a list of maintenance options. Defaults to False.", Name="IncludeMaintenanceOptions", ParameterType="query")
    public var includeMaintenanceOptions:Bool?

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

    private enum CodingKeys : String, CodingKey {
        case rsiPk
        case teacherId
        case planCode
        case getDetails
        case includeOutOfStockItems
        case includeAccessoryOptions
        case includeDeliveryOptions
        case includeMaintenanceOptions
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        rsiPk = try container.decodeIfPresent(Int.self, forKey: .rsiPk)
        teacherId = try container.decodeIfPresent(Int.self, forKey: .teacherId)
        planCode = try container.decodeIfPresent(String.self, forKey: .planCode)
        getDetails = try container.decodeIfPresent(Bool.self, forKey: .getDetails)
        includeOutOfStockItems = try container.decodeIfPresent(Bool.self, forKey: .includeOutOfStockItems)
        includeAccessoryOptions = try container.decodeIfPresent(Bool.self, forKey: .includeAccessoryOptions)
        includeDeliveryOptions = try container.decodeIfPresent(Bool.self, forKey: .includeDeliveryOptions)
        includeMaintenanceOptions = try container.decodeIfPresent(Bool.self, forKey: .includeMaintenanceOptions)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if rsiPk != nil { try container.encode(rsiPk, forKey: .rsiPk) }
        if teacherId != nil { try container.encode(teacherId, forKey: .teacherId) }
        if planCode != nil { try container.encode(planCode, forKey: .planCode) }
        if getDetails != nil { try container.encode(getDetails, forKey: .getDetails) }
        if includeOutOfStockItems != nil { try container.encode(includeOutOfStockItems, forKey: .includeOutOfStockItems) }
        if includeAccessoryOptions != nil { try container.encode(includeAccessoryOptions, forKey: .includeAccessoryOptions) }
        if includeDeliveryOptions != nil { try container.encode(includeDeliveryOptions, forKey: .includeDeliveryOptions) }
        if includeMaintenanceOptions != nil { try container.encode(includeMaintenanceOptions, forKey: .includeMaintenanceOptions) }
    }
}

// @DataContract
public class BaseSecureRequest : BaseRequest
{
    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")
    public var token:String

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")
    public var deviceId:String

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")
    public var appId:String

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

    private enum CodingKeys : String, CodingKey {
        case token
        case deviceId
        case appId
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        token = try container.decodeIfPresent(String.self, forKey: .token)
        deviceId = try container.decodeIfPresent(String.self, forKey: .deviceId)
        appId = try container.decodeIfPresent(String.self, forKey: .appId)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if token != nil { try container.encode(token, forKey: .token) }
        if deviceId != nil { try container.encode(deviceId, forKey: .deviceId) }
        if appId != nil { try container.encode(appId, forKey: .appId) }
    }
}

// @DataContract
public class BaseRequest : Codable
{
    /**
    * This is your AIM API Key provided by Tri-Tech
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="This is your AIM API Key provided by Tri-Tech", IsRequired=true, Name="ApiKey", ParameterType="header")
    public var apiKey:String

    // @DataMember
    // @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
    public var oAuthToken:String

    required public init(){}
}

// @DataContract
public class C2BGetInstrumentInfoResponse : BaseResponse
{
    // @DataMember
    public var instruments:[C2BInstrumentGeneric] = []

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

    private enum CodingKeys : String, CodingKey {
        case instruments
    }

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

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

// @DataContract
public class BaseResponse : Codable
{
    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
    public var status:BaseResponseResult

    required public init(){}
}

// @DataContract
public class BaseResponseResult : Codable
{
    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
    public var statusCode:String

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
    public var login:String

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
    public var errorCode:String

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
    public var errorDisplayText:String

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
    public var errorMessage:String

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")
    public var domainName:String

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
    public var ipAddress:String

    required public init(){}
}

// @DataContract
public class C2BInstrumentGeneric : Codable
{
    // @DataMember
    public var instrumentName:String

    // @DataMember
    public var sku:String

    // @DataMember
    public var topic:String

    // @DataMember
    public var image:String

    // @DataMember
    public var level:Int

    // @DataMember
    public var rentPrice:Double?

    // @DataMember
    public var cashPrice:Double?

    // @DataMember
    public var token:String

    // @DataMember
    public var instrumentId:Int

    // @DataMember
    public var instrumentTeacherId:Int

    // @DataMember
    public var gradeList:[C2BGradeGeneric] = []

    // @DataMember
    public var hasGrades:Bool

    // @DataMember
    public var displayOrder:Int

    // @DataMember
    public var accessoryList:[C2BAccessoryGeneric] = []

    // @DataMember
    public var deliveryList:[C2BAccessoryGeneric] = []

    // @DataMember
    public var maintenanceList:[C2BAccessoryGeneric] = []

    required public init(){}
}

// @DataContract
public class C2BGradeGeneric : Codable
{
    // @DataMember
    public var level:Int

    // @DataMember
    public var grade:String

    // @DataMember
    public var downPay:Double

    // @DataMember
    public var downMaint:Double

    // @DataMember
    public var moPay:Double

    // @DataMember
    public var moMaint:Double

    // @DataMember
    public var id:Int

    // @DataMember
    public var outOfStock:Bool

    // @DataMember
    public var rentPrice:Double

    // @DataMember
    public var cashPrice:Double

    // @DataMember
    public var downPayTax:Double?

    // @DataMember
    public var downMaintTax:Double?

    // @DataMember
    public var moPayTax:Double?

    // @DataMember
    public var moMaintTax:Double?

    // @DataMember
    public var rentPricePlusTax:Double

    // @DataMember
    public var rentPricePlusTaxLessDownpay:Double

    // @DataMember
    public var months:Int

    required public init(){}
}

// @DataContract
public class C2BAccessoryGeneric : Codable
{
    // @DataMember
    public var accessoryDesc:String

    // @DataMember
    public var price:Double

    // @DataMember
    public var required:Bool

    // @DataMember
    public var `default`:Bool

    // @DataMember
    public var requiresLocation:Bool

    // @DataMember
    public var type:String

    // @DataMember
    public var topic:String

    // @DataMember
    public var id:Int

    // @DataMember
    public var displayOrder:Int

    // @DataMember
    public var sku:String

    // @DataMember
    public var taxAmount:Double?

    // @DataMember
    public var catNum:Int?

    required public init(){}
}

Swift C2BGetInstrumentInfoRequest DTOs

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

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/C2BGetInstrumentInfo HTTP/1.1 
Host: active-ewebservice.biz 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"RsiPk":0,"TeacherId":0,"PlanCode":"String","GetDetails":false,"IncludeOutOfStockItems":false,"IncludeAccessoryOptions":false,"IncludeDeliveryOptions":false,"IncludeMaintenanceOptions":false,"Token":"String","DeviceId":"String","AppId":"String","ApiKey":"String","OAuthToken":"String"}

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"Instruments":[{}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}