Overview
Use the Registration Search API to filter, sort and retrieve registration records across an Aimbase instance.
Related APIs:
- To create a registration record use the Registration API.
Possible response codes are:
- 200 (OK). The request was successful and the results will return.
- 400 (Bad Request). Along with the 400 response, the body of the response will contain an error message describing why the request was a bad request.
- 500 (Internal Server Error). An unknown error occurred.
Authenticate message header example:
Authenticate: Avala-Api {username}:{token}
The HTTP endpoints that will accept the POST data are:
https://{baseaddress}/CSI/api/RegistrationSearch
Below is the list of search properties that are accepted in the POST body.
Registration Search Data Schema
Field Name |
Required |
Format |
Description |
ManufacturerCode |
|
Max Length: 6 |
The code for the manufacturer that the registrations are under. |
SerialNumber |
|
Max Length: 100 |
The serial number (or HIN or VIN) of the registration that should be found. |
ProductCode |
|
Max Length: 50 |
|
ProductModelYear |
|
Integer Format |
|
BrandCode |
|
Max Length: 50 |
|
DealerNumber |
|
Max Length: 20 |
|
DealerLocation |
|
Max Length: 10 |
|
RegistrationSourceCode |
|
Max Length: 20 |
|
RegistrationTypeCode |
|
Max Length: 20 |
|
PageNumber |
|
Integer Format |
Default value is 1. |
PageSize |
|
Max Length: 4 |
Default value is 20 and the maximum value is 1000. |
OrderBy |
|
Max Length: 25 |
Default value is “Id”. Valid order by fields: Id, PurchaseDate, CreateDate |
IsOrderByDescending |
|
|
A Value of “1” indicates the results should be sorted in descending order and a value of “0” indicates ascending. |
Behavior
Posting search criteria will restrict the registrations based on the search criteria submitted. The service requires the registration search criteria to be in the body of the POST request. The service will return a collection of registrations and also include the total count of registrations for the search, the current page size, and the current page. To pull all results of the search the client is responsible for managing the paging and making subsequent API calls to retrieve all results.
Sample POST/Response (XML)
<RegistrationSearchRequestModel> <SerialNumber>SER111000</SerialNumber> </RegistrationSearchRequestModel
Sample POST (JSON)
{
"SerialNumber": "SER111000"
}
Sample Success XML Response
<RegistrationSearchResponseModel> <Total>1</Total> <PageSize>20</PageSize> <PageNumber>1</PageNumber> <Registrations> <RegistrationModel> <IsActive>true</IsActive> <IsUsed>false</IsUsed> <PurchaseDate>2014-02-11T00:00:00</PurchaseDate> <SerialNumber>SER111000</SerialNumber> <ManufacturerCode>MFG</ManufacturerCode> <ManufacturerName>Manufacturer</ManufacturerName> <RegistrationSourceCode>WebService</RegistrationSourceCode> <RegistrationTypeCode>Registration</RegistrationTypeCode> <DealerNumber>1000</DealerNumber> </DealerLocation> <DealerName>Dealer 1</DealerName> <DealerContact /> <DealerEmail /> <DealerAddress1 /> <DealerAddress2 /> <DealerCity /> <DealerState /> <DealerPostalCode /> <DealerCountryCode>US</DealerCountryCode> <DealerPhone /> <DealerFax /> <ProductCode>PC</ProductCode> <ProductModelYear>2014</ProductModelYear> <ProductModelName>2200 PC</ProductModelName> <ProductBrandCode>Brand</ProductBrandCode> <ProductCategory>Outboard Boats / Fiberglass Outboard Boats / 21ft - 23ft 11in</ProductCategory> <OwnerFirstName>John</OwnerFirstName> <OwnerLastName>Doe</OwnerLastName> <OwnerAddress1>123 Main Street</OwnerAddress1> <OwnerCity>New York</OwnerCity> <OwnerState>NY</OwnerState> <OwnerPostalCode>33469</OwnerPostalCode> <OwnerCountryCode>US</OwnerCountryCode> <OwnerLanguageCode>EN</OwnerLanguageCode> <OwnerEmailRefused>false</OwnerEmailRefused> <OwnerMailRefused>false</OwnerMailRefused> <OwnerPhoneRefused>false</OwnerPhoneRefused> <CreateDate>2015-07-20T12:26:50.98</CreateDate> <Customs /> </RegistrationModel> </Registrations> </RegistrationSearchResponseModel
Sample Success JSON Response
{
"Registrations": [
{
"IsActive": true,
"IsUsed": false,
"PurchaseDate": "2014-02-11T00:00:00",
"SerialNumber": "SER111000",
"ManufacturerCode": "MFG",
"ManufacturerName": "Manufacturer",
"RegistrationSourceCode": "WebService",
"RegistrationTypeCode": "Registration",
"DealerNumber": 1000,
"DealerLocation": "",
"DealerName": "Dealer 1",
"DealerContact": "",
"DealerEmail": "",
"DealerAddress1": "",
"DealerAddress2": "",
"DealerCity": "",
"DealerState": "",
"DealerPostalCode": "",
"DealerCountryCode": "US",
"DealerPhone": "",
"DealerFax": "",
"DealerTollFree": null,
"ProductCode": "PC1",
"ProductModelYear": "2022",
"ProductModelName": "2200 PC",
"ProductPlantCode": null,
"ProductBrandCode": "Brand",
"ProductCategory": "Outboard Boats / Fiberglass Outboard Boats / 21ft - 23ft 11in",
"ProductSegment": null,
"OwnerFirstName": "John",
"OwnerLastName": "Doe",
"OwnerTitle": null,
"OwnerAddress1": "123 Main Street",
"OwnerAddress2": null,
"OwnerCity": "New York",
"OwnerState": "NY",
"OwnerPostalCode": "33469",
"OwnerCountryCode": "US",
"OwnerCompanyName": null,
"OwnerCompanyName": "US",
"OwnerHomePhone": null,
"OwnerMobilePhone": null,
"OwnerWorkPhone": null,
"OwnerFax": null,
"OwnerEmail": null,
"OwnerLanguageCode": "EN",
"OwnerEmailRefused": false,
"OwnerMailRefused": false,
"OwnerPhoneRefused": false,
"CreateDate": "2020-08-07T12:27:24.767",
"Customs": [ ]
}
],
"Total": 1,
"PageSize": 20,
"PageNumber": 1
}