Operations at https://api.silentpassenger.com/rest/v2

This page describes the service operations at this endpoint.

Uri Method Description
{APIKey}/Alerts GET Get the list of all landmark alerts for the mobile group's vehicles. This requires Landmark Alert to first be defined in Silent Passenger.
{APIKey}/Alerts/DestinationAlert POST Set up one time arrival/departure alerts.
{APIKey}/Alerts/NoMovementAlert POST Set up one time no movement alert.
{APIKey}/Alerts2/DestinationAlert POST Set up one time arrival/departure alerts. Returns Wrapped response.
{APIKey}/Alerts2/NoMovementAlert POST Set up one time no movement alert. Returns Wrapped response.
{APIKey}/DataPoints GET Get historical data for the user's vehicles. The call will return all datapoints since the last call.
{APIKey}/Driver GET Get driver record
GET Get driver list with assigned subgroups. Each driver returned by this method will also include list of subgroups it is assigned to.
PUT Create new driver
POST Update driver record. Also perform driver subgroup assignment. This method will do a diff compare of the supplied subgroups and currently assigned subgroups, adding new ones and removing the ones that are not found in the supplied list.
DELETE Delete driver record
{APIKey}/DriverAssignment POST Assign driver to a vehicle
{APIKey}/Driver-Photo POST Upload driver photo
{APIKey}/DriverStops PUT Send stop to a Garmin unit in a vehicle that the driver is assigned to. DCDriverStop object must be passed in the message body. If successfull, will return StopItem that can be used to monitor the stop status.
{APIKey}/eta POST Get ETA for the provided array of waypoints.
{APIKey}/eta2 POST Get ETA from an origin to a destination.
{APIKey}/Fleet GET Get list of vehicles that are in the user's subgroup and user has chosen to view. The returned dataset contains lighter version of vehicle information.
{APIKey}/GeoFenceCategories PUT Create a GeoFence category. Notes for the category can be passed in the message body.
GET Get all available GeoFence categories for user's mobile group.
{APIKey}/GeoFences PUT Add a GeoFence to mobile group's GeoFences. GeoFence object must be passed in the message body.
POST Add a list of GeoFences to mobile group's GeoFences. GeoFence object array must be passed in the message body.
GET Get a GeoFence by it's unique identifier.
GET Get the list of all GeoFences for the user's mobile group.
DELETE Delete all GeoFences in the given category.
{APIKey}/Landmark GET Get a landmark.
DELETE Delete a landmark.
POST Update landmark. LandmarkItem object must be passed in the message body.
{APIKey}/LandmarkCategories GET Get all available landmark categories for user's mobile group.
{APIKey}/LandmarkCategory POST Move landmark to a different category.
{APIKey}/LandmarkRadii GET Get all available landmark radius values.
{APIKey}/Landmarks PUT Add a landmark to mobile group's landmarks. LandmarkItem object must be passed in the message body.
PUT Create a landmark for the given vehicle location.
POST Add a list of landmarks to mobile group's landmarks. LandmarkItem object array must be passed in the message body.
DELETE Delete landmarks in a category.
GET Get paginated list of landmarks. PageSize parameter determines how many landmarks are returned in each response. PageNumber parameter specifies which subset of landmark list to return. Prefix can be specified to search landmarks by it. CategoryID can be passed to get landmarks for that category (pass zero to return landmarks in all categories).
{APIKey}/Landmarks/{keyword} GET Get all available landmarks that start with the search keyword.
{APIKey}/Landmarks/Accounts POST Get landmarks by account numbers.
{APIKey}/Landmarks/Accounts/{AccountNo} GET Get a landmark by account number.
{APIKey}/Landmarks/Reload POST Delete all landmarks and then add a list of landmarks to mobile group's landmarks. LandmarkItem object array must be passed in the message body.
{APIKey}/Landmarks2 PUT Add a landmark to mobile group's landmarks. LandmarkItem object must be passed in the message body. After successfully adding the landmark, newly created landmark will be returned. Optional: You can set the optional parameter "GeocodedAddressAsLocationName" to "true" to use the geocoded address as location name for the landmark
POST Add a list of landmarks to mobile group's landmarks. LandmarkItem object array must be passed in the message body. After successfully adding landmarks, newly created landmarks will be returned. Optional: You can set the optional parameter "GeocodedAddressAsLocationName" to "true" to use the geocoded addresses as location name for the landmarks
{APIKey}/MapView/Vehicle GET Get single vehicle object by its Id and provide necessary information to be plotted on the map.
{APIKey}/MapView/Vehicle/Dispatch POST Get dispatch tab content for the vehicle.
{APIKey}/MapView/Vehicles GET Get list of lighter vehicle objects that are in the user's subgroup and provide necessary information to be plotted on the map.
{APIKey}/OfficeUserWithExtrasList GET Retrieve the list of office user names, ids, types along with assigned branches and geofence categories
{APIKey}/OptimalRoute POST Optimizes provided waypoints returning reordered list.
{APIKey}/Reports/Stops GET Generate stops report for a vehicle with provided parameters.
{APIKey}/RoutePlayback GET Retrieve a breadcrumb trail for a vehicle for the given date range.
{APIKey}/RoutePlayback/Today GET Get today's route for a vehicle.
{APIKey}/Routes GET Get all incomplete routes that are viewable by the user.
GET Get route by it's unique identifier.
POST Creates new route if route does not already exist, or updates existing one.
PUT Send route to Garmin.
{APIKey}/send-snapshot POST Generate and send SP QuickView for a vehicle.
{APIKey}/SGData GET Get SpeedGauge event log.
{APIKey}/Snapshot POST Generate SP QuickView for a vehicle.
GET Get completed SP QuickView list.
{APIKey}/Snapshot/{Fingerprint} DELETE Deactivate existing SP QuickView.
{APIKey}/Stops PUT Send stop to a Garmin unit. StopItem object must be passed in the message body. If successfull, will return StopItem that can be used to monitor the stop status.
GET Get stop by it's unique identifier.
DELETE Delete stop.
{APIKey}/User GET Retrieve user information
PUT Authenticate user and assign the provided API Key if authenticated
PUT Authenticate user and assign the provided API Key if authenticated. Application ID will also be bound to the API Key.
{APIKey}/User/Subgroups GET Get all subgroups that the user is allowed and has selected to view
PUT Select and deselect user's subgroups
{APIKey}/User2 PUT Authenticate user and assign the provided API Key if authenticated. Application ID will also be bound to the API Key. Should be used in iOS development with RestKit
{APIKey}/User2/Subgroups PUT Select and deselect user's subgroups. Used in iOS development with RestKit.
{APIKey}/VehicleNames GET Retrieve user's vehicle names and their corresponding IDs.
{APIKey}/Vehicles GET Retrieve all vehicles, associated with the user's mobile group.
GET Get list of vehicles that are in the user's subgroup and user has chosen to view.
PUT Update notes for a vehicle. The notes can then be shown on the Map View.
POST Update vehicle record. This method will update VehicleName, Odometer, TripOdometer, CumHours and Notes fields.
{APIKey}/Vehicles/{Imei} GET Get vehicle by the IMEI of the installed unit.
{APIKey}/Vehicles/Toggle POST Toggle vehicle visibility.