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
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using AIM.WebService;
using AIM;

namespace AIM
{
    [DataContract]
    public partial class C2BDistrictGeneric
    {
        [DataMember]
        public virtual string DistrictName { get; set; }

        [DataMember]
        public virtual int SchoolCount { get; set; }

        [DataMember]
        public virtual int TeacherCount { get; set; }

        [DataMember]
        public virtual string Topic { get; set; }

        [DataMember]
        public virtual long Id { get; set; }
    }

}

namespace AIM.WebService
{
    [DataContract]
    public partial class 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")]
        public virtual string ApiKey { get; set; }

        [DataMember]
        [ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")]
        public virtual string OAuthToken { get; set; }
    }

    [DataContract]
    public partial class BaseResponse
    {
        ///<summary>
        ///
        ///</summary>
        [DataMember]
        [ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")]
        public virtual BaseResponseResult Status { get; set; }
        [DataContract]
        public partial class BaseResponseResult
        {
            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")]
            public virtual string StatusCode { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")]
            public virtual string Login { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")]
            public virtual string ErrorCode { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")]
            public virtual string ErrorDisplayText { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")]
            public virtual string ErrorMessage { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")]
            public virtual string DomainName { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")]
            public virtual string IpAddress { get; set; }
        }

    }

    [DataContract]
    public partial class BaseSecureRequest
        : BaseRequest
    {
        ///<summary>
        ///
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")]
        public virtual string Token { get; set; }

        ///<summary>
        ///
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")]
        public virtual string DeviceId { get; set; }

        ///<summary>
        ///
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")]
        public virtual string AppId { get; set; }
    }

    ///<summary>
    ///C2BAccessoryListingRequires active-e Contracts Service.
    ///</summary>
    [DataContract]
    public partial class C2BAccessoryListingRequest
        : BaseSecureRequest
    {
        ///<summary>
        ///Defaults to True
        ///</summary>
        [DataMember]
        [ApiMember(Description="Defaults to True", Name="IncludeAccessories", ParameterType="query")]
        public virtual bool? IncludeAccessories { get; set; }

        ///<summary>
        ///Defaults to False
        ///</summary>
        [DataMember]
        [ApiMember(Description="Defaults to False", Name="IncludeDeliveryOptions", ParameterType="query")]
        public virtual bool? IncludeDeliveryOptions { get; set; }

        ///<summary>
        ///Defaults to False
        ///</summary>
        [DataMember]
        [ApiMember(Description="Defaults to False", Name="IncludeMaintenanceOptions", ParameterType="query")]
        public virtual bool? IncludeMaintenanceOptions { 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")]
        public virtual long? InstrumentId { get; set; }
    }

    [DataContract]
    public partial class C2BGetDistrictInfoResponse
        : BaseResponse
    {
        public C2BGetDistrictInfoResponse()
        {
            Districts = new List<C2BDistrictGeneric>{};
        }

        [DataMember]
        public virtual List<C2BDistrictGeneric> Districts { get; set; }

        [DataMember]
        public virtual bool TeacherTableExists { get; set; }
    }

}

C# 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>