| GET | /api/GetStationGroups |
|---|
import java.math.*;
import java.util.*;
import net.servicestack.client.*;
public class dtos
{
/**
* GetStationGroupsRequires active-e Station Reservations Service
*/
@DataContract
public static class GetStationGroupsRequest extends BaseSecureRequest
{
/**
* If sent, only station groups at the passed location will be returned.
*/
@DataMember
@ApiMember(DataType="integer", Description="If sent, only station groups at the passed location will be returned.", Format="int64", Name="LocationId", ParameterType="query")
public Long LocationId = null;
public Long getLocationId() { return LocationId; }
public GetStationGroupsRequest setLocationId(Long value) { this.LocationId = value; return this; }
}
@DataContract
public static class BaseSecureRequest extends BaseRequest
{
/**
*
*/
@DataMember
@ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")
public String Token = null;
/**
*
*/
@DataMember
@ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")
public String DeviceId = null;
/**
*
*/
@DataMember
@ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")
public String AppId = null;
public String getToken() { return Token; }
public BaseSecureRequest setToken(String value) { this.Token = value; return this; }
public String getDeviceId() { return DeviceId; }
public BaseSecureRequest setDeviceId(String value) { this.DeviceId = value; return this; }
public String getAppId() { return AppId; }
public BaseSecureRequest setAppId(String value) { this.AppId = 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 GetStationGroupsResponse extends BaseResponse
{
@DataMember
public ArrayList<StationGroupInfo> StationGroups = null;
public ArrayList<StationGroupInfo> getStationGroups() { return StationGroups; }
public GetStationGroupsResponse setStationGroups(ArrayList<StationGroupInfo> value) { this.StationGroups = 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 StationGroupInfo
{
@DataMember
public Long Id = null;
@DataMember
public String Description = null;
@DataMember
public String WebDescription = null;
@DataMember
public String Topic = null;
@DataMember
public Integer Interval = null;
@DataMember
public Integer Buffer = null;
@DataMember
public LocationInfo Location = null;
@DataMember
public Integer Yards = null;
@DataMember
public ArrayList<WeekdayInfo> Weekdays = null;
@DataMember
public StationGroupMembershipData MembershipData = null;
public Long getId() { return Id; }
public StationGroupInfo setId(Long value) { this.Id = value; return this; }
public String getDescription() { return Description; }
public StationGroupInfo setDescription(String value) { this.Description = value; return this; }
public String getWebDescription() { return WebDescription; }
public StationGroupInfo setWebDescription(String value) { this.WebDescription = value; return this; }
public String getTopic() { return Topic; }
public StationGroupInfo setTopic(String value) { this.Topic = value; return this; }
public Integer getInterval() { return Interval; }
public StationGroupInfo setInterval(Integer value) { this.Interval = value; return this; }
public Integer getBuffer() { return Buffer; }
public StationGroupInfo setBuffer(Integer value) { this.Buffer = value; return this; }
public LocationInfo getLocation() { return Location; }
public StationGroupInfo setLocation(LocationInfo value) { this.Location = value; return this; }
public Integer getYards() { return Yards; }
public StationGroupInfo setYards(Integer value) { this.Yards = value; return this; }
public ArrayList<WeekdayInfo> getWeekdays() { return Weekdays; }
public StationGroupInfo setWeekdays(ArrayList<WeekdayInfo> value) { this.Weekdays = value; return this; }
public StationGroupMembershipData getMembershipData() { return MembershipData; }
public StationGroupInfo setMembershipData(StationGroupMembershipData value) { this.MembershipData = 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; }
}
@DataContract
public static class WeekdayInfo
{
@DataMember
public String Weekday = null;
@DataMember
public Integer WeekdayInt = null;
@DataMember
public Boolean Open = null;
@DataMember
public Integer OpenHour = null;
@DataMember
public Integer OpenMinute = null;
@DataMember
public Integer CloseHour = null;
@DataMember
public Integer CloseMinute = null;
public String getWeekday() { return Weekday; }
public WeekdayInfo setWeekday(String value) { this.Weekday = value; return this; }
public Integer getWeekdayInt() { return WeekdayInt; }
public WeekdayInfo setWeekdayInt(Integer value) { this.WeekdayInt = value; return this; }
public Boolean isOpen() { return Open; }
public WeekdayInfo setOpen(Boolean value) { this.Open = value; return this; }
public Integer getOpenHour() { return OpenHour; }
public WeekdayInfo setOpenHour(Integer value) { this.OpenHour = value; return this; }
public Integer getOpenMinute() { return OpenMinute; }
public WeekdayInfo setOpenMinute(Integer value) { this.OpenMinute = value; return this; }
public Integer getCloseHour() { return CloseHour; }
public WeekdayInfo setCloseHour(Integer value) { this.CloseHour = value; return this; }
public Integer getCloseMinute() { return CloseMinute; }
public WeekdayInfo setCloseMinute(Integer value) { this.CloseMinute = value; return this; }
}
@DataContract
public static class StationGroupMembershipData
{
@DataMember
public ArrayList<StationGroupMembershipLevel> Levels = null;
public ArrayList<StationGroupMembershipLevel> getLevels() { return Levels; }
public StationGroupMembershipData setLevels(ArrayList<StationGroupMembershipLevel> value) { this.Levels = value; return this; }
}
@DataContract
public static class StationGroupMembershipLevel
{
@DataMember
public Integer Level = null;
@DataMember
public Integer DaysAhead = null;
@DataMember
public Boolean AllowBooking = null;
public Integer getLevel() { return Level; }
public StationGroupMembershipLevel setLevel(Integer value) { this.Level = value; return this; }
public Integer getDaysAhead() { return DaysAhead; }
public StationGroupMembershipLevel setDaysAhead(Integer value) { this.DaysAhead = value; return this; }
public Boolean isAllowBooking() { return AllowBooking; }
public StationGroupMembershipLevel setAllowBooking(Boolean value) { this.AllowBooking = value; return this; }
}
}
Java GetStationGroupsRequest 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/GetStationGroups HTTP/1.1 Host: active-ewebservice.biz Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"StationGroups":[{"Id":0,"Description":"String","WebDescription":"String","Topic":"String","Interval":0,"Buffer":0,"Location":{"Id":0,"Desc":"String","ShortDesc":"String","Region":"String","Latitude":0,"Longitude":0,"InStorePickup":"String","Active":false,"CashSaleAcct":0},"Yards":0,"Weekdays":[{"Weekday":"String","WeekdayInt":0,"Open":false,"OpenHour":0,"OpenMinute":0,"CloseHour":0,"CloseMinute":0}],"MembershipData":{"Levels":[{"Level":0,"DaysAhead":0,"AllowBooking":false}]}}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}