AIM Web Services

<back to all web services

C2BAccessoryListingRequest

C2BAccessoryListing
Requires active-e Contracts Service.

The following routes are available for this service:
GET/api/C2BAccessoryListing
import Foundation
import ServiceStack

/**
* C2BAccessoryListingRequires active-e Contracts Service.
*/
// @DataContract
public class C2BAccessoryListingRequest : BaseSecureRequest
{
    /**
    * Defaults to True
    */
    // @DataMember
    // @ApiMember(Description="Defaults to True", Name="IncludeAccessories", ParameterType="query")
    public var includeAccessories:Bool?

    /**
    * Defaults to False
    */
    // @DataMember
    // @ApiMember(Description="Defaults to False", Name="IncludeDeliveryOptions", ParameterType="query")
    public var includeDeliveryOptions:Bool?

    /**
    * Defaults to False
    */
    // @DataMember
    // @ApiMember(Description="Defaults to False", Name="IncludeMaintenanceOptions", ParameterType="query")
    public var includeMaintenanceOptions:Bool?

    /**
    * If passed, only accessories for the given instrument are returned
    */
    // @DataMember
    // @ApiMember(Description="If passed, only accessories for the given instrument are returned", Name="InstrumentId", ParameterType="query")
    public var instrumentId:Int?

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

    private enum CodingKeys : String, CodingKey {
        case includeAccessories
        case includeDeliveryOptions
        case includeMaintenanceOptions
        case instrumentId
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        includeAccessories = try container.decodeIfPresent(Bool.self, forKey: .includeAccessories)
        includeDeliveryOptions = try container.decodeIfPresent(Bool.self, forKey: .includeDeliveryOptions)
        includeMaintenanceOptions = try container.decodeIfPresent(Bool.self, forKey: .includeMaintenanceOptions)
        instrumentId = try container.decodeIfPresent(Int.self, forKey: .instrumentId)
    }

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

// @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 C2BGetDistrictInfoResponse : BaseResponse
{
    // @DataMember
    public var districts:[C2BDistrictGeneric] = []

    // @DataMember
    public var teacherTableExists:Bool

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

    private enum CodingKeys : String, CodingKey {
        case districts
        case teacherTableExists
    }

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

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

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

    required public init(){}
}

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

GET /api/C2BAccessoryListing HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/json

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

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