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

// @DataContract
export class BaseRequest
{
    /** @description 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 ApiKey: string;

    // @DataMember
    // @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
    public OAuthToken: string;

    public constructor(init?: Partial<BaseRequest>) { (Object as any).assign(this, init); }
}

// @DataContract
export class BaseSecureRequest extends BaseRequest
{
    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")
    public Token: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")
    public DeviceId: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")
    public AppId: string;

    public constructor(init?: Partial<BaseSecureRequest>) { super(init); (Object as any).assign(this, init); }
}

// @DataContract
export class BaseResponseResult
{
    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
    public StatusCode: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
    public Login: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
    public ErrorCode: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
    public ErrorDisplayText: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
    public ErrorMessage: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")
    public DomainName: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
    public IpAddress: string;

    public constructor(init?: Partial<BaseResponseResult>) { (Object as any).assign(this, init); }
}

// @DataContract
export class BaseResponse
{
    /** @description  */
    // @DataMember
    // @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
    public Status: BaseResponseResult;

    public constructor(init?: Partial<BaseResponse>) { (Object as any).assign(this, init); }
}

// @DataContract
export class InventoryGeneric
{
    // @DataMember
    public Model: string;

    // @DataMember
    public Item: string;

    // @DataMember
    public Sku: string;

    // @DataMember
    public Serial: string;

    // @DataMember
    public Desc: string;

    // @DataMember
    public Mfg: string;

    public constructor(init?: Partial<InventoryGeneric>) { (Object as any).assign(this, init); }
}

// @DataContract
export class PaymentGeneric
{
    // @DataMember
    public Date: string;

    // @DataMember
    public Amount: number;

    // @DataMember
    public Ref: string;

    public constructor(init?: Partial<PaymentGeneric>) { (Object as any).assign(this, init); }
}

// @DataContract
export class GetContractDetailsResponse extends BaseResponse
{
    // @DataMember
    public AccountSub: string;

    // @DataMember
    public NextDueDate: string;

    // @DataMember
    public PaymentAmount: number;

    // @DataMember
    public PastDueAmount: number;

    // @DataMember
    public LateCharges: number;

    // @DataMember
    public OtherCharges: number;

    // @DataMember
    public TotalDue: number;

    // @DataMember
    public AccumulatedCredit: number;

    // @DataMember
    public StudentName: string;

    // @DataMember
    public SchoolName: string;

    // @DataMember
    public Topic: string;

    // @DataMember
    public Inventory: InventoryGeneric[];

    // @DataMember
    public Payments: PaymentGeneric[];

    // @DataMember
    public PaymentAmt: number;

    // @DataMember
    public PastDueAmt: number;

    // @DataMember
    public CurrentBalance: number;

    // @DataMember
    public TotalPayoff: number;

    // @DataMember
    public DiscountedPayoff?: number;

    // @DataMember
    public PayoffDate: string;

    public constructor(init?: Partial<GetContractDetailsResponse>) { super(init); (Object as any).assign(this, init); }
}

/** @description GetContractDetailsRequires active-e Contracts Service or active-e Customer Service */
// @DataContract
export class GetContractDetailsRequest extends BaseSecureRequest
{
    // @DataMember
    public Ref: string;

    // @DataMember
    public Sub?: number;

    public constructor(init?: Partial<GetContractDetailsRequest>) { super(init); (Object as any).assign(this, init); }
}

TypeScript 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"}}