AIM Web Services

<back to all web services

C2BAccessoryListingRequest

C2BAccessoryListing
Requires active-e Contracts Service.

import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    /**
    * C2BAccessoryListingRequires active-e Contracts Service.
    */
    @DataContract
    public static class C2BAccessoryListingRequest extends BaseSecureRequest
    {
        /**
        * Defaults to True
        */
        @DataMember
        @ApiMember(Description="Defaults to True", Name="IncludeAccessories", ParameterType="query")
        public Boolean IncludeAccessories = null;

        /**
        * Defaults to False
        */
        @DataMember
        @ApiMember(Description="Defaults to False", Name="IncludeDeliveryOptions", ParameterType="query")
        public Boolean IncludeDeliveryOptions = null;

        /**
        * Defaults to False
        */
        @DataMember
        @ApiMember(Description="Defaults to False", Name="IncludeMaintenanceOptions", ParameterType="query")
        public Boolean IncludeMaintenanceOptions = null;

        /**
        * If passed, only accessories for the given instrument are returned
        */
        @DataMember
        @ApiMember(Description="If passed, only accessories for the given instrument are returned", Name="InstrumentId", ParameterType="query")
        public Long InstrumentId = null;
        
        public Boolean isIncludeAccessories() { return IncludeAccessories; }
        public C2BAccessoryListingRequest setIncludeAccessories(Boolean value) { this.IncludeAccessories = value; return this; }
        public Boolean isIncludeDeliveryOptions() { return IncludeDeliveryOptions; }
        public C2BAccessoryListingRequest setIncludeDeliveryOptions(Boolean value) { this.IncludeDeliveryOptions = value; return this; }
        public Boolean isIncludeMaintenanceOptions() { return IncludeMaintenanceOptions; }
        public C2BAccessoryListingRequest setIncludeMaintenanceOptions(Boolean value) { this.IncludeMaintenanceOptions = value; return this; }
        public Long getInstrumentId() { return InstrumentId; }
        public C2BAccessoryListingRequest setInstrumentId(Long value) { this.InstrumentId = 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 C2BGetDistrictInfoResponse extends BaseResponse
    {
        @DataMember
        public ArrayList<C2BDistrictGeneric> Districts = null;

        @DataMember
        public Boolean TeacherTableExists = null;
        
        public ArrayList<C2BDistrictGeneric> getDistricts() { return Districts; }
        public C2BGetDistrictInfoResponse setDistricts(ArrayList<C2BDistrictGeneric> value) { this.Districts = value; return this; }
        public Boolean isTeacherTableExists() { return TeacherTableExists; }
        public C2BGetDistrictInfoResponse setTeacherTableExists(Boolean value) { this.TeacherTableExists = 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 C2BDistrictGeneric
    {
        @DataMember
        public String DistrictName = null;

        @DataMember
        public Integer SchoolCount = null;

        @DataMember
        public Integer TeacherCount = null;

        @DataMember
        public String Topic = null;

        @DataMember
        public Long Id = null;
        
        public String getDistrictName() { return DistrictName; }
        public C2BDistrictGeneric setDistrictName(String value) { this.DistrictName = value; return this; }
        public Integer getSchoolCount() { return SchoolCount; }
        public C2BDistrictGeneric setSchoolCount(Integer value) { this.SchoolCount = value; return this; }
        public Integer getTeacherCount() { return TeacherCount; }
        public C2BDistrictGeneric setTeacherCount(Integer value) { this.TeacherCount = value; return this; }
        public String getTopic() { return Topic; }
        public C2BDistrictGeneric setTopic(String value) { this.Topic = value; return this; }
        public Long getId() { return Id; }
        public C2BDistrictGeneric setId(Long value) { this.Id = value; return this; }
    }

}

Java C2BAccessoryListingRequest DTOs

GET /api/C2BAccessoryListing HTTP/1.1 
Host: active-ewebservice.biz 
Accept: text/jsonl

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"Districts":[{}],"TeacherTableExists":false,"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}