AIM Web Services

<back to all web services

GetSchoolListRequest

GetSchoolList
Requires active-e Customer Service.

The following routes are available for this service:
GET/api/GetSchoolList
<?php namespace dtos;

use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};


// @DataContract
class BaseRequest implements JsonSerializable
{
    public function __construct(
        /** @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")
        /** @var string */
        public string $ApiKey='',

        // @DataMember
        // @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
        /** @var string|null */
        public ?string $OAuthToken=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['ApiKey'])) $this->ApiKey = $o['ApiKey'];
        if (isset($o['OAuthToken'])) $this->OAuthToken = $o['OAuthToken'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->ApiKey)) $o['ApiKey'] = $this->ApiKey;
        if (isset($this->OAuthToken)) $o['OAuthToken'] = $this->OAuthToken;
        return empty($o) ? new class(){} : $o;
    }
}

// @DataContract
class BaseSecureRequest extends BaseRequest implements JsonSerializable
{
    /**
     * @param string $ApiKey
     * @param string|null $OAuthToken
     */
    public function __construct(
        string $ApiKey='',
        ?string $OAuthToken=null,
        /** @description  */
        // @DataMember
        // @ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")
        /** @var string|null */
        public ?string $Token=null,

        /** @description  */
        // @DataMember
        // @ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")
        /** @var string|null */
        public ?string $DeviceId=null,

        /** @description  */
        // @DataMember
        // @ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")
        /** @var string */
        public string $AppId=''
    ) {
        parent::__construct($ApiKey,$OAuthToken);
    }

    /** @throws Exception */
    public function fromMap($o): void {
        parent::fromMap($o);
        if (isset($o['Token'])) $this->Token = $o['Token'];
        if (isset($o['DeviceId'])) $this->DeviceId = $o['DeviceId'];
        if (isset($o['AppId'])) $this->AppId = $o['AppId'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = parent::jsonSerialize();
        if (isset($this->Token)) $o['Token'] = $this->Token;
        if (isset($this->DeviceId)) $o['DeviceId'] = $this->DeviceId;
        if (isset($this->AppId)) $o['AppId'] = $this->AppId;
        return empty($o) ? new class(){} : $o;
    }
}

// @DataContract
class BaseResponseResult implements JsonSerializable
{
    public function __construct(
        /** @description  */
        // @DataMember
        // @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
        /** @var string|null */
        public ?string $StatusCode=null,

        /** @description  */
        // @DataMember
        // @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
        /** @var string|null */
        public ?string $Login=null,

        /** @description  */
        // @DataMember
        // @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
        /** @var string|null */
        public ?string $ErrorCode=null,

        /** @description  */
        // @DataMember
        // @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
        /** @var string|null */
        public ?string $ErrorDisplayText=null,

        /** @description  */
        // @DataMember
        // @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
        /** @var string|null */
        public ?string $ErrorMessage=null,

        /** @description  */
        // @DataMember
        // @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")
        /** @var string|null */
        public ?string $DomainName=null,

        /** @description  */
        // @DataMember
        // @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
        /** @var string|null */
        public ?string $IpAddress=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['StatusCode'])) $this->StatusCode = $o['StatusCode'];
        if (isset($o['Login'])) $this->Login = $o['Login'];
        if (isset($o['ErrorCode'])) $this->ErrorCode = $o['ErrorCode'];
        if (isset($o['ErrorDisplayText'])) $this->ErrorDisplayText = $o['ErrorDisplayText'];
        if (isset($o['ErrorMessage'])) $this->ErrorMessage = $o['ErrorMessage'];
        if (isset($o['DomainName'])) $this->DomainName = $o['DomainName'];
        if (isset($o['IpAddress'])) $this->IpAddress = $o['IpAddress'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->StatusCode)) $o['StatusCode'] = $this->StatusCode;
        if (isset($this->Login)) $o['Login'] = $this->Login;
        if (isset($this->ErrorCode)) $o['ErrorCode'] = $this->ErrorCode;
        if (isset($this->ErrorDisplayText)) $o['ErrorDisplayText'] = $this->ErrorDisplayText;
        if (isset($this->ErrorMessage)) $o['ErrorMessage'] = $this->ErrorMessage;
        if (isset($this->DomainName)) $o['DomainName'] = $this->DomainName;
        if (isset($this->IpAddress)) $o['IpAddress'] = $this->IpAddress;
        return empty($o) ? new class(){} : $o;
    }
}

// @DataContract
class BaseResponse implements JsonSerializable
{
    public function __construct(
        /** @description  */
        // @DataMember
        // @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
        /** @var BaseResponseResult|null */
        public ?BaseResponseResult $Status=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Status'])) $this->Status = JsonConverters::from('BaseResponseResult', $o['Status']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Status)) $o['Status'] = JsonConverters::to('BaseResponseResult', $this->Status);
        return empty($o) ? new class(){} : $o;
    }
}

// @DataContract
class C2BDeliveryInfo implements JsonSerializable
{
    public function __construct(
        // @DataMember
        /** @var DateTime */
        public DateTime $FirstDelivery=new DateTime(),

        // @DataMember
        /** @var DateTime */
        public DateTime $DeliveryTime=new DateTime(),

        // @DataMember
        /** @var int */
        public int $DeliveryThreshold=0,

        // @DataMember
        /** @var bool|null */
        public ?bool $SundayDelivery=null,

        // @DataMember
        /** @var bool|null */
        public ?bool $MondayDelivery=null,

        // @DataMember
        /** @var bool|null */
        public ?bool $TuesdayDelivery=null,

        // @DataMember
        /** @var bool|null */
        public ?bool $WednesdayDelivery=null,

        // @DataMember
        /** @var bool|null */
        public ?bool $ThursdayDelivery=null,

        // @DataMember
        /** @var bool|null */
        public ?bool $FridayDelivery=null,

        // @DataMember
        /** @var bool|null */
        public ?bool $SaturdayDelivery=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['FirstDelivery'])) $this->FirstDelivery = JsonConverters::from('DateTime', $o['FirstDelivery']);
        if (isset($o['DeliveryTime'])) $this->DeliveryTime = JsonConverters::from('DateTime', $o['DeliveryTime']);
        if (isset($o['DeliveryThreshold'])) $this->DeliveryThreshold = $o['DeliveryThreshold'];
        if (isset($o['SundayDelivery'])) $this->SundayDelivery = $o['SundayDelivery'];
        if (isset($o['MondayDelivery'])) $this->MondayDelivery = $o['MondayDelivery'];
        if (isset($o['TuesdayDelivery'])) $this->TuesdayDelivery = $o['TuesdayDelivery'];
        if (isset($o['WednesdayDelivery'])) $this->WednesdayDelivery = $o['WednesdayDelivery'];
        if (isset($o['ThursdayDelivery'])) $this->ThursdayDelivery = $o['ThursdayDelivery'];
        if (isset($o['FridayDelivery'])) $this->FridayDelivery = $o['FridayDelivery'];
        if (isset($o['SaturdayDelivery'])) $this->SaturdayDelivery = $o['SaturdayDelivery'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->FirstDelivery)) $o['FirstDelivery'] = JsonConverters::to('DateTime', $this->FirstDelivery);
        if (isset($this->DeliveryTime)) $o['DeliveryTime'] = JsonConverters::to('DateTime', $this->DeliveryTime);
        if (isset($this->DeliveryThreshold)) $o['DeliveryThreshold'] = $this->DeliveryThreshold;
        if (isset($this->SundayDelivery)) $o['SundayDelivery'] = $this->SundayDelivery;
        if (isset($this->MondayDelivery)) $o['MondayDelivery'] = $this->MondayDelivery;
        if (isset($this->TuesdayDelivery)) $o['TuesdayDelivery'] = $this->TuesdayDelivery;
        if (isset($this->WednesdayDelivery)) $o['WednesdayDelivery'] = $this->WednesdayDelivery;
        if (isset($this->ThursdayDelivery)) $o['ThursdayDelivery'] = $this->ThursdayDelivery;
        if (isset($this->FridayDelivery)) $o['FridayDelivery'] = $this->FridayDelivery;
        if (isset($this->SaturdayDelivery)) $o['SaturdayDelivery'] = $this->SaturdayDelivery;
        return empty($o) ? new class(){} : $o;
    }
}

// @DataContract
class SchoolGeneric implements JsonSerializable
{
    public function __construct(
        // @DataMember
        /** @var int */
        public int $Id=0,

        // @DataMember
        /** @var string|null */
        public ?string $SchoolName=null,

        // @DataMember
        /** @var string|null */
        public ?string $District=null,

        // @DataMember
        /** @var string|null */
        public ?string $Address=null,

        // @DataMember
        /** @var string|null */
        public ?string $City=null,

        // @DataMember
        /** @var string|null */
        public ?string $State=null,

        // @DataMember
        /** @var string|null */
        public ?string $Zip=null,

        // @DataMember
        /** @var string|null */
        public ?string $Phone=null,

        // @DataMember
        /** @var string|null */
        public ?string $TaxAuth=null,

        // @DataMember
        /** @var C2BDeliveryInfo|null */
        public ?C2BDeliveryInfo $DeliveryInfo=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Id'])) $this->Id = $o['Id'];
        if (isset($o['SchoolName'])) $this->SchoolName = $o['SchoolName'];
        if (isset($o['District'])) $this->District = $o['District'];
        if (isset($o['Address'])) $this->Address = $o['Address'];
        if (isset($o['City'])) $this->City = $o['City'];
        if (isset($o['State'])) $this->State = $o['State'];
        if (isset($o['Zip'])) $this->Zip = $o['Zip'];
        if (isset($o['Phone'])) $this->Phone = $o['Phone'];
        if (isset($o['TaxAuth'])) $this->TaxAuth = $o['TaxAuth'];
        if (isset($o['DeliveryInfo'])) $this->DeliveryInfo = JsonConverters::from('C2BDeliveryInfo', $o['DeliveryInfo']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Id)) $o['Id'] = $this->Id;
        if (isset($this->SchoolName)) $o['SchoolName'] = $this->SchoolName;
        if (isset($this->District)) $o['District'] = $this->District;
        if (isset($this->Address)) $o['Address'] = $this->Address;
        if (isset($this->City)) $o['City'] = $this->City;
        if (isset($this->State)) $o['State'] = $this->State;
        if (isset($this->Zip)) $o['Zip'] = $this->Zip;
        if (isset($this->Phone)) $o['Phone'] = $this->Phone;
        if (isset($this->TaxAuth)) $o['TaxAuth'] = $this->TaxAuth;
        if (isset($this->DeliveryInfo)) $o['DeliveryInfo'] = JsonConverters::to('C2BDeliveryInfo', $this->DeliveryInfo);
        return empty($o) ? new class(){} : $o;
    }
}

// @DataContract
class GetSchoolListResponse extends BaseResponse implements JsonSerializable
{
    /**
     * @param BaseResponseResult|null $Status
     */
    public function __construct(
        ?BaseResponseResult $Status=null,
        // @DataMember
        /** @var array<SchoolGeneric>|null */
        public ?array $Schools=null
    ) {
        parent::__construct($Status);
    }

    /** @throws Exception */
    public function fromMap($o): void {
        parent::fromMap($o);
        if (isset($o['Schools'])) $this->Schools = JsonConverters::fromArray('SchoolGeneric', $o['Schools']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = parent::jsonSerialize();
        if (isset($this->Schools)) $o['Schools'] = JsonConverters::toArray('SchoolGeneric', $this->Schools);
        return empty($o) ? new class(){} : $o;
    }
}

/** @description GetSchoolListRequires active-e Customer Service. */
// @DataContract
class GetSchoolListRequest extends BaseSecureRequest implements JsonSerializable
{
    /**
     * @param string $ApiKey
     * @param string|null $OAuthToken
     * @param string|null $Token
     * @param string|null $DeviceId
     * @param string $AppId
     */
    public function __construct(
        string $ApiKey='',
        ?string $OAuthToken=null,
        ?string $Token=null,
        ?string $DeviceId=null,
        string $AppId='',
        /** @description District ID. Skip this parameter to return all schools. -1 will return all schools that don't have a district assigned. */
        // @DataMember
        // @ApiMember(DataType="integer", Description="District ID. Skip this parameter to return all schools. -1 will return all schools that don't have a district assigned.", Format="int64", Name="DistrictId", ParameterType="query")
        /** @var int|null */
        public ?int $DistrictId=null
    ) {
        parent::__construct($ApiKey,$OAuthToken,$Token,$DeviceId,$AppId);
    }

    /** @throws Exception */
    public function fromMap($o): void {
        parent::fromMap($o);
        if (isset($o['DistrictId'])) $this->DistrictId = $o['DistrictId'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = parent::jsonSerialize();
        if (isset($this->DistrictId)) $o['DistrictId'] = $this->DistrictId;
        return empty($o) ? new class(){} : $o;
    }
}

PHP GetSchoolListRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /api/GetSchoolList HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/json

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

{"Schools":[{"Id":0,"SchoolName":"String","District":"String","Address":"String","City":"String","State":"String","Zip":"String","Phone":"String","TaxAuth":"String","DeliveryInfo":{"DeliveryThreshold":0,"SundayDelivery":false,"MondayDelivery":false,"TuesdayDelivery":false,"WednesdayDelivery":false,"ThursdayDelivery":false,"FridayDelivery":false,"SaturdayDelivery":false}}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}