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

Namespace Global

    Namespace AIM

        <DataContract>
        Public Partial Class InventoryGeneric
            <DataMember>
            Public Overridable Property Model As String

            <DataMember>
            Public Overridable Property Item As String

            <DataMember>
            Public Overridable Property Sku As String

            <DataMember>
            Public Overridable Property Serial As String

            <DataMember>
            Public Overridable Property Desc As String

            <DataMember>
            Public Overridable Property Mfg As String
        End Class

        <DataContract>
        Public Partial Class PaymentGeneric
            <DataMember>
            Public Overridable Property [Date] As Date

            <DataMember>
            Public Overridable Property Amount As Decimal

            <DataMember>
            Public Overridable Property Ref As String
        End Class
    End Namespace

    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 Overridable Property ApiKey As String

            <DataMember>
            <ApiMember(DataType:="string", Name:="OAuthToken", ParameterType:="header")>
            Public Overridable Property OAuthToken As String
        End Class

        <DataContract>
        Public Partial Class BaseResponse
            '''<Summary>
            '''
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="BaseResponseResult", Description:="", Name:="Status", ParameterType:="body")>
            Public Overridable Property Status As BaseResponseResult

            <DataContract>
            Public Partial Class BaseResponseResult
                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", Name:="StatusCode", ParameterType:="body")>
                Public Overridable Property StatusCode As String

                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", Name:="Login", ParameterType:="body")>
                Public Overridable Property Login As String

                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", Name:="ErrorCode", ParameterType:="body")>
                Public Overridable Property ErrorCode As String

                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", Name:="ErrorDisplayText", ParameterType:="body")>
                Public Overridable Property ErrorDisplayText As String

                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", Name:="ErrorMessage", ParameterType:="body")>
                Public Overridable Property ErrorMessage As String

                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", ExcludeInSchema:=true, Name:="DomainName", ParameterType:="body")>
                Public Overridable Property DomainName As String

                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", ExcludeInSchema:=true, Name:="IPAddress", ParameterType:="body")>
                Public Overridable Property IpAddress As String
            End Class
        End Class

        <DataContract>
        Public Partial Class BaseSecureRequest
            Inherits BaseRequest
            '''<Summary>
            '''
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="", Name:="Token", ParameterType:="Header")>
            Public Overridable Property Token As String

            '''<Summary>
            '''
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="", Name:="DeviceId", ParameterType:="Header")>
            Public Overridable Property DeviceId As String

            '''<Summary>
            '''
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="", IsRequired:=true, Name:="AppId", ParameterType:="Header")>
            Public Overridable Property AppId As String
        End Class

        '''<Summary>
        '''GetContractDetailsRequires active-e Contracts Service or active-e Customer Service
        '''</Summary>
        <DataContract>
        Public Partial Class GetContractDetailsRequest
            Inherits BaseSecureRequest
            <DataMember>
            Public Overridable Property Ref As String

            <DataMember>
            Public Overridable Property Sub As Nullable(Of Integer)
        End Class

        <DataContract>
        Public Partial Class GetContractDetailsResponse
            Inherits BaseResponse
            Public Sub New()
                Inventory = New List(Of InventoryGeneric)
                Payments = New List(Of PaymentGeneric)
            End Sub

            <DataMember>
            Public Overridable Property AccountSub As String

            <DataMember>
            Public Overridable Property NextDueDate As Date

            <DataMember>
            Public Overridable Property PaymentAmount As Decimal

            <DataMember>
            Public Overridable Property PastDueAmount As Decimal

            <DataMember>
            Public Overridable Property LateCharges As Decimal

            <DataMember>
            Public Overridable Property OtherCharges As Decimal

            <DataMember>
            Public Overridable Property TotalDue As Decimal

            <DataMember>
            Public Overridable Property AccumulatedCredit As Decimal

            <DataMember>
            Public Overridable Property StudentName As String

            <DataMember>
            Public Overridable Property SchoolName As String

            <DataMember>
            Public Overridable Property Topic As String

            <DataMember>
            Public Overridable Property Inventory As List(Of InventoryGeneric)

            <DataMember>
            Public Overridable Property Payments As List(Of PaymentGeneric)

            <DataMember>
            Public Overridable Property PaymentAmt As Decimal

            <DataMember>
            Public Overridable Property PastDueAmt As Decimal

            <DataMember>
            Public Overridable Property CurrentBalance As Decimal

            <DataMember>
            Public Overridable Property TotalPayoff As Decimal

            <DataMember>
            Public Overridable Property DiscountedPayoff As Nullable(Of Decimal)

            <DataMember>
            Public Overridable Property PayoffDate As Date
        End Class
    End Namespace
End Namespace

VB.NET 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"}}