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

// @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 GroupingInfo
{
    // @DataMember
    public Id: number;

    // @DataMember
    public Desc: string;

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

// @DataContract
export class GetSchedulingGroupingsResponse extends BaseResponse
{
    // @DataMember
    public Groupings: GroupingInfo[];

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

/** @description GetSchedulingGroupingsRequires active-e Lesson Scheduling Service */
// @DataContract
export class GetSchedulingGroupingsRequest extends BaseRequest
{
    /** @description Grouping ID to look up. If sent, all other parameters will be ignored. */
    // @DataMember
    // @ApiMember(DataType="integer", Description="Grouping ID to look up. If sent, all other parameters will be ignored.", Format="int64", Name="GroupingId", ParameterType="query")
    public GroupingId?: number;

    /** @description If sent, only groupings with at least one lesson type taught by the sent instructor will be returned. */
    // @DataMember
    // @ApiMember(DataType="integer", Description="If sent, only groupings with at least one lesson type taught by the sent instructor will be returned.", Format="int32", Name="InstructorId", ParameterType="query")
    public InstructorId?: number;

    /** @description If sent, only groupings taught at the sent location will be returned. */
    // @DataMember
    // @ApiMember(DataType="integer", Description="If sent, only groupings taught at the sent location will be returned.", Format="int64", Name="LocationId", ParameterType="query")
    public LocationId?: number;

    /** @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. */
    // @DataMember
    // @ApiMember(DataType="integer", 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.", Format="int64", Name="MembershipType", ParameterType="query")
    public MembershipType: string;

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

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

GET /api/GetSchedulingGroupings HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/xml

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

<GetSchedulingGroupingsResponse 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>
  <Groupings>
    <GetSchedulingGroupingsResponse.GroupingInfo>
      <Desc>String</Desc>
      <Id>0</Id>
    </GetSchedulingGroupingsResponse.GroupingInfo>
  </Groupings>
</GetSchedulingGroupingsResponse>