| GET | /api/C2BGetUnfinishedContracts |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Type | query | string | No | |
| StartOffset | query | int? | No | |
| RecordCount | query | int? | No | |
| SearchStr | query | string | No | |
| IncludeContractsEnteredByOtherUsers | query | bool | No | |
| DistrictId | query | long? | No | |
| SchoolId | query | long? | No | |
| TeacherId | query | long? | No | |
| DeliveryDesc | query | string | No | |
| Status | query | string | 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 |
|---|---|---|---|---|
| UnfinishedContracts | form | List<UnfinishedContract> | No | |
| Topic | form | string | No | |
| BaseUrl | form | string | 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 |
|---|---|---|---|---|
| CustomerName | form | string | No | |
| CustomerAcct | form | int | No | |
| StudentName | form | string | No | |
| Ref | form | string | No | |
| DateTime | form | DateTime | No | |
| Location | form | LocationInfo | No | |
| District | form | string | No | |
| School | form | string | No | |
| Teacher | form | string | No | |
| Instrument | form | string | No | |
| Status | form | string | No | |
| Notes | form | string | No | |
| LockedBy | form | string | No | |
| InstrumentGrade | form | string | No | |
| Serial | form | string | No | |
| Salesperson | form | string | No | |
| WebNotes | form | string | No | |
| form | string | No | ||
| Phone | form | string | No | |
| DeliveryDate | form | DateTime? | No | |
| FirstDue | form | DateTime? | No | |
| Accessories | form | List<C2BAccessory> | No | |
| DownPay | form | decimal | No | |
| MonthlyPay | form | decimal | No | |
| DownMaint | form | decimal | No | |
| MonthlyMaint | form | decimal | No | |
| DownLease | form | decimal | No | |
| MonthlyLease | form | decimal | No | |
| DownTotal | form | decimal | No | |
| Address | form | string | No | |
| Address2 | form | string | No | |
| City | form | string | No | |
| State | form | string | No | |
| Zip | form | string | No | |
| Country | form | string | No | |
| InvoiceCreated | form | bool | No | |
| ContractCreated | form | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | long | No | |
| Desc | form | string | No | |
| ShortDesc | form | string | No | |
| Region | form | string | No | |
| Latitude | form | decimal | No | |
| Longitude | form | decimal | No | |
| InStorePickup | form | string | No | |
| Active | form | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | long | No | |
| Description | form | string | No | |
| Price | form | decimal | No | |
| Type | form | string | No | |
| Sku | form | string | No | |
| Category | form | int? | No | |
| Delivered | form | bool | 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.
GET /api/C2BGetUnfinishedContracts HTTP/1.1 Host: active-ewebservice.biz Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"UnfinishedContracts":[{"CustomerName":"String","CustomerAcct":0,"StudentName":"String","Ref":"String","Location":{"Id":0,"Desc":"String","ShortDesc":"String","Region":"String","Latitude":0,"Longitude":0,"InStorePickup":"String","Active":false},"District":"String","School":"String","Teacher":"String","Instrument":"String","Status":"String","Notes":"String","LockedBy":"String","InstrumentGrade":"String","Serial":"String","Salesperson":"String","WebNotes":"String","Email":"String","Phone":"String","DeliveryDate":"0001-01-01T00:00:00.0000000","FirstDue":"0001-01-01T00:00:00.0000000","Accessories":[{"Id":0,"Description":"String","Price":0,"Type":"String","Sku":"String","Category":0,"Delivered":false}],"DownPay":0,"MonthlyPay":0,"DownMaint":0,"MonthlyMaint":0,"DownLease":0,"MonthlyLease":0,"DownTotal":0,"Address":"String","Address2":"String","City":"String","State":"String","Zip":"String","Country":"String","InvoiceCreated":false,"ContractCreated":false}],"Topic":"String","BaseUrl":"String","Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}