| GET | /api/GetSchedulingInstructors |
|---|
import java.math.*;
import java.util.*;
import net.servicestack.client.*;
public class dtos
{
/**
* GetSchedulingInstructorsRequires active-e Lesson Scheduling Service
*/
@DataContract
public static class GetSchedulingInstructorsRequest extends BaseRequest
{
/**
* Instructor ID to lookup. If sent, other parameters will be ignored.
*/
@DataMember
@ApiMember(DataType="integer", Description="Instructor ID to lookup. If sent, other parameters will be ignored.", Format="int32", Name="InstructorId", ParameterType="query")
public Integer InstructorId = null;
/**
* If sent, only instructors who teach lessons with the passed grouping will be returned.
*/
@DataMember
@ApiMember(DataType="integer", Description="If sent, only instructors who teach lessons with the passed grouping will be returned.", Format="int64", Name="GroupingId", ParameterType="query")
public Long GroupingId = null;
/**
* If sent, only instructors who teach lessons with the passed type will be returned.
*/
@DataMember
@ApiMember(DataType="integer", Description="If sent, only instructors who teach lessons with the passed type will be returned.", Format="int64", Name="TypeId", ParameterType="query")
public Long TypeId = null;
/**
* If sent, only instructors who have an availability record at the passed location will be returned.
*/
@DataMember
@ApiMember(DataType="integer", Description="If sent, only instructors who have an availability record at the passed location will be returned.", Format="int64", Name="LocationId", ParameterType="query")
public Long LocationId = null;
/**
* If true, basic Availability Info will be included in the response
*/
@DataMember
@ApiMember(DataType="boolean", Description="If true, basic Availability Info will be included in the response", Name="IncludeAvailabilityInfo", ParameterType="query")
public Boolean IncludeAvailabilityInfo = null;
public Integer getInstructorId() { return InstructorId; }
public GetSchedulingInstructorsRequest setInstructorId(Integer value) { this.InstructorId = value; return this; }
public Long getGroupingId() { return GroupingId; }
public GetSchedulingInstructorsRequest setGroupingId(Long value) { this.GroupingId = value; return this; }
public Long getTypeId() { return TypeId; }
public GetSchedulingInstructorsRequest setTypeId(Long value) { this.TypeId = value; return this; }
public Long getLocationId() { return LocationId; }
public GetSchedulingInstructorsRequest setLocationId(Long value) { this.LocationId = value; return this; }
public Boolean isIncludeAvailabilityInfo() { return IncludeAvailabilityInfo; }
public GetSchedulingInstructorsRequest setIncludeAvailabilityInfo(Boolean value) { this.IncludeAvailabilityInfo = 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 GetSchedulingInstructorsResponse extends BaseResponse
{
@DataMember
public ArrayList<InstructorInfo> Instructors = null;
public ArrayList<InstructorInfo> getInstructors() { return Instructors; }
public GetSchedulingInstructorsResponse setInstructors(ArrayList<InstructorInfo> value) { this.Instructors = 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 InstructorInfo
{
@DataMember
public Integer Id = null;
@DataMember
public String Name = null;
@DataMember
public String Email = null;
@DataMember
public String Topic = null;
@DataMember
public InstructorAvailabilityInfo AvailabilityInfo = null;
public Integer getId() { return Id; }
public InstructorInfo setId(Integer value) { this.Id = value; return this; }
public String getName() { return Name; }
public InstructorInfo setName(String value) { this.Name = value; return this; }
public String getEmail() { return Email; }
public InstructorInfo setEmail(String value) { this.Email = value; return this; }
public String getTopic() { return Topic; }
public InstructorInfo setTopic(String value) { this.Topic = value; return this; }
public InstructorAvailabilityInfo getAvailabilityInfo() { return AvailabilityInfo; }
public InstructorInfo setAvailabilityInfo(InstructorAvailabilityInfo value) { this.AvailabilityInfo = value; return this; }
}
public static class InstructorAvailabilityInfo
{
@DataMember
public Boolean Sunday = null;
@DataMember
public Boolean Monday = null;
@DataMember
public Boolean Tuesday = null;
@DataMember
public Boolean Wednesday = null;
@DataMember
public Boolean Thursday = null;
@DataMember
public Boolean Friday = null;
@DataMember
public Boolean Saturday = null;
public Boolean isSunday() { return Sunday; }
public InstructorAvailabilityInfo setSunday(Boolean value) { this.Sunday = value; return this; }
public Boolean isMonday() { return Monday; }
public InstructorAvailabilityInfo setMonday(Boolean value) { this.Monday = value; return this; }
public Boolean isTuesday() { return Tuesday; }
public InstructorAvailabilityInfo setTuesday(Boolean value) { this.Tuesday = value; return this; }
public Boolean isWednesday() { return Wednesday; }
public InstructorAvailabilityInfo setWednesday(Boolean value) { this.Wednesday = value; return this; }
public Boolean isThursday() { return Thursday; }
public InstructorAvailabilityInfo setThursday(Boolean value) { this.Thursday = value; return this; }
public Boolean isFriday() { return Friday; }
public InstructorAvailabilityInfo setFriday(Boolean value) { this.Friday = value; return this; }
public Boolean isSaturday() { return Saturday; }
public InstructorAvailabilityInfo setSaturday(Boolean value) { this.Saturday = value; return this; }
}
}
Java GetSchedulingInstructorsRequest 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/GetSchedulingInstructors HTTP/1.1 Host: active-ewebservice.biz Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"Instructors":[{"Id":0,"Name":"String","Email":"String","Topic":"String","AvailabilityInfo":{"Sunday":false,"Monday":false,"Tuesday":false,"Wednesday":false,"Thursday":false,"Friday":false,"Saturday":false}}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}