Get All Monitored

The Get All Monitored Faces API allows partners to retrieve a list of all individuals they have requested to be monitored by the Events Bridge system. This endpoint ensures that partners have a clear accounting of the faces they have enrolled for monitoring, even though the system may contain additional faces they are not aware of. This API is useful for synchronizing the partner’s system with Events Bridge, ensuring that both systems are fully in sync regarding monitored individuals.

Synchronization Use Case

This API provides an accounting of the individuals that the partner’s system has requested to monitor, allowing for synchronization between the partner's system and Events Bridge. Even though Events Bridge may be monitoring additional faces that the partner is unaware of, this call will only return those faces that the partner has explicitly enrolled. Partners can use this API to keep their system fully aligned with Events Bridge by periodically retrieving and updating their records based on the response.

API Endpoint

• HTTP Method: GET
• Endpoint: /api/v1/faces/monitored
• 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.

Code Examples

C#

using eConnect.EventsBridge.Sdk;

// Assuming sdk is already initialized with authentication
// Retrieve all monitored faces
var monitoredFaces = await sdk.FaceMonitorGetAllAsync();

// Process the results
foreach (var item in monitoredFaces)
{
    Console.WriteLine($"External ID: {item.ExternalId}, Enrolled: {item.Enrolled}, Expected: {item.Expected}");
}

Curl

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

# Retrieve all monitored faces
curl -X GET "$API_URL/api/v1/faces/monitored" \
  -H "Authorization: Bearer $TOKEN"

PowerShell

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

# Retrieve all monitored faces
$monitoredFaces = Invoke-RestMethod -Uri "$API_URL/api/v1/faces/monitored" -Method Get -Headers @{ "Authorization" = "Bearer $TOKEN" }

# Process the results
$monitoredFaces | ForEach-Object {
    Write-Output "External ID: $($_.externalId), Enrolled: $($_.enrolled), Expected: $($_.expected)"
}

Raw Sample

Here’s an example of how to use the GET method to retrieve all monitored faces:

Request

GET https://10.0.0.123:5022/api/v1/faces/monitored
Authorization: Bearer <your_jwt_token>
Content-Type: application/json

Response

• 200 OK: The list of monitored faces was successfully retrieved.
• 500 Internal Server Error: An issue occurred on the server side.
• 401 Unauthorized: Missing or invalid JWT token.

[
  {
    "externalId": "12345",
    "enrolled": 2,
    "expected": 2,
    "status": [
      {
        "serverName": "Server1",
        "enrolled": true
      },
      {
        "serverName": "Server2",
        "enrolled": true
      }
    ]
  },
  {
    "externalId": "67890",
    "enrolled": 1,
    "expected": 2,
    "status": [
      {
        "serverName": "Server1",
        "enrolled": true
      },
      {
        "serverName": "Server2",
        "enrolled": false
      }
    ]
  }
]

Field Descriptions

• externalId: The unique identifier supplied by the partner during enrollment, used to track the monitored individual.
• enrolled: Indicates how many FR systems this subject is enrolled in.
• expected: Indicates how many FR systems this subject is expected to be enrolled in.
• status: An array of objects showing the monitoring status for each server connected to Events Bridge.
• serverName: The name of the server where the face is being monitored.
• enrolled: A boolean value indicating whether the individual is actively monitored on the specific server.

Additional Notes

This endpoint retrieves all faces that the partner has enrolled for monitoring, ensuring they are aware of every individual they have requested the system to track. The externalId should be used by the partner to uniquely identify and manage the monitored individuals in their own system.