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 .xml suffix or ?format=xml
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/xml
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <AdvancedCustomerSearchResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService"> <Status> <DomainName>String</DomainName> <ErrorCode>String</ErrorCode> <ErrorDisplayText>String</ErrorDisplayText> <ErrorMessage>String</ErrorMessage> <IpAddress>String</IpAddress> <Login>String</Login> <StatusCode>String</StatusCode> </Status> <Customers> <AdvancedCustomerSearchRecord> <Acct>0</Acct> <Amount>0</Amount> <DateTime>0001-01-01T00:00:00</DateTime> <Name>String</Name> <ResultDetail>String</ResultDetail> <ResultType>String</ResultType> <Sub>0</Sub> </AdvancedCustomerSearchRecord> </Customers> <RemainingRecords>0</RemainingRecords> </AdvancedCustomerSearchResponse>