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
namespace AIM

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<DataContract>]
    [<AllowNullLiteral>]
    type BaseResponseResult() = 
        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")>]
        member val StatusCode:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")>]
        member val Login:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")>]
        member val ErrorCode:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")>]
        member val ErrorDisplayText:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")>]
        member val ErrorMessage:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")>]
        member val DomainName:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")>]
        member val IpAddress:String = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type BaseResponse() = 
        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")>]
        member val Status:BaseResponseResult = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type InventoryGeneric() = 
        [<DataMember>]
        member val Model:String = null with get,set

        [<DataMember>]
        member val Item:String = null with get,set

        [<DataMember>]
        member val Sku:String = null with get,set

        [<DataMember>]
        member val Serial:String = null with get,set

        [<DataMember>]
        member val Desc:String = null with get,set

        [<DataMember>]
        member val Mfg:String = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type PaymentGeneric() = 
        [<DataMember>]
        member val Date:DateTime = new DateTime() with get,set

        [<DataMember>]
        member val Amount:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val Ref:String = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type GetContractDetailsResponse() = 
        inherit BaseResponse()
        [<DataMember>]
        member val AccountSub:String = null with get,set

        [<DataMember>]
        member val NextDueDate:DateTime = new DateTime() with get,set

        [<DataMember>]
        member val PaymentAmount:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val PastDueAmount:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val LateCharges:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val OtherCharges:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val TotalDue:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val AccumulatedCredit:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val StudentName:String = null with get,set

        [<DataMember>]
        member val SchoolName:String = null with get,set

        [<DataMember>]
        member val Topic:String = null with get,set

        [<DataMember>]
        member val Inventory:ResizeArray<InventoryGeneric> = new ResizeArray<InventoryGeneric>() with get,set

        [<DataMember>]
        member val Payments:ResizeArray<PaymentGeneric> = new ResizeArray<PaymentGeneric>() with get,set

        [<DataMember>]
        member val PaymentAmt:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val PastDueAmt:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val CurrentBalance:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val TotalPayoff:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val DiscountedPayoff:Nullable<Decimal> = new Nullable<Decimal>() with get,set

        [<DataMember>]
        member val PayoffDate:DateTime = new DateTime() with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type BaseRequest() = 
        ///<summary>
        ///This is your AIM API Key provided by Tri-Tech
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="This is your AIM API Key provided by Tri-Tech", IsRequired=true, Name="ApiKey", ParameterType="header")>]
        member val ApiKey:String = null with get,set

        [<DataMember>]
        [<ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")>]
        member val OAuthToken:String = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type BaseSecureRequest() = 
        inherit BaseRequest()
        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")>]
        member val Token:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")>]
        member val DeviceId:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")>]
        member val AppId:String = null with get,set

    ///<summary>
    ///GetContractDetailsRequires active-e Contracts Service or active-e Customer Service
    ///</summary>
    [<DataContract>]
    [<AllowNullLiteral>]
    type GetContractDetailsRequest() = 
        inherit BaseSecureRequest()
        [<DataMember>]
        member val Ref:String = null with get,set

        [<DataMember>]
        member val Sub:Nullable<Int32> = new Nullable<Int32>() with get,set

F# 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"}}