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
namespace AIM

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<DataContract>]
    [<AllowNullLiteral>]
    type BaseResponseResult() = 
        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")>]
        member val StatusCode:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")>]
        member val Login:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")>]
        member val ErrorCode:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")>]
        member val ErrorDisplayText:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")>]
        member val ErrorMessage:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")>]
        member val DomainName:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")>]
        member val IpAddress:String = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type BaseResponse() = 
        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")>]
        member val Status:BaseResponseResult = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type C2BDistrictGeneric() = 
        [<DataMember>]
        member val DistrictName:String = null with get,set

        [<DataMember>]
        member val SchoolCount:Int32 = new Int32() with get,set

        [<DataMember>]
        member val TeacherCount:Int32 = new Int32() with get,set

        [<DataMember>]
        member val Topic:String = null with get,set

        [<DataMember>]
        member val Id:Int64 = new Int64() with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type C2BGetDistrictInfoResponse() = 
        inherit BaseResponse()
        [<DataMember>]
        member val Districts:ResizeArray<C2BDistrictGeneric> = new ResizeArray<C2BDistrictGeneric>() with get,set

        [<DataMember>]
        member val TeacherTableExists:Boolean = new Boolean() with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type BaseRequest() = 
        ///<summary>
        ///This is your AIM API Key provided by Tri-Tech
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="This is your AIM API Key provided by Tri-Tech", IsRequired=true, Name="ApiKey", ParameterType="header")>]
        member val ApiKey:String = null with get,set

        [<DataMember>]
        [<ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")>]
        member val OAuthToken:String = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type BaseSecureRequest() = 
        inherit BaseRequest()
        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")>]
        member val Token:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")>]
        member val DeviceId:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")>]
        member val AppId:String = null with get,set

    ///<summary>
    ///C2BAccessoryListingRequires active-e Contracts Service.
    ///</summary>
    [<DataContract>]
    [<AllowNullLiteral>]
    type C2BAccessoryListingRequest() = 
        inherit BaseSecureRequest()
        ///<summary>
        ///Defaults to True
        ///</summary>
        [<DataMember>]
        [<ApiMember(Description="Defaults to True", Name="IncludeAccessories", ParameterType="query")>]
        member val IncludeAccessories:Nullable<Boolean> = new Nullable<Boolean>() with get,set

        ///<summary>
        ///Defaults to False
        ///</summary>
        [<DataMember>]
        [<ApiMember(Description="Defaults to False", Name="IncludeDeliveryOptions", ParameterType="query")>]
        member val IncludeDeliveryOptions:Nullable<Boolean> = new Nullable<Boolean>() with get,set

        ///<summary>
        ///Defaults to False
        ///</summary>
        [<DataMember>]
        [<ApiMember(Description="Defaults to False", Name="IncludeMaintenanceOptions", ParameterType="query")>]
        member val IncludeMaintenanceOptions:Nullable<Boolean> = new Nullable<Boolean>() with get,set

        ///<summary>
        ///If passed, only accessories for the given instrument are returned
        ///</summary>
        [<DataMember>]
        [<ApiMember(Description="If passed, only accessories for the given instrument are returned", Name="InstrumentId", ParameterType="query")>]
        member val InstrumentId:Nullable<Int64> = new Nullable<Int64>() with get,set

F# C2BAccessoryListingRequest 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.

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

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

<C2BGetDistrictInfoResponse 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>
  <Districts xmlns:d2p1="http://schemas.datacontract.org/2004/07/AIM">
    <d2p1:C2BDistrictGeneric i:nil="true" />
  </Districts>
  <TeacherTableExists>false</TeacherTableExists>
</C2BGetDistrictInfoResponse>