AIM Web Services

<back to all web services

GetSchedulingGroupingsRequest

GetSchedulingGroupings
Requires active-e Lesson Scheduling Service

import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    /**
    * GetSchedulingGroupingsRequires active-e Lesson Scheduling Service
    */
    @DataContract
    public static class GetSchedulingGroupingsRequest extends BaseRequest
    {
        /**
        * 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 Long GroupingId = null;

        /**
        * 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 Integer InstructorId = null;

        /**
        * 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 Long LocationId = null;

        /**
        * 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 String MembershipType = null;
        
        public Long getGroupingId() { return GroupingId; }
        public GetSchedulingGroupingsRequest setGroupingId(Long value) { this.GroupingId = value; return this; }
        public Integer getInstructorId() { return InstructorId; }
        public GetSchedulingGroupingsRequest setInstructorId(Integer value) { this.InstructorId = value; return this; }
        public Long getLocationId() { return LocationId; }
        public GetSchedulingGroupingsRequest setLocationId(Long value) { this.LocationId = value; return this; }
        public String getMembershipType() { return MembershipType; }
        public GetSchedulingGroupingsRequest setMembershipType(String value) { this.MembershipType = value; return this; }
    }

    @DataContract
    public static class BaseRequest
    {
        /**
        * 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 String ApiKey = null;

        @DataMember
        @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
        public String OAuthToken = null;
        
        public String getApiKey() { return ApiKey; }
        public BaseRequest setApiKey(String value) { this.ApiKey = value; return this; }
        public String getOAuthToken() { return OAuthToken; }
        public BaseRequest setOAuthToken(String value) { this.OAuthToken = value; return this; }
    }

    @DataContract
    public static class GetSchedulingGroupingsResponse extends BaseResponse
    {
        @DataMember
        public ArrayList<GroupingInfo> Groupings = null;
        
        public ArrayList<GroupingInfo> getGroupings() { return Groupings; }
        public GetSchedulingGroupingsResponse setGroupings(ArrayList<GroupingInfo> value) { this.Groupings = value; return this; }
    }

    @DataContract
    public static class BaseResponse
    {
        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
        public BaseResponseResult Status = null;
        
        public BaseResponseResult getStatus() { return Status; }
        public BaseResponse setStatus(BaseResponseResult value) { this.Status = value; return this; }
    }

    @DataContract
    public static class BaseResponseResult
    {
        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
        public String StatusCode = null;

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

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

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

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

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

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
        public String IpAddress = null;
        
        public String getStatusCode() { return StatusCode; }
        public BaseResponseResult setStatusCode(String value) { this.StatusCode = value; return this; }
        public String getLogin() { return Login; }
        public BaseResponseResult setLogin(String value) { this.Login = value; return this; }
        public String getErrorCode() { return ErrorCode; }
        public BaseResponseResult setErrorCode(String value) { this.ErrorCode = value; return this; }
        public String getErrorDisplayText() { return ErrorDisplayText; }
        public BaseResponseResult setErrorDisplayText(String value) { this.ErrorDisplayText = value; return this; }
        public String getErrorMessage() { return ErrorMessage; }
        public BaseResponseResult setErrorMessage(String value) { this.ErrorMessage = value; return this; }
        public String getDomainName() { return DomainName; }
        public BaseResponseResult setDomainName(String value) { this.DomainName = value; return this; }
        public String getIpAddress() { return IpAddress; }
        public BaseResponseResult setIpAddress(String value) { this.IpAddress = value; return this; }
    }

    @DataContract
    public static class GroupingInfo
    {
        @DataMember
        public Long Id = null;

        @DataMember
        public String Desc = null;
        
        public Long getId() { return Id; }
        public GroupingInfo setId(Long value) { this.Id = value; return this; }
        public String getDesc() { return Desc; }
        public GroupingInfo setDesc(String value) { this.Desc = value; return this; }
    }

}

Java GetSchedulingGroupingsRequest DTOs

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>