AIM Web Services

<back to all web services

C2BGetDistrictInfoRequest

C2BGetDistrictInfo
Requires active-e Contracts Service.

The following routes are available for this service:
POST, GET/api/C2BGetDistrictInfo
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; }
        }

    }

    ///<summary>
    ///C2BGetDistrictInfoRequires active-e Contracts Service.
    ///</summary>
    [DataContract]
    public partial class C2BGetDistrictInfoRequest
        : BaseRequest
    {
        ///<summary>
        ///If sent, only districts with schools of the sent plan code will be returned.
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="If sent, only districts with schools of the sent plan code will be returned.", Format="date", Name="PlanCode", ParameterType="query")]
        public virtual string PlanCode { get; set; }

        ///<summary>
        ///ID of the Instrument record. Optional.
        ///</summary>
        [DataMember]
        [ApiMember(DataType="integer", Description="ID of the Instrument record. Optional.", Format="int64", Name="RinPk", ParameterType="query")]
        public virtual long? RinPk { get; set; }

        ///<summary>
        ///Optional Request Type. Valid values are Contract and Shipping.
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="Optional Request Type. Valid values are Contract and Shipping.", Name="RequestType", ParameterType="query")]
        public virtual string RequestType { 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# C2BGetDistrictInfoRequest 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/C2BGetDistrictInfo HTTP/1.1 
Host: active-ewebservice.biz 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"PlanCode":"String","RinPk":0,"RequestType":"String","ApiKey":"String","OAuthToken":"String"}

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

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