| POST, GET | /api/GetContractDetails |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Ref | body | string | No | |
| Sub | body | int? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Token | Header | string | No | |
| DeviceId | Header | string | No | |
| AppId | Header | string | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ApiKey | header | string | Yes | This is your AIM API Key provided by Tri-Tech |
| OAuthToken | header | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AccountSub | form | string | No | |
| NextDueDate | form | DateTime | No | |
| PaymentAmount | form | decimal | No | |
| PastDueAmount | form | decimal | No | |
| LateCharges | form | decimal | No | |
| OtherCharges | form | decimal | No | |
| TotalDue | form | decimal | No | |
| AccumulatedCredit | form | decimal | No | |
| StudentName | form | string | No | |
| SchoolName | form | string | No | |
| Topic | form | string | No | |
| Inventory | form | List<InventoryGeneric> | No | |
| Payments | form | List<PaymentGeneric> | No | |
| PaymentAmt | form | decimal | No | |
| PastDueAmt | form | decimal | No | |
| CurrentBalance | form | decimal | No | |
| TotalPayoff | form | decimal | No | |
| DiscountedPayoff | form | decimal? | No | |
| PayoffDate | form | DateTime | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Status | body | BaseResponseResult | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| StatusCode | body | string | No | |
| Login | body | string | No | |
| ErrorCode | body | string | No | |
| ErrorDisplayText | body | string | No | |
| ErrorMessage | body | string | No | |
| DomainName | body | string | No | |
| IpAddress | body | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Model | form | string | No | |
| Item | form | string | No | |
| Sku | form | string | No | |
| Serial | form | string | No | |
| Desc | form | string | No | |
| Mfg | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Date | form | DateTime | No | |
| Amount | form | decimal | No | |
| Ref | form | string | No |
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
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"}}