AIM Web Services

<back to all web services

CustomerDependantRequest

CustomerDependant
Requires active-e Customer Service.

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

public class dtos
{

    /**
    * CustomerDependantRequires active-e Customer Service.
    */
    @DataContract
    public static class CustomerDependantRequest extends BaseSecureRequest
    {
        /**
        * AIM Customer Account Number
        */
        @DataMember
        @ApiMember(DataType="integer", Description="AIM Customer Account Number", Format="int32", IsRequired=true, Name="Acct", ParameterType="query")
        public Integer Acct = null;

        /**
        * Name of the Dependant
        */
        @DataMember
        @ApiMember(DataType="string", Description="Name of the Dependant", IsRequired=true, Name="Name", ParameterType="query")
        public String Name = null;

        @DataMember
        public String OnlineId = null;

        @DataMember
        public String SchoolDistrict = null;

        @DataMember
        public String School = null;

        @DataMember
        public ArrayList<AttributeData> AttributeInfo = null;
        
        public Integer getAcct() { return Acct; }
        public CustomerDependantRequest setAcct(Integer value) { this.Acct = value; return this; }
        public String getName() { return Name; }
        public CustomerDependantRequest setName(String value) { this.Name = value; return this; }
        public String getOnlineId() { return OnlineId; }
        public CustomerDependantRequest setOnlineId(String value) { this.OnlineId = value; return this; }
        public String getSchoolDistrict() { return SchoolDistrict; }
        public CustomerDependantRequest setSchoolDistrict(String value) { this.SchoolDistrict = value; return this; }
        public String getSchool() { return School; }
        public CustomerDependantRequest setSchool(String value) { this.School = value; return this; }
        public ArrayList<AttributeData> getAttributeInfo() { return AttributeInfo; }
        public CustomerDependantRequest setAttributeInfo(ArrayList<AttributeData> value) { this.AttributeInfo = 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 AttributeData
    {
        @DataMember
        public String Name = null;

        @DataMember
        public String Value = null;
        
        public String getName() { return Name; }
        public AttributeData setName(String value) { this.Name = value; return this; }
        public String getValue() { return Value; }
        public AttributeData setValue(String value) { this.Value = value; return this; }
    }

    @DataContract
    public static class CustomerDependantResponse extends BaseResponse
    {
        
    }

    @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; }
    }

}

Java CustomerDependantRequest DTOs

POST /api/CustomerDependant HTTP/1.1 
Host: active-ewebservice.biz 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"Acct":0,"Name":"String","OnlineId":"String","SchoolDistrict":"String","School":"String","AttributeInfo":[{"Name":"String","Value":"String"}],"Token":"String","DeviceId":"String","AppId":"String","ApiKey":"String","OAuthToken":"String"}

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

{"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}