AIM Web Services

<back to all web services

C2BGetSchoolInfoRequest

C2BGetSchoolInfo
Requires active-e Contracts Service.

The following routes are available for this service:
POST, GET/api/C2BGetSchoolInfo
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports AIM.WebService
Imports AIM

Namespace Global

    Namespace AIM

        <DataContract>
        Public Partial Class C2BDeliveryInfo
            <DataMember>
            Public Overridable Property FirstDelivery As Date

            <DataMember>
            Public Overridable Property DeliveryTime As Date

            <DataMember>
            Public Overridable Property DeliveryThreshold As Integer

            <DataMember>
            Public Overridable Property SundayDelivery As Boolean

            <DataMember>
            Public Overridable Property MondayDelivery As Boolean

            <DataMember>
            Public Overridable Property TuesdayDelivery As Boolean

            <DataMember>
            Public Overridable Property WednesdayDelivery As Boolean

            <DataMember>
            Public Overridable Property ThursdayDelivery As Boolean

            <DataMember>
            Public Overridable Property FridayDelivery As Boolean

            <DataMember>
            Public Overridable Property SaturdayDelivery As Boolean
        End Class

        <DataContract>
        Public Partial Class C2BSchoolGeneric
            <DataMember>
            Public Overridable Property SchoolName As String

            <DataMember>
            Public Overridable Property DistrictName As String

            <DataMember>
            Public Overridable Property TeacherCount As Integer

            <DataMember>
            Public Overridable Property Topic As String

            <DataMember>
            Public Overridable Property Id As Long

            <DataMember>
            Public Overridable Property DeliveryInfo As C2BDeliveryInfo

            <DataMember>
            Public Overridable Property AIMSchoolId As Nullable(Of Long)
        End Class
    End Namespace

    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 Overridable Property ApiKey As String

            <DataMember>
            <ApiMember(DataType:="string", Name:="OAuthToken", ParameterType:="header")>
            Public Overridable Property OAuthToken As String
        End Class

        <DataContract>
        Public Partial Class BaseResponse
            '''<Summary>
            '''
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="BaseResponseResult", Description:="", Name:="Status", ParameterType:="body")>
            Public Overridable Property Status As BaseResponseResult

            <DataContract>
            Public Partial Class BaseResponseResult
                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", Name:="StatusCode", ParameterType:="body")>
                Public Overridable Property StatusCode As String

                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", Name:="Login", ParameterType:="body")>
                Public Overridable Property Login As String

                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", Name:="ErrorCode", ParameterType:="body")>
                Public Overridable Property ErrorCode As String

                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", Name:="ErrorDisplayText", ParameterType:="body")>
                Public Overridable Property ErrorDisplayText As String

                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", Name:="ErrorMessage", ParameterType:="body")>
                Public Overridable Property ErrorMessage As String

                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", ExcludeInSchema:=true, Name:="DomainName", ParameterType:="body")>
                Public Overridable Property DomainName As String

                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", ExcludeInSchema:=true, Name:="IPAddress", ParameterType:="body")>
                Public Overridable Property IpAddress As String
            End Class
        End Class

        '''<Summary>
        '''C2BGetSchoolInfoRequires active-e Contracts Service.
        '''</Summary>
        <DataContract>
        Public Partial Class C2BGetSchoolInfoRequest
            Inherits BaseRequest
            '''<Summary>
            '''If sent, only schools associated with the sent plan code will be returned.
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="If sent, only schools associated with the sent plan code will be returned.", Name:="PlanCode", ParameterType:="query")>
            Public Overridable Property PlanCode As String

            '''<Summary>
            '''If sent, only schools associated with the sent district will be returned.
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="integer", Description:="If sent, only schools associated with the sent district will be returned.", Format:="int64", Name:="DistrictId", ParameterType:="query")>
            Public Overridable Property DistrictId As Nullable(Of Long)

            '''<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 Overridable Property RinPk As Nullable(Of Long)

            '''<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 Overridable Property RequestType As String
        End Class

        <DataContract>
        Public Partial Class C2BGetSchoolInfoResponse
            Inherits BaseResponse
            Public Sub New()
                Schools = New List(Of C2BSchoolGeneric)
            End Sub

            <DataMember>
            Public Overridable Property Schools As List(Of C2BSchoolGeneric)
        End Class
    End Namespace
End Namespace

VB.NET C2BGetSchoolInfoRequest 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/C2BGetSchoolInfo HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<C2BGetSchoolInfoRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
  <ApiKey>String</ApiKey>
  <OAuthToken>String</OAuthToken>
  <DistrictId>0</DistrictId>
  <PlanCode>String</PlanCode>
  <RequestType>String</RequestType>
  <RinPk>0</RinPk>
</C2BGetSchoolInfoRequest>

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

<C2BGetSchoolInfoResponse 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>
  <Schools xmlns:d2p1="http://schemas.datacontract.org/2004/07/AIM">
    <d2p1:C2BSchoolGeneric i:nil="true" />
  </Schools>
</C2BGetSchoolInfoResponse>