AIM Web Services

<back to all web services

GetContractDetailsRequest

GetContractDetails
Requires active-e Contracts Service or active-e Customer Service

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

public class dtos
{

    /**
    * GetContractDetailsRequires active-e Contracts Service or active-e Customer Service
    */
    @DataContract
    public static class GetContractDetailsRequest extends BaseSecureRequest
    {
        @DataMember
        public String Ref = null;

        @DataMember
        public Integer Sub = null;
        
        public String getRef() { return Ref; }
        public GetContractDetailsRequest setRef(String value) { this.Ref = value; return this; }
        public Integer getSub() { return Sub; }
        public GetContractDetailsRequest setSub(Integer value) { this.Sub = 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 GetContractDetailsResponse extends BaseResponse
    {
        @DataMember
        public String AccountSub = null;

        @DataMember
        public Date NextDueDate = null;

        @DataMember
        public BigDecimal PaymentAmount = null;

        @DataMember
        public BigDecimal PastDueAmount = null;

        @DataMember
        public BigDecimal LateCharges = null;

        @DataMember
        public BigDecimal OtherCharges = null;

        @DataMember
        public BigDecimal TotalDue = null;

        @DataMember
        public BigDecimal AccumulatedCredit = null;

        @DataMember
        public String StudentName = null;

        @DataMember
        public String SchoolName = null;

        @DataMember
        public String Topic = null;

        @DataMember
        public ArrayList<InventoryGeneric> Inventory = null;

        @DataMember
        public ArrayList<PaymentGeneric> Payments = null;

        @DataMember
        public BigDecimal PaymentAmt = null;

        @DataMember
        public BigDecimal PastDueAmt = null;

        @DataMember
        public BigDecimal CurrentBalance = null;

        @DataMember
        public BigDecimal TotalPayoff = null;

        @DataMember
        public BigDecimal DiscountedPayoff = null;

        @DataMember
        public Date PayoffDate = null;
        
        public String getAccountSub() { return AccountSub; }
        public GetContractDetailsResponse setAccountSub(String value) { this.AccountSub = value; return this; }
        public Date getNextDueDate() { return NextDueDate; }
        public GetContractDetailsResponse setNextDueDate(Date value) { this.NextDueDate = value; return this; }
        public BigDecimal getPaymentAmount() { return PaymentAmount; }
        public GetContractDetailsResponse setPaymentAmount(BigDecimal value) { this.PaymentAmount = value; return this; }
        public BigDecimal getPastDueAmount() { return PastDueAmount; }
        public GetContractDetailsResponse setPastDueAmount(BigDecimal value) { this.PastDueAmount = value; return this; }
        public BigDecimal getLateCharges() { return LateCharges; }
        public GetContractDetailsResponse setLateCharges(BigDecimal value) { this.LateCharges = value; return this; }
        public BigDecimal getOtherCharges() { return OtherCharges; }
        public GetContractDetailsResponse setOtherCharges(BigDecimal value) { this.OtherCharges = value; return this; }
        public BigDecimal getTotalDue() { return TotalDue; }
        public GetContractDetailsResponse setTotalDue(BigDecimal value) { this.TotalDue = value; return this; }
        public BigDecimal getAccumulatedCredit() { return AccumulatedCredit; }
        public GetContractDetailsResponse setAccumulatedCredit(BigDecimal value) { this.AccumulatedCredit = value; return this; }
        public String getStudentName() { return StudentName; }
        public GetContractDetailsResponse setStudentName(String value) { this.StudentName = value; return this; }
        public String getSchoolName() { return SchoolName; }
        public GetContractDetailsResponse setSchoolName(String value) { this.SchoolName = value; return this; }
        public String getTopic() { return Topic; }
        public GetContractDetailsResponse setTopic(String value) { this.Topic = value; return this; }
        public ArrayList<InventoryGeneric> getInventory() { return Inventory; }
        public GetContractDetailsResponse setInventory(ArrayList<InventoryGeneric> value) { this.Inventory = value; return this; }
        public ArrayList<PaymentGeneric> getPayments() { return Payments; }
        public GetContractDetailsResponse setPayments(ArrayList<PaymentGeneric> value) { this.Payments = value; return this; }
        public BigDecimal getPaymentAmt() { return PaymentAmt; }
        public GetContractDetailsResponse setPaymentAmt(BigDecimal value) { this.PaymentAmt = value; return this; }
        public BigDecimal getPastDueAmt() { return PastDueAmt; }
        public GetContractDetailsResponse setPastDueAmt(BigDecimal value) { this.PastDueAmt = value; return this; }
        public BigDecimal getCurrentBalance() { return CurrentBalance; }
        public GetContractDetailsResponse setCurrentBalance(BigDecimal value) { this.CurrentBalance = value; return this; }
        public BigDecimal getTotalPayoff() { return TotalPayoff; }
        public GetContractDetailsResponse setTotalPayoff(BigDecimal value) { this.TotalPayoff = value; return this; }
        public BigDecimal getDiscountedPayoff() { return DiscountedPayoff; }
        public GetContractDetailsResponse setDiscountedPayoff(BigDecimal value) { this.DiscountedPayoff = value; return this; }
        public Date getPayoffDate() { return PayoffDate; }
        public GetContractDetailsResponse setPayoffDate(Date value) { this.PayoffDate = 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 InventoryGeneric
    {
        @DataMember
        public String Model = null;

        @DataMember
        public String Item = null;

        @DataMember
        public String Sku = null;

        @DataMember
        public String Serial = null;

        @DataMember
        public String Desc = null;

        @DataMember
        public String Mfg = null;
        
        public String getModel() { return Model; }
        public InventoryGeneric setModel(String value) { this.Model = value; return this; }
        public String getItem() { return Item; }
        public InventoryGeneric setItem(String value) { this.Item = value; return this; }
        public String getSku() { return Sku; }
        public InventoryGeneric setSku(String value) { this.Sku = value; return this; }
        public String getSerial() { return Serial; }
        public InventoryGeneric setSerial(String value) { this.Serial = value; return this; }
        public String getDesc() { return Desc; }
        public InventoryGeneric setDesc(String value) { this.Desc = value; return this; }
        public String getMfg() { return Mfg; }
        public InventoryGeneric setMfg(String value) { this.Mfg = value; return this; }
    }

    @DataContract
    public static class PaymentGeneric
    {
        @DataMember
        public Date Date = null;

        @DataMember
        public BigDecimal Amount = null;

        @DataMember
        public String Ref = null;
        
        public Date getDate() { return Date; }
        public PaymentGeneric setDate(Date value) { this.Date = value; return this; }
        public BigDecimal getAmount() { return Amount; }
        public PaymentGeneric setAmount(BigDecimal value) { this.Amount = value; return this; }
        public String getRef() { return Ref; }
        public PaymentGeneric setRef(String value) { this.Ref = value; return this; }
    }

}

Java GetContractDetailsRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

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

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

{"Ref":"String","Sub":0,"Token":"String","DeviceId":"String","AppId":"String","ApiKey":"String","OAuthToken":"String"}

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

{"AccountSub":"String","PaymentAmount":0,"PastDueAmount":0,"LateCharges":0,"OtherCharges":0,"TotalDue":0,"AccumulatedCredit":0,"StudentName":"String","SchoolName":"String","Topic":"String","Inventory":[{"Model":"String","Item":"String","Sku":"String","Serial":"String","Desc":"String","Mfg":"String"}],"Payments":[{"Amount":0,"Ref":"String"}],"PaymentAmt":0,"PastDueAmt":0,"CurrentBalance":0,"TotalPayoff":0,"DiscountedPayoff":0,"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}