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
"use strict";
export class BaseRequest {
    /** @param {{ApiKey?:string,OAuthToken?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description This is your AIM API Key provided by Tri-Tech */
    ApiKey;
    /** @type {string} */
    OAuthToken;
}
export class BaseResponseResult {
    /** @param {{StatusCode?:string,Login?:string,ErrorCode?:string,ErrorDisplayText?:string,ErrorMessage?:string,DomainName?:string,IpAddress?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    StatusCode;
    /** @type {string} */
    Login;
    /** @type {string} */
    ErrorCode;
    /** @type {string} */
    ErrorDisplayText;
    /** @type {string} */
    ErrorMessage;
    /** @type {string} */
    DomainName;
    /** @type {string} */
    IpAddress;
}
export class BaseResponse {
    /** @param {{Status?:BaseResponseResult}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {BaseResponseResult} */
    Status;
}
export class C2BDeliveryInfo {
    /** @param {{FirstDelivery?:string,DeliveryTime?:string,DeliveryThreshold?:number,SundayDelivery?:boolean,MondayDelivery?:boolean,TuesdayDelivery?:boolean,WednesdayDelivery?:boolean,ThursdayDelivery?:boolean,FridayDelivery?:boolean,SaturdayDelivery?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    FirstDelivery;
    /** @type {string} */
    DeliveryTime;
    /** @type {number} */
    DeliveryThreshold;
    /** @type {boolean} */
    SundayDelivery;
    /** @type {boolean} */
    MondayDelivery;
    /** @type {boolean} */
    TuesdayDelivery;
    /** @type {boolean} */
    WednesdayDelivery;
    /** @type {boolean} */
    ThursdayDelivery;
    /** @type {boolean} */
    FridayDelivery;
    /** @type {boolean} */
    SaturdayDelivery;
}
export class C2BSchoolGeneric {
    /** @param {{SchoolName?:string,DistrictName?:string,TeacherCount?:number,Topic?:string,Id?:number,DeliveryInfo?:C2BDeliveryInfo,AIMSchoolId?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    SchoolName;
    /** @type {string} */
    DistrictName;
    /** @type {number} */
    TeacherCount;
    /** @type {string} */
    Topic;
    /** @type {number} */
    Id;
    /** @type {C2BDeliveryInfo} */
    DeliveryInfo;
    /** @type {?number} */
    AIMSchoolId;
}
export class C2BGetSchoolInfoResponse extends BaseResponse {
    /** @param {{Schools?:C2BSchoolGeneric[],Status?:BaseResponseResult}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {C2BSchoolGeneric[]} */
    Schools;
}
export class C2BGetSchoolInfoRequest extends BaseRequest {
    /** @param {{PlanCode?:string,DistrictId?:number,RinPk?:number,RequestType?:string,ApiKey?:string,OAuthToken?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /**
     * @type {string}
     * @description If sent, only schools associated with the sent plan code will be returned. */
    PlanCode;
    /**
     * @type {?number}
     * @description If sent, only schools associated with the sent district will be returned. */
    DistrictId;
    /**
     * @type {?number}
     * @description ID of the Instrument record. Optional. */
    RinPk;
    /**
     * @type {string}
     * @description Optional Request Type. Valid values are Contract and Shipping. */
    RequestType;
}

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