| GET | /api/GetSchedulingTypes |
|---|
import java.math.*;
import java.util.*;
import net.servicestack.client.*;
public class dtos
{
/**
* GetSchedulingTypesRequires active-e Lesson Scheduling Service
*/
@DataContract
public static class GetSchedulingTypesRequest extends BaseRequest
{
/**
* Type ID to look up. If sent, all other parameters will be ignored.
*/
@DataMember
@ApiMember(DataType="integer", Description="Type ID to look up. If sent, all other parameters will be ignored.", Format="int64", Name="TypeId", ParameterType="query")
public Long TypeId = null;
/**
* If sent, only types in the sent grouping will be returned.
*/
@DataMember
@ApiMember(DataType="integer", Description="If sent, only types in the sent grouping will be returned.", Format="int64", Name="GroupingId", ParameterType="query")
public Long GroupingId = null;
/**
* If sent, only types taught by the sent instructor will be returned.
*/
@DataMember
@ApiMember(DataType="integer", Description="If sent, only types taught by the sent instructor will be returned.", Format="int32", Name="InstructorId", ParameterType="query")
public Integer InstructorId = null;
/**
* If sent, only types taught at the sent location will be returned.
*/
@DataMember
@ApiMember(DataType="integer", Description="If sent, only types 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 Private Lesson Types will be returned. If Group, only Group Lesson Types will be returned.
*/
@DataMember
@ApiMember(DataType="integer", Description="If sent, should be Private or Group. If Private, only Private Lesson Types will be returned. If Group, only Group Lesson Types will be returned.", Format="int64", Name="MembershipType", ParameterType="query")
public String MembershipType = null;
public Long getTypeId() { return TypeId; }
public GetSchedulingTypesRequest setTypeId(Long value) { this.TypeId = value; return this; }
public Long getGroupingId() { return GroupingId; }
public GetSchedulingTypesRequest setGroupingId(Long value) { this.GroupingId = value; return this; }
public Integer getInstructorId() { return InstructorId; }
public GetSchedulingTypesRequest setInstructorId(Integer value) { this.InstructorId = value; return this; }
public Long getLocationId() { return LocationId; }
public GetSchedulingTypesRequest setLocationId(Long value) { this.LocationId = value; return this; }
public String getMembershipType() { return MembershipType; }
public GetSchedulingTypesRequest 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 GetSchedulingTypesResponse extends BaseResponse
{
@DataMember
public ArrayList<TypeInfo> Types = null;
public ArrayList<TypeInfo> getTypes() { return Types; }
public GetSchedulingTypesResponse setTypes(ArrayList<TypeInfo> value) { this.Types = 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 TypeInfo
{
@DataMember
public Long Id = null;
@DataMember
public String Desc = null;
@DataMember
public Integer Length = null;
@DataMember
public String Topic = null;
@DataMember
public String RecurranceType = null;
@DataMember
public String MembershipType = null;
@DataMember
public BigDecimal Rate = null;
@DataMember
public Long GroupingId = null;
@DataMember
public String GroupingDesc = null;
public Long getId() { return Id; }
public TypeInfo setId(Long value) { this.Id = value; return this; }
public String getDesc() { return Desc; }
public TypeInfo setDesc(String value) { this.Desc = value; return this; }
public Integer getLength() { return Length; }
public TypeInfo setLength(Integer value) { this.Length = value; return this; }
public String getTopic() { return Topic; }
public TypeInfo setTopic(String value) { this.Topic = value; return this; }
public String getRecurranceType() { return RecurranceType; }
public TypeInfo setRecurranceType(String value) { this.RecurranceType = value; return this; }
public String getMembershipType() { return MembershipType; }
public TypeInfo setMembershipType(String value) { this.MembershipType = value; return this; }
public BigDecimal getRate() { return Rate; }
public TypeInfo setRate(BigDecimal value) { this.Rate = value; return this; }
public Long getGroupingId() { return GroupingId; }
public TypeInfo setGroupingId(Long value) { this.GroupingId = value; return this; }
public String getGroupingDesc() { return GroupingDesc; }
public TypeInfo setGroupingDesc(String value) { this.GroupingDesc = value; return this; }
}
}
Java GetSchedulingTypesRequest 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
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /api/GetSchedulingTypes HTTP/1.1 Host: active-ewebservice.biz Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"Types":[{"Id":0,"Desc":"String","Length":0,"Topic":"String","RecurranceType":"String","MembershipType":"String","Rate":0,"GroupingId":0,"GroupingDesc":"String"}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}