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.*


/**
* GetContractDetailsRequires active-e Contracts Service or active-e Customer Service
*/
@DataContract
open class GetContractDetailsRequest : BaseSecureRequest()
{
    @DataMember
    var Ref:String? = null

    @DataMember
    var Sub:Int? = null
}

@DataContract
open class BaseSecureRequest : BaseRequest()
{
    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")
    var Token:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")
    var DeviceId:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")
    var AppId:String? = null
}

@DataContract
open 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")
    var ApiKey:String? = null

    @DataMember
    @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
    var OAuthToken:String? = null
}

@DataContract
open class GetContractDetailsResponse : BaseResponse()
{
    @DataMember
    var AccountSub:String? = null

    @DataMember
    var NextDueDate:Date? = null

    @DataMember
    var PaymentAmount:BigDecimal? = null

    @DataMember
    var PastDueAmount:BigDecimal? = null

    @DataMember
    var LateCharges:BigDecimal? = null

    @DataMember
    var OtherCharges:BigDecimal? = null

    @DataMember
    var TotalDue:BigDecimal? = null

    @DataMember
    var AccumulatedCredit:BigDecimal? = null

    @DataMember
    var StudentName:String? = null

    @DataMember
    var SchoolName:String? = null

    @DataMember
    var Topic:String? = null

    @DataMember
    var Inventory:ArrayList<InventoryGeneric> = ArrayList<InventoryGeneric>()

    @DataMember
    var Payments:ArrayList<PaymentGeneric> = ArrayList<PaymentGeneric>()

    @DataMember
    var PaymentAmt:BigDecimal? = null

    @DataMember
    var PastDueAmt:BigDecimal? = null

    @DataMember
    var CurrentBalance:BigDecimal? = null

    @DataMember
    var TotalPayoff:BigDecimal? = null

    @DataMember
    var DiscountedPayoff:BigDecimal? = null

    @DataMember
    var PayoffDate:Date? = null
}

@DataContract
open class BaseResponse
{
    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
    var Status:BaseResponseResult? = null
}

@DataContract
open class BaseResponseResult
{
    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
    var StatusCode:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
    var Login:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
    var ErrorCode:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
    var ErrorDisplayText:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
    var ErrorMessage:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")
    var DomainName:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
    var IpAddress:String? = null
}

@DataContract
open class InventoryGeneric
{
    @DataMember
    var Model:String? = null

    @DataMember
    var Item:String? = null

    @DataMember
    var Sku:String? = null

    @DataMember
    var Serial:String? = null

    @DataMember
    var Desc:String? = null

    @DataMember
    var Mfg:String? = null
}

@DataContract
open class PaymentGeneric
{
    @DataMember
    var Date:Date? = null

    @DataMember
    var Amount:BigDecimal? = null

    @DataMember
    var Ref:String? = null
}

Kotlin GetContractDetailsRequest 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.

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

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

HTTP/1.1 200 OK
Content-Type: application/json
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"}}