Unmonitoring a License Plate
The Unmonitor License Plate API allows partners to remove a vehicle's license plate from being monitored by the Events Bridge system. Once a plate is unmonitored, the system will stop tracking the vehicle associated with that license plate.
API Endpoint
- HTTP Method: DELETE
- Endpoint:
/api/v1/lpr/monitor/{externalId}
- Base URL:
https://10.0.0.123:5022
Authentication
This API call requires authentication with a JWT token, which must be passed in the header of the request.
Path Parameter
- externalId: The unique ID assigned by the partner’s system to identify the vehicle being unmonitored. This ID must be the same one used during the initial enrollment. This ID does not need to be the same as the Plate value.
Code Examples
- C#
- Curl
- PowerShell
using eConnect.EventsBridge.Sdk;
// Assuming sdk is already initialized with authentication
// Define the externalId
string externalId = "12345";
// Unmonitor the license plate
await sdk.LprUnMonitorAsync(externalId);
# Define variables
API_URL="https://your-domain.com/eventsbridge"
TOKEN="your_token"
EXTERNAL_ID="12345"
# Unmonitor the license plate
curl -X DELETE "$API_URL/api/v1/lpr/monitor/$EXTERNAL_ID" \
-H "Authorization: Bearer $TOKEN"
# Define variables
$API_URL = "https://your-domain.com/eventsbridge"
$TOKEN = "your_token"
$EXTERNAL_ID = "12345"
# Unmonitor the license plate
Invoke-RestMethod -Uri "$API_URL/api/v1/lpr/monitor/$EXTERNAL_ID" -Method Delete -Headers @{ "Authorization" = "Bearer $TOKEN" }
Raw Sample
Here’s an example of how to use the DELETE method to unmonitor a license plate:
Request
DELETE https://10.0.0.123:5022/api/v1/lpr/monitor/ABC123
Authorization: Bearer <your_jwt_token>
Content-Type: application/json
Response
- 200 OK: The license plate has been successfully removed from monitoring.
- 500 Internal Server Error: An issue occurred on the server side.
- 401 Unauthorized: Missing or invalid JWT token.
Example Response
{
}
Additional Notes
- Ensure that the externalId provided in the URL is the same one used during the initial enrollment.
- The system will return a
200 OK
response if the plate was successfully unmonitored, or a500 Internal Server Error
if there were any issues processing the request.