AIM Web Services

<back to all web services

ScheduledExchangesGetRequest

ScheduledExchanges
Requires active-e Contracts Service.

The following routes are available for this service:
GET/api/ScheduledExchanges
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    /**
    * ScheduledExchangesRequires active-e Contracts Service.
    */
    @DataContract
    public static class ScheduledExchangesGetRequest extends BaseSecureRequest
    {
        @DataMember
        public Date ScheduledDateFrom = null;

        @DataMember
        public Date ScheduledDateTo = null;

        @DataMember
        public Long DistrictId = null;

        @DataMember
        public Long SchoolId = null;

        @DataMember
        public Long LocationId = null;

        @DataMember
        public Long StatusId = null;

        @DataMember
        public Long OptionId = null;

        @DataMember
        public Boolean IncludeProcessed = null;

        @DataMember
        public String LanId = null;
        
        public Date getScheduledDateFrom() { return ScheduledDateFrom; }
        public ScheduledExchangesGetRequest setScheduledDateFrom(Date value) { this.ScheduledDateFrom = value; return this; }
        public Date getScheduledDateTo() { return ScheduledDateTo; }
        public ScheduledExchangesGetRequest setScheduledDateTo(Date value) { this.ScheduledDateTo = value; return this; }
        public Long getDistrictId() { return DistrictId; }
        public ScheduledExchangesGetRequest setDistrictId(Long value) { this.DistrictId = value; return this; }
        public Long getSchoolId() { return SchoolId; }
        public ScheduledExchangesGetRequest setSchoolId(Long value) { this.SchoolId = value; return this; }
        public Long getLocationId() { return LocationId; }
        public ScheduledExchangesGetRequest setLocationId(Long value) { this.LocationId = value; return this; }
        public Long getStatusId() { return StatusId; }
        public ScheduledExchangesGetRequest setStatusId(Long value) { this.StatusId = value; return this; }
        public Long getOptionId() { return OptionId; }
        public ScheduledExchangesGetRequest setOptionId(Long value) { this.OptionId = value; return this; }
        public Boolean isIncludeProcessed() { return IncludeProcessed; }
        public ScheduledExchangesGetRequest setIncludeProcessed(Boolean value) { this.IncludeProcessed = value; return this; }
        public String getLanId() { return LanId; }
        public ScheduledExchangesGetRequest setLanId(String value) { this.LanId = 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 ScheduledExchangesGetResponse extends BaseResponse
    {
        @DataMember
        public ArrayList<ScheduledExchangesGetInfo> ScheduledExchanges = null;
        
        public ArrayList<ScheduledExchangesGetInfo> getScheduledExchanges() { return ScheduledExchanges; }
        public ScheduledExchangesGetResponse setScheduledExchanges(ArrayList<ScheduledExchangesGetInfo> value) { this.ScheduledExchanges = 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 ScheduledExchangesGetInfo
    {
        @DataMember
        public Long ExchangeID = null;

        @DataMember
        public Integer Acct = null;

        @DataMember
        public Integer Sub = null;

        @DataMember
        public String Name = null;

        @DataMember
        public String Address = null;

        @DataMember
        public String Address2 = null;

        @DataMember
        public String City = null;

        @DataMember
        public String Student = null;

        @DataMember
        public String School = null;

        @DataMember
        public String District = null;

        @DataMember
        public String Item = null;

        @DataMember
        public String Employee = null;

        @DataMember
        public Date ReturnedDate = null;

        @DataMember
        public String StockNumber = null;

        @DataMember
        public String Serial = null;

        @DataMember
        public String ReturnOption = null;

        @DataMember
        public String ScheduledReturnedRef = null;

        @DataMember
        public String Status = null;

        @DataMember
        public String History = null;

        @DataMember
        public Long ExchangeRef = null;

        @DataMember
        public Date AutoPayHoldDate = null;

        @DataMember
        public String ExchangedItem = null;

        @DataMember
        public Date PostingDate = null;

        @DataMember
        public Date ScheduledDate = null;

        @DataMember
        public String NewSku = null;

        @DataMember
        public String Notes = null;

        @DataMember
        public String Source = null;

        @DataMember
        public String Option = null;

        @DataMember
        public Boolean Processed = null;

        @DataMember
        public Boolean MobileExchangedStatus = null;
        
        public Long getExchangeID() { return ExchangeID; }
        public ScheduledExchangesGetInfo setExchangeID(Long value) { this.ExchangeID = value; return this; }
        public Integer getAcct() { return Acct; }
        public ScheduledExchangesGetInfo setAcct(Integer value) { this.Acct = value; return this; }
        public Integer getSub() { return Sub; }
        public ScheduledExchangesGetInfo setSub(Integer value) { this.Sub = value; return this; }
        public String getName() { return Name; }
        public ScheduledExchangesGetInfo setName(String value) { this.Name = value; return this; }
        public String getAddress() { return Address; }
        public ScheduledExchangesGetInfo setAddress(String value) { this.Address = value; return this; }
        public String getAddress2() { return Address2; }
        public ScheduledExchangesGetInfo setAddress2(String value) { this.Address2 = value; return this; }
        public String getCity() { return City; }
        public ScheduledExchangesGetInfo setCity(String value) { this.City = value; return this; }
        public String getStudent() { return Student; }
        public ScheduledExchangesGetInfo setStudent(String value) { this.Student = value; return this; }
        public String getSchool() { return School; }
        public ScheduledExchangesGetInfo setSchool(String value) { this.School = value; return this; }
        public String getDistrict() { return District; }
        public ScheduledExchangesGetInfo setDistrict(String value) { this.District = value; return this; }
        public String getItem() { return Item; }
        public ScheduledExchangesGetInfo setItem(String value) { this.Item = value; return this; }
        public String getEmployee() { return Employee; }
        public ScheduledExchangesGetInfo setEmployee(String value) { this.Employee = value; return this; }
        public Date getReturnedDate() { return ReturnedDate; }
        public ScheduledExchangesGetInfo setReturnedDate(Date value) { this.ReturnedDate = value; return this; }
        public String getStockNumber() { return StockNumber; }
        public ScheduledExchangesGetInfo setStockNumber(String value) { this.StockNumber = value; return this; }
        public String getSerial() { return Serial; }
        public ScheduledExchangesGetInfo setSerial(String value) { this.Serial = value; return this; }
        public String getReturnOption() { return ReturnOption; }
        public ScheduledExchangesGetInfo setReturnOption(String value) { this.ReturnOption = value; return this; }
        public String getScheduledReturnedRef() { return ScheduledReturnedRef; }
        public ScheduledExchangesGetInfo setScheduledReturnedRef(String value) { this.ScheduledReturnedRef = value; return this; }
        public String getStatus() { return Status; }
        public ScheduledExchangesGetInfo setStatus(String value) { this.Status = value; return this; }
        public String getHistory() { return History; }
        public ScheduledExchangesGetInfo setHistory(String value) { this.History = value; return this; }
        public Long getExchangeRef() { return ExchangeRef; }
        public ScheduledExchangesGetInfo setExchangeRef(Long value) { this.ExchangeRef = value; return this; }
        public Date getAutoPayHoldDate() { return AutoPayHoldDate; }
        public ScheduledExchangesGetInfo setAutoPayHoldDate(Date value) { this.AutoPayHoldDate = value; return this; }
        public String getExchangedItem() { return ExchangedItem; }
        public ScheduledExchangesGetInfo setExchangedItem(String value) { this.ExchangedItem = value; return this; }
        public Date getPostingDate() { return PostingDate; }
        public ScheduledExchangesGetInfo setPostingDate(Date value) { this.PostingDate = value; return this; }
        public Date getScheduledDate() { return ScheduledDate; }
        public ScheduledExchangesGetInfo setScheduledDate(Date value) { this.ScheduledDate = value; return this; }
        public String getNewSku() { return NewSku; }
        public ScheduledExchangesGetInfo setNewSku(String value) { this.NewSku = value; return this; }
        public String getNotes() { return Notes; }
        public ScheduledExchangesGetInfo setNotes(String value) { this.Notes = value; return this; }
        public String getSource() { return Source; }
        public ScheduledExchangesGetInfo setSource(String value) { this.Source = value; return this; }
        public String getOption() { return Option; }
        public ScheduledExchangesGetInfo setOption(String value) { this.Option = value; return this; }
        public Boolean isProcessed() { return Processed; }
        public ScheduledExchangesGetInfo setProcessed(Boolean value) { this.Processed = value; return this; }
        public Boolean isMobileExchangedStatus() { return MobileExchangedStatus; }
        public ScheduledExchangesGetInfo setMobileExchangedStatus(Boolean value) { this.MobileExchangedStatus = value; return this; }
    }

}

Java ScheduledExchangesGetRequest 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

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /api/ScheduledExchanges HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/json

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"ScheduledExchanges":[{"ExchangeID":0,"Acct":0,"Sub":0,"Name":"String","Address":"String","Address2":"String","City":"String","Student":"String","School":"String","District":"String","Item":"String","Employee":"String","ReturnedDate":"0001-01-01T00:00:00.0000000","StockNumber":"String","Serial":"String","ReturnOption":"String","ScheduledReturnedRef":"String","Status":"String","History":"String","ExchangeRef":0,"AutoPayHoldDate":"0001-01-01T00:00:00.0000000","ExchangedItem":"String","NewSku":"String","Notes":"String","Source":"String","Option":"String","Processed":false,"MobileExchangedStatus":false}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}