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

// @DataContract
export class BaseRequest
{
    /** @description 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 ApiKey: string;

    // @DataMember
    // @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
    public OAuthToken: string;

    public constructor(init?: Partial<BaseRequest>) { (Object as any).assign(this, init); }
}

// @DataContract
export class BaseResponseResult
{
    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
    public StatusCode: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
    public Login: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
    public ErrorCode: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
    public ErrorDisplayText: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
    public ErrorMessage: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")
    public DomainName: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
    public IpAddress: string;

    public constructor(init?: Partial<BaseResponseResult>) { (Object as any).assign(this, init); }
}

// @DataContract
export class BaseResponse
{
    /** @description  */
    // @DataMember
    // @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
    public Status: BaseResponseResult;

    public constructor(init?: Partial<BaseResponse>) { (Object as any).assign(this, init); }
}

// @DataContract
export class C2BDeliveryInfo
{
    // @DataMember
    public FirstDelivery: string;

    // @DataMember
    public DeliveryTime: string;

    // @DataMember
    public DeliveryThreshold: number;

    // @DataMember
    public SundayDelivery: boolean;

    // @DataMember
    public MondayDelivery: boolean;

    // @DataMember
    public TuesdayDelivery: boolean;

    // @DataMember
    public WednesdayDelivery: boolean;

    // @DataMember
    public ThursdayDelivery: boolean;

    // @DataMember
    public FridayDelivery: boolean;

    // @DataMember
    public SaturdayDelivery: boolean;

    public constructor(init?: Partial<C2BDeliveryInfo>) { (Object as any).assign(this, init); }
}

// @DataContract
export class C2BSchoolGeneric
{
    // @DataMember
    public SchoolName: string;

    // @DataMember
    public DistrictName: string;

    // @DataMember
    public TeacherCount: number;

    // @DataMember
    public Topic: string;

    // @DataMember
    public Id: number;

    // @DataMember
    public DeliveryInfo: C2BDeliveryInfo;

    // @DataMember
    public AIMSchoolId?: number;

    public constructor(init?: Partial<C2BSchoolGeneric>) { (Object as any).assign(this, init); }
}

// @DataContract
export class C2BGetSchoolInfoResponse extends BaseResponse
{
    // @DataMember
    public Schools: C2BSchoolGeneric[];

    public constructor(init?: Partial<C2BGetSchoolInfoResponse>) { super(init); (Object as any).assign(this, init); }
}

/** @description C2BGetSchoolInfoRequires active-e Contracts Service. */
// @DataContract
export class C2BGetSchoolInfoRequest extends BaseRequest
{
    /** @description If sent, only schools associated with the sent plan code will be returned. */
    // @DataMember
    // @ApiMember(DataType="string", Description="If sent, only schools associated with the sent plan code will be returned.", Name="PlanCode", ParameterType="query")
    public PlanCode: string;

    /** @description If sent, only schools associated with the sent district will be returned. */
    // @DataMember
    // @ApiMember(DataType="integer", Description="If sent, only schools associated with the sent district will be returned.", Format="int64", Name="DistrictId", ParameterType="query")
    public DistrictId?: number;

    /** @description ID of the Instrument record. Optional. */
    // @DataMember
    // @ApiMember(DataType="integer", Description="ID of the Instrument record. Optional.", Format="int64", Name="RinPk", ParameterType="query")
    public RinPk?: number;

    /** @description Optional Request Type. Valid values are Contract and Shipping. */
    // @DataMember
    // @ApiMember(DataType="string", Description="Optional Request Type. Valid values are Contract and Shipping.", Name="RequestType", ParameterType="query")
    public RequestType: string;

    public constructor(init?: Partial<C2BGetSchoolInfoRequest>) { super(init); (Object as any).assign(this, init); }
}

TypeScript 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>