AutoAlert API Help Page

This help page describes the AutoAlert API. API methods are grouped by controller. Click on a specific API method to see the details for the method.

For a general introduction to the API, please review Introducing the AutoAlert API.

Customer

API	Description
POST Customer/get	Get a Customer by CustomerID.

Dealer

API	Description
POST Dealer/getactivityhistory	Get a list of activities by FromDateUTC and optionally filtered by Activity Type.
POST Dealer/getdealer	Get dealer information. May return one or more dealers based on the dealers associated with the authenticated User.
POST Dealer/getextcustomeractivityhistory	Get a list of AutoAssistant and GeoAlert activities by FromDateUTC.
POST Dealer/getscheduledactivity	Get a list of scheduled activities optionally filtered by Activity Type.

DealSheet

API	Description
POST DealSheet/addbadcontact	Add bad contact
POST DealSheet/calculate	Return calculated payments for a given EntityID.
POST DealSheet/get	Get a dealsheet for a given EntityID.
POST DealSheet/postaction	Post Action.
POST DealSheet/postactivity	Post Activity.
POST DealSheet/postvendoractivity	Post Activity from vendor systems.
POST DealSheet/saveconquest	Save Conquest Info.
POST DealSheet/savecontacts	Save Coustomer Contacts.

Entity

API	Description
POST Entity/getallentities	Get a list of all entities filtered by FromDateUTC.

General

API	Description
POST General/getactivities	Get changed Activity data.
POST General/getactivityactions	Get changed Activity Actions data.
POST General/getactivityresults	Get changed Activity Result data.
POST General/getactivitystatuses	Get changed Activity Status data.
POST General/getactivitytypes	Get changed Activity Type data.
POST General/getapiversion	Get API version.
POST General/getmakes	Get changed Make data.
POST General/getmodels	Get changed Model data.
POST General/getservice	Get changed Service data.
POST General/gettrims	Get changed Trim data.
POST General/getusers	Get changed User data.
POST General/getyears	Get changed Year data.

Healthz

API	Description
GET api/healthz	Responds to both /healthz and /api/healthz to confirm the application is alive.
GET healthz	Responds to both /healthz and /api/healthz to confirm the application is alive.

Opportunity

API	Description
POST Opportunity/getdateoppslastupdated	Get the date Opportunities were last updated
POST Opportunity/getopportunities	No documentation available.

Search

API	Description
POST Search/getentities	Get a entities (opportunities), top 5 or all.
POST Search/getinventory	Get inventory list.

Sync

API	Description
POST Sync/getentityversions	Get Entity versions.
POST Sync/getinitialentities	Get Initial Data.
POST Sync/getlogindata	Get Login Data.

User

API	Description
POST User/authenticate	Authenticates a user and returns a user token.
POST User/autologin	Authenticates a user and returns a user token.
POST User/changestore	Change the store for a given user.
POST User/getipaddress	Get the IP Address of the caller.
POST User/getmobilesettings	Get the mobile settings for the user. Returns settings as a Dictionary of string [key] and string [value].
POST User/getusers	Get list of users including their dealsheet access code.
POST User/logoff	Logs the current user off.
POST User/registerpushid	Register Push ID's.
POST User/renewtoken	Renews a user token.
POST User/savemobilesettings	Save the mobile settings for the user. Settings are sent as a Dictionary of string [key] and string [value].

Vehicle

API	Description
POST Vehicle/getnotowned	Get a list of all vehicles marked as no longer owned by the customer.
POST Vehicle/logvisit	Logs a vehicle visit.