License Plate Monitoring Status

The Check License Plate Status API allows you to verify if a specific vehicle (identified by its externalId) is currently being monitored in the Events Bridge system. This can help you ensure that the license plate is actively monitored, or confirm its removal.

API Endpoint

• HTTP Method: GET
• Endpoint: /api/v1/lpr/monitor/{externalId}
• Private Server Base URL: https://10.0.0.123:5022
• Cloud Server Base URL: https://customername.econnectcloud.com/eventsbridge

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 provided by the partner's system to identify the vehicle during enrollment. This value is case sensitive, and is not necessarily the plate itself.

Code Examples

C#

using eConnect.EventsBridge.Sdk;

// Assuming sdk is already initialized with authentication
// Define the externalId
string externalId = "12345";

// Check enrollment status
var status = await sdk.LprMonitorStatusCheckAsync(externalId);

// Process the result
Console.WriteLine($"License Plate with External ID {externalId} is {(status.Enrolled ? "enrolled" : "not enrolled")}.");

Curl

# Define variables
API_URL="https://your-domain.com/eventsbridge"
TOKEN="your_token"
EXTERNAL_ID="12345"

# Check enrollment status
curl -X GET "$API_URL/api/v1/lpr/monitor/$EXTERNAL_ID" \
  -H "Authorization: Bearer $TOKEN"

PowerShell

# Define variables
$API_URL = "https://your-domain.com/eventsbridge"
$TOKEN = "your_token"
$EXTERNAL_ID = "12345"

# Check enrollment status
$statusResponse = Invoke-RestMethod -Uri "$API_URL/api/v1/lpr/monitor/$EXTERNAL_ID" -Method Get -Headers @{ "Authorization" = "Bearer $TOKEN" }

# Process the result
Write-Output "License Plate with External ID $EXTERNAL_ID is $($statusResponse.enrolled ? 'enrolled' : 'not enrolled')."

Raw Sample

Here's an example of how to use the GET method to check the monitoring status of a license plate:

Request

GET 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's monitoring status was successfully retrieved.
• 401 Unauthorized: Missing or invalid JWT token.
• 500 Internal Server Error: An issue occurred on the server side.

Example Response

{
  "enrolled": true
}

Field Descriptions

• enrolled (Boolean): Whether the license plate is currently monitored.
  • true: the plate is monitored on every connected LPR server.
  • false: the plate is missing from at least one of them.

false does not mean "not enrolled anywhere"

This flag is an AND across all connected LPR services. If several are behind Events Bridge and the plate is enrolled on some but not all, this returns false even though detections may still be reported from the servers that do have it.

To see the per-server breakdown, use Retrieve All Monitored License Plates, which reports enrolled and expected counts along with a status entry for each server.

Additional Notes

• Ensure that the externalId provided in the URL is the same one used during enrollment. It is case sensitive.
• This endpoint is useful for confirming whether a license plate is actively being monitored or has been removed from monitoring.