| GET | /api/GetSchedulingLocations |
|---|
import java.math.*;
import java.util.*;
import net.servicestack.client.*;
public class dtos
{
/**
* GetSchedulingLocationsRequires active-e Lesson Scheduling Service
*/
@DataContract
public static class GetSchedulingLocationsRequest extends BaseRequest
{
/**
* Location lookup. If sent, all other parameters will be ignored.
*/
@DataMember
@ApiMember(DataType="integer", Description="Location lookup. If sent, all other parameters will be ignored.", Format="int64", Name="LocationId", ParameterType="query")
public Long LocationId = null;
/**
* If sent, only locations that offer this lesson type will be returned.
*/
@DataMember
@ApiMember(DataType="integer", Description="If sent, only locations that offer this lesson type will be returned.", Format="int64", Name="TypeId", ParameterType="query")
public Long TypeId = null;
/**
* If sent, only locations that offer lessons of this grouping will be returned.
*/
@DataMember
@ApiMember(DataType="integer", Description="If sent, only locations that offer lessons of this grouping will be returned.", Format="int64", Name="GroupingId", ParameterType="query")
public Long GroupingId = null;
/**
* If sent, only locations where the sent instructor teaches will be returned.
*/
@DataMember
@ApiMember(DataType="integer", Description="If sent, only locations where the sent instructor teaches will be returned.", Format="int32", Name="InstructorId", ParameterType="query")
public Integer InstructorId = null;
@DataMember
public Boolean IncludeInactiveLocations = null;
public Long getLocationId() { return LocationId; }
public GetSchedulingLocationsRequest setLocationId(Long value) { this.LocationId = value; return this; }
public Long getTypeId() { return TypeId; }
public GetSchedulingLocationsRequest setTypeId(Long value) { this.TypeId = value; return this; }
public Long getGroupingId() { return GroupingId; }
public GetSchedulingLocationsRequest setGroupingId(Long value) { this.GroupingId = value; return this; }
public Integer getInstructorId() { return InstructorId; }
public GetSchedulingLocationsRequest setInstructorId(Integer value) { this.InstructorId = value; return this; }
public Boolean isIncludeInactiveLocations() { return IncludeInactiveLocations; }
public GetSchedulingLocationsRequest setIncludeInactiveLocations(Boolean value) { this.IncludeInactiveLocations = 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 GetSchedulingLocationsResponse extends BaseResponse
{
@DataMember
public ArrayList<LocationInfo> Locations = null;
public ArrayList<LocationInfo> getLocations() { return Locations; }
public GetSchedulingLocationsResponse setLocations(ArrayList<LocationInfo> value) { this.Locations = 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 LocationInfo
{
@DataMember
public Long Id = null;
@DataMember
public String Desc = null;
@DataMember
public String ShortDesc = null;
@DataMember
public String Region = null;
@DataMember
public BigDecimal Latitude = null;
@DataMember
public BigDecimal Longitude = null;
@DataMember
public String InStorePickup = null;
@DataMember
public Boolean Active = null;
@DataMember
public Integer CashSaleAcct = null;
public Long getId() { return Id; }
public LocationInfo setId(Long value) { this.Id = value; return this; }
public String getDesc() { return Desc; }
public LocationInfo setDesc(String value) { this.Desc = value; return this; }
public String getShortDesc() { return ShortDesc; }
public LocationInfo setShortDesc(String value) { this.ShortDesc = value; return this; }
public String getRegion() { return Region; }
public LocationInfo setRegion(String value) { this.Region = value; return this; }
public BigDecimal getLatitude() { return Latitude; }
public LocationInfo setLatitude(BigDecimal value) { this.Latitude = value; return this; }
public BigDecimal getLongitude() { return Longitude; }
public LocationInfo setLongitude(BigDecimal value) { this.Longitude = value; return this; }
public String getInStorePickup() { return InStorePickup; }
public LocationInfo setInStorePickup(String value) { this.InStorePickup = value; return this; }
public Boolean isActive() { return Active; }
public LocationInfo setActive(Boolean value) { this.Active = value; return this; }
public Integer getCashSaleAcct() { return CashSaleAcct; }
public LocationInfo setCashSaleAcct(Integer value) { this.CashSaleAcct = value; return this; }
}
}
Java GetSchedulingLocationsRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /api/GetSchedulingLocations HTTP/1.1 Host: active-ewebservice.biz Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"Locations":[{"Id":0,"Desc":"String","ShortDesc":"String","Region":"String","Latitude":0,"Longitude":0,"InStorePickup":"String","Active":false,"CashSaleAcct":0}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}