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
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using AIM.WebService;
using AIM;

namespace AIM
{
    [DataContract]
    public partial class InventoryGeneric
    {
        [DataMember]
        public virtual string Model { get; set; }

        [DataMember]
        public virtual string Item { get; set; }

        [DataMember]
        public virtual string Sku { get; set; }

        [DataMember]
        public virtual string Serial { get; set; }

        [DataMember]
        public virtual string Desc { get; set; }

        [DataMember]
        public virtual string Mfg { get; set; }
    }

    [DataContract]
    public partial class PaymentGeneric
    {
        [DataMember]
        public virtual DateTime Date { get; set; }

        [DataMember]
        public virtual decimal Amount { get; set; }

        [DataMember]
        public virtual string Ref { get; set; }
    }

}

namespace AIM.WebService
{
    [DataContract]
    public partial class 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")]
        public virtual string ApiKey { get; set; }

        [DataMember]
        [ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")]
        public virtual string OAuthToken { get; set; }
    }

    [DataContract]
    public partial class BaseResponse
    {
        ///<summary>
        ///
        ///</summary>
        [DataMember]
        [ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")]
        public virtual BaseResponseResult Status { get; set; }
        [DataContract]
        public partial class BaseResponseResult
        {
            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")]
            public virtual string StatusCode { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")]
            public virtual string Login { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")]
            public virtual string ErrorCode { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")]
            public virtual string ErrorDisplayText { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")]
            public virtual string ErrorMessage { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")]
            public virtual string DomainName { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")]
            public virtual string IpAddress { get; set; }
        }

    }

    [DataContract]
    public partial class BaseSecureRequest
        : BaseRequest
    {
        ///<summary>
        ///
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")]
        public virtual string Token { get; set; }

        ///<summary>
        ///
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")]
        public virtual string DeviceId { get; set; }

        ///<summary>
        ///
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")]
        public virtual string AppId { get; set; }
    }

    ///<summary>
    ///GetContractDetailsRequires active-e Contracts Service or active-e Customer Service
    ///</summary>
    [DataContract]
    public partial class GetContractDetailsRequest
        : BaseSecureRequest
    {
        [DataMember]
        public virtual string Ref { get; set; }

        [DataMember]
        public virtual int? Sub { get; set; }
    }

    [DataContract]
    public partial class GetContractDetailsResponse
        : BaseResponse
    {
        public GetContractDetailsResponse()
        {
            Inventory = new List<InventoryGeneric>{};
            Payments = new List<PaymentGeneric>{};
        }

        [DataMember]
        public virtual string AccountSub { get; set; }

        [DataMember]
        public virtual DateTime NextDueDate { get; set; }

        [DataMember]
        public virtual decimal PaymentAmount { get; set; }

        [DataMember]
        public virtual decimal PastDueAmount { get; set; }

        [DataMember]
        public virtual decimal LateCharges { get; set; }

        [DataMember]
        public virtual decimal OtherCharges { get; set; }

        [DataMember]
        public virtual decimal TotalDue { get; set; }

        [DataMember]
        public virtual decimal AccumulatedCredit { get; set; }

        [DataMember]
        public virtual string StudentName { get; set; }

        [DataMember]
        public virtual string SchoolName { get; set; }

        [DataMember]
        public virtual string Topic { get; set; }

        [DataMember]
        public virtual List<InventoryGeneric> Inventory { get; set; }

        [DataMember]
        public virtual List<PaymentGeneric> Payments { get; set; }

        [DataMember]
        public virtual decimal PaymentAmt { get; set; }

        [DataMember]
        public virtual decimal PastDueAmt { get; set; }

        [DataMember]
        public virtual decimal CurrentBalance { get; set; }

        [DataMember]
        public virtual decimal TotalPayoff { get; set; }

        [DataMember]
        public virtual decimal? DiscountedPayoff { get; set; }

        [DataMember]
        public virtual DateTime PayoffDate { get; set; }
    }

}

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