AIM Web Services

<back to all web services

C2BGetInstrumentDetailRequest

C2BGetInstrumentDetail
Requires active-e Contracts Service.

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

/**
* C2BGetInstrumentDetailRequires active-e Contracts Service.
*/
// @DataContract
public class C2BGetInstrumentDetailRequest : BaseSecureRequest
{
    /**
    * ID of the Teacher/Instrument record. Either this *or* TeacherId + InstrumentId must be sent.
    */
    // @DataMember
    // @ApiMember(DataType="integer", Description="ID of the Teacher/Instrument record. Either this *or* TeacherId + InstrumentId must be sent.", Format="int64", Name="RsiPk", ParameterType="query")
    public var rsiPk:Int?

    /**
    * ID of the Teacher record. Either this+InstrumentID *or* RsiPk must be sent.
    */
    // @DataMember
    // @ApiMember(DataType="integer", Description="ID of the Teacher record. Either this+InstrumentID *or* RsiPk must be sent.", Format="int64", Name="TeacherId", ParameterType="query")
    public var teacherId:Int?

    /**
    * ID of the Instrument record. Either this+TeacherID *or* RsiPk must be sent.
    */
    // @DataMember
    // @ApiMember(DataType="integer", Description="ID of the Instrument record. Either this+TeacherID *or* RsiPk must be sent.", Format="int64", Name="InstrumentId", ParameterType="query")
    public var instrumentId:Int?

    /**
    * ID of the Rate to be used. This is required.
    */
    // @DataMember
    // @ApiMember(DataType="integer", Description="ID of the Rate to be used. This is required.", Format="int64", IsRequired=true, Name="RateId", ParameterType="query")
    public var rateId:Int?

    /**
    * If 'Y', then Mobile Layout will be returned.
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="If 'Y', then Mobile Layout will be returned.", Name="IncludeMobileLayout", ParameterType="query")
    public var includeMobileLayout:String

    /**
    * ID of the Delivery option to be used.
    */
    // @DataMember
    // @ApiMember(DataType="integer", Description="ID of the Delivery option to be used.", Format="int64", IsRequired=true, Name="DeliveryId", ParameterType="query")
    public var deliveryId:Int?

    /**
    * ID of the Location. Used for Location required Delivery options.
    */
    // @DataMember
    // @ApiMember(DataType="integer", Description="ID of the Location. Used for Location required Delivery options.", Format="int64", IsRequired=true, Name="LocationId", ParameterType="query")
    public var locationId:Int?

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

    private enum CodingKeys : String, CodingKey {
        case rsiPk
        case teacherId
        case instrumentId
        case rateId
        case includeMobileLayout
        case deliveryId
        case locationId
    }

    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)
        instrumentId = try container.decodeIfPresent(Int.self, forKey: .instrumentId)
        rateId = try container.decodeIfPresent(Int.self, forKey: .rateId)
        includeMobileLayout = try container.decodeIfPresent(String.self, forKey: .includeMobileLayout)
        deliveryId = try container.decodeIfPresent(Int.self, forKey: .deliveryId)
        locationId = try container.decodeIfPresent(Int.self, forKey: .locationId)
    }

    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 instrumentId != nil { try container.encode(instrumentId, forKey: .instrumentId) }
        if rateId != nil { try container.encode(rateId, forKey: .rateId) }
        if includeMobileLayout != nil { try container.encode(includeMobileLayout, forKey: .includeMobileLayout) }
        if deliveryId != nil { try container.encode(deliveryId, forKey: .deliveryId) }
        if locationId != nil { try container.encode(locationId, forKey: .locationId) }
    }
}

// @DataContract
public class BaseSecureRequest : BaseRequest
{
    /**
    * The Login Token return by the Security API. Required for secured calls.
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="The Login Token return by the Security API. Required for secured calls.", Name="Token", ParameterType="Header")
    public var token:String

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

    private enum CodingKeys : String, CodingKey {
        case token
    }

    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)
    }

    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) }
    }
}

// @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

    /**
    * The OAuthToken token return by AeServices30
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="The OAuthToken token return by AeServices30", IsRequired=true, Name="OAuthToken", ParameterType="Header")
    public var oAuthToken:String

    /**
    * The Device ID of the Mobile Device. Not used for non-mobile devices.
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="The Device ID of the Mobile Device. Not used for non-mobile devices.", Name="DeviceId", ParameterType="Header")
    public var deviceId:String

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

    required public init(){}
}

// @DataContract
public class C2BGetInstrumentDetailResponse : BaseResponse
{
    // @DataMember
    public var instrumentDetails:C2BInstrumentDetailGeneric

    // @DataMember
    public var mobileLayout:MobileLayout

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

    private enum CodingKeys : String, CodingKey {
        case instrumentDetails
        case mobileLayout
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        instrumentDetails = try container.decodeIfPresent(C2BInstrumentDetailGeneric.self, forKey: .instrumentDetails)
        mobileLayout = try container.decodeIfPresent(MobileLayout.self, forKey: .mobileLayout)
    }

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

// @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 C2BInstrumentDetailGeneric : Codable
{
    // @DataMember
    public var planCode:C2BPlanCodeGeneric

    // @DataMember
    public var teacher:C2BTeacherGeneric

    // @DataMember
    public var school:C2BSchoolGeneric

    // @DataMember
    public var deliveryDate:String

    // @DataMember
    public var salesPerson:String

    // @DataMember
    public var district:C2BDistrictGeneric

    // @DataMember
    public var instrument:C2BInstrumentGeneric

    // @DataMember
    public var grade:C2BGradeGeneric

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

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

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

    required public init(){}
}

// @DataContract
public class C2BPlanCodeGeneric : Codable
{
    // @DataMember
    public var code:String

    // @DataMember
    public var name:String

    // @DataMember
    public var months:Int

    // @DataMember
    public var topic:String

    // @DataMember
    public var url:String

    // @DataMember
    public var finalTopic:String

    required public init(){}
}

// @DataContract
public class C2BTeacherGeneric : Codable
{
    // @DataMember
    public var teacherName:String

    // @DataMember
    public var schoolName:String

    // @DataMember
    public var districtName:String

    // @DataMember
    public var topic:String

    // @DataMember
    public var id:Int

    // @DataMember
    public var deliveryInfo:C2BDeliveryInfo

    // @DataMember
    public var aimSchoolId:Int?

    required public init(){}
}

// @DataContract
public class C2BDeliveryInfo : Codable
{
    // @DataMember
    public var firstDelivery:Date

    // @DataMember
    public var deliveryTime:Date

    // @DataMember
    public var deliveryThreshold:Int

    // @DataMember
    public var sundayDelivery:Bool

    // @DataMember
    public var mondayDelivery:Bool

    // @DataMember
    public var tuesdayDelivery:Bool

    // @DataMember
    public var wednesdayDelivery:Bool

    // @DataMember
    public var thursdayDelivery:Bool

    // @DataMember
    public var fridayDelivery:Bool

    // @DataMember
    public var saturdayDelivery:Bool

    required public init(){}
}

// @DataContract
public class C2BSchoolGeneric : Codable
{
    // @DataMember
    public var schoolName:String

    // @DataMember
    public var districtName:String

    // @DataMember
    public var teacherCount:Int

    // @DataMember
    public var topic:String

    // @DataMember
    public var id:Int

    // @DataMember
    public var deliveryInfo:C2BDeliveryInfo

    // @DataMember
    public var aimSchoolId:Int?

    required public init(){}
}

// @DataContract
public class C2BDistrictGeneric : Codable
{
    // @DataMember
    public var districtName:String

    // @DataMember
    public var schoolCount:Int

    // @DataMember
    public var teacherCount:Int

    // @DataMember
    public var topic:String

    // @DataMember
    public var id:Int

    // @DataMember
    public var state: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(){}
}

// @DataContract
public class MobileLayout : Codable
{
    // @DataMember
    public var title:String

    // @DataMember
    public var returnurl:String

    // @DataMember
    public var sections:[Section] = []

    required public init(){}
}

// @DataContract
public class Section : Codable
{
    // @DataMember
    public var header:String

    // @DataMember
    public var id:String

    // @DataMember
    public var margin:String

    // @DataMember
    public var elements:[Element] = []

    required public init(){}
}

// @DataContract
public class Element : Codable
{
    // @DataMember
    public var type:String

    // @DataMember
    public var label:String

    // @DataMember
    public var id:String

    // @DataMember
    public var fontsize:String

    // @DataMember
    public var margin:String

    // @DataMember
    public var backgroundcolor:String

    // @DataMember
    public var textcolor:String

    // @DataMember
    public var height:String

    // @DataMember
    public var width:String

    // @DataMember
    public var value:String

    // @DataMember
    public var addvalue:Bool

    // @DataMember
    public var values:[String] = []

    // @DataMember
    public var textalign:String

    // @DataMember
    public var required:Bool?

    // @DataMember
    public var placeholder:String

    // @DataMember
    public var fontbold:Bool?

    // @DataMember
    public var selected:Bool?

    // @DataMember
    public var disabled:Bool?

    // @DataMember
    public var totalamount:Bool?

    // @DataMember
    public var elements:[Element] = []

    // @DataMember
    public var map:[LicenseMap] = []

    required public init(){}
}

// @DataContract
public class LicenseMap : Codable
{
    // @DataMember
    public var name:String

    // @DataMember
    public var value:String

    required public init(){}
}

Swift C2BGetInstrumentDetailRequest 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 /api/C2BGetInstrumentDetail HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<C2BGetInstrumentDetailRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
  <ApiKey>String</ApiKey>
  <AppId>String</AppId>
  <DeviceId>String</DeviceId>
  <OAuthToken>String</OAuthToken>
  <Token>String</Token>
  <DeliveryId>0</DeliveryId>
  <IncludeMobileLayout>String</IncludeMobileLayout>
  <InstrumentId>0</InstrumentId>
  <LocationId>0</LocationId>
  <RateId>0</RateId>
  <RsiPk>0</RsiPk>
  <TeacherId>0</TeacherId>
</C2BGetInstrumentDetailRequest>

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

<C2BGetInstrumentDetailResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
  <Status>
    <DomainName>String</DomainName>
    <ErrorCode>String</ErrorCode>
    <ErrorDisplayText>String</ErrorDisplayText>
    <ErrorMessage>String</ErrorMessage>
    <IpAddress>String</IpAddress>
    <Login>String</Login>
    <StatusCode>String</StatusCode>
  </Status>
  <InstrumentDetails xmlns:d2p1="http://schemas.datacontract.org/2004/07/AIM" i:nil="true" />
  <MobileLayout xmlns:d2p1="http://schemas.datacontract.org/2004/07/AIM.BL.Core.ExternalAPIs.MobileRentals">
    <d2p1:returnurl>String</d2p1:returnurl>
    <d2p1:sections>
      <d2p1:MobileLayout.Section>
        <d2p1:elements>
          <d2p1:MobileLayout.Element>
            <d2p1:addvalue>false</d2p1:addvalue>
            <d2p1:backgroundcolor>String</d2p1:backgroundcolor>
            <d2p1:disabled>false</d2p1:disabled>
            <d2p1:elements i:nil="true" />
            <d2p1:fontbold>false</d2p1:fontbold>
            <d2p1:fontsize>String</d2p1:fontsize>
            <d2p1:height>String</d2p1:height>
            <d2p1:id>String</d2p1:id>
            <d2p1:label>String</d2p1:label>
            <d2p1:map i:nil="true" />
            <d2p1:margin>String</d2p1:margin>
            <d2p1:placeholder>String</d2p1:placeholder>
            <d2p1:required>false</d2p1:required>
            <d2p1:selected>false</d2p1:selected>
            <d2p1:textalign>String</d2p1:textalign>
            <d2p1:textcolor>String</d2p1:textcolor>
            <d2p1:totalamount>false</d2p1:totalamount>
            <d2p1:type>String</d2p1:type>
            <d2p1:value>String</d2p1:value>
            <d2p1:values xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:string>String</d7p1:string>
            </d2p1:values>
            <d2p1:width>String</d2p1:width>
          </d2p1:MobileLayout.Element>
        </d2p1:elements>
        <d2p1:header>String</d2p1:header>
        <d2p1:id>String</d2p1:id>
        <d2p1:margin>String</d2p1:margin>
      </d2p1:MobileLayout.Section>
    </d2p1:sections>
    <d2p1:title>String</d2p1:title>
  </MobileLayout>
</C2BGetInstrumentDetailResponse>