AIM Web Services

<back to all web services

GetSchedulingGroupingsRequest

GetSchedulingGroupings
Requires active-e Lesson Scheduling Service

The following routes are available for this service:
GET/api/GetSchedulingGroupings
"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 GroupingInfo {
    /** @param {{Id?:number,Desc?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Id;
    /** @type {string} */
    Desc;
}
export class GetSchedulingGroupingsResponse extends BaseResponse {
    /** @param {{Groupings?:GroupingInfo[],Status?:BaseResponseResult}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {GroupingInfo[]} */
    Groupings;
}
export class GetSchedulingGroupingsRequest extends BaseRequest {
    /** @param {{GroupingId?:number,InstructorId?:number,LocationId?:number,MembershipType?:string,ApiKey?:string,OAuthToken?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /**
     * @type {?number}
     * @description Grouping ID to look up. If sent, all other parameters will be ignored. */
    GroupingId;
    /**
     * @type {?number}
     * @description If sent, only groupings with at least one lesson type taught by the sent instructor will be returned. */
    InstructorId;
    /**
     * @type {?number}
     * @description If sent, only groupings taught at the sent location will be returned. */
    LocationId;
    /**
     * @type {string}
     * @description If sent, should be Private or Group. If Private, only groupings containing Private Lesson Types will be returned. If Group, only groupings containing Group Lesson Types will be returned. */
    MembershipType;
}

JavaScript GetSchedulingGroupingsRequest 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/GetSchedulingGroupings HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/json

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

{"Groupings":[{"Id":0,"Desc":"String"}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}