| GET | /api/AdvancedCustomerSearch |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SearchType | query | string | Yes | The type of advanced search. Options are SUBACCOUNT (Students and Dependents), CHECK (Exact Check# lookup), and CREDITCARD (Last 4 lookup) |
| SearchString | query | string | Yes | What to search for |
| StartOffset | query | integer | No | The Starting Offset. Defaults to 0 if not sent. |
| RecordCount | query | integer | No | The # of records to be returned. Defaults to 100 if not sent. |
| 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 |
|---|---|---|---|---|
| RemainingRecords | form | long | No | |
| Customers | form | List<AdvancedCustomerSearchRecord> | 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 |
|---|---|---|---|---|
| Acct | form | int | No | |
| Sub | form | int? | No | |
| Name | form | string | No | |
| ResultType | form | string | No | |
| ResultDetail | form | string | No | |
| DateTime | form | DateTime? | No | |
| Amount | form | decimal? | 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/AdvancedCustomerSearch HTTP/1.1 Host: active-ewebservice.biz Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"RemainingRecords":0,"Customers":[{"Acct":0,"Sub":0,"Name":"String","ResultType":"String","ResultDetail":"String","DateTime":"0001-01-01T00:00:00.0000000","Amount":0}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}