Create Mismatch Alerts

Creates trailer mismatch observation alerts for the authenticated customer from standalone USDOT numbers, standalone MC numbers, and paired MC/USDOT records.

Authentication

• Include your Access-Token and x-api-key in the header of your requests.

Permissions

The external-api-mismatch-observations or admin permission is required to access this endpoint.

Endpoint

• URL: https://api.genlogs.io/mismatch-observations

• Method: POST

Headers

• Access-Token: (string, required): Access token obtained from the "Create Access Token" endpoint.

• x-api-key (string, required): The API key provided by GenLogs.

Request body:

• usdots (list of USDOTs, optional or required when mcs is not provided): list of the requested USDOT numbers to create a mismatch alert

• mcs (list of MCs, optional or required when usdots is not provided): list of the requested MC numbers to create a mismatch alert

• pairs (list of objects, optional): Paired MC/USDOT records. Each object creates one combined mismatch alert with both values.

  • Each pairs object must include:

    {"mc": "7894","usdot": "9637"}

• alert_name (srt, optional): related name of the alert(s) for client use.

• logos (list of Logos, optional): list of the optional logos names to create a mismatch alert

Request Example:

curl --location 'https://api.genlogs.io/mismatch-observations' \
--header 'access-token: <your-api-token>' \
--header 'x-api-key: <your-x-api-key>' \
--data-raw '{
  "usdots": ["10000", "200000", "300000"],
  "mcs": ["4000", "5000"],
  "pairs": [
    {
      "mc": "7894",
      "usdot": "9637"
    }
  ],
  "alert_name": "Custom mismatch trailer alert",
  "logos": ["logo_name1", "logo_name2"]
}'

Response:

• 201 Created: Returns a confirmation message and the count of created alerts.

• 400 Bad Request: Missing or invalid request parameters.

• 401 Unauthorized: Missing or invalid Access-Token.

• 403 Forbidden: User does not have the required permission.

• 500 Internal Server Error: Server error while processing the request.

Response Body:

201 Created

{
    "message": "Mismatch alerts created successfully.",
    "data": {
        "created": 4
    }
}

400 Bad Request

{
  "detail": "At least one USDOT, MC, or pair must be provided."
}

401 Forbidden

{
  "detail": {
    "message": "Token is missing",
    "subcode": "TOKEN_MISSING"
  }
}

403 Forbidden

{
    "detail": "User does not have the required permissions to access this resource"
}

Create mismatch observation alerts

post

Creates one alert row per standalone USDOT or MC value, and one combined row per item in pairs. At least one of usdots, mcs, or pairs must be non-empty. alert_name is optional; when omitted or blank, stored as null. logos is optional and, when present, is normalized to lowercase, stored in logos, and used by mismatch detection. Logo matching remains case-insensitive. Unknown JSON properties are rejected.

Authorizations

Access-Token & X-Api-Key

Access-TokenstringRequired

x-api-keystringRequired

Body

application/json

usdotsstring[]Optional

USDOT numbers (strings). Each non-empty entry creates one alert.

Default: []

mcsstring[]Optional

MC numbers (strings). Each non-empty entry creates one alert.

Default: []

logosstring[] · nullableOptional

Optional trailer logos list. Each value must be a non-empty string. Values are trimmed, deduplicated, and stored in lowercase format. Matching against the logos catalog.

alert_namestring · nullableOptional

Optional display name; omitted or whitespace-only is stored as null.

Responses

201

Mismatch alerts created successfully.

application/json

messagestringRequiredExample: Mismatch alerts created successfully.

400

Bad request – validation error or empty usdots/mcs/pairs.

401

Unauthorized – Invalid or missing Access-Token.

403

Forbidden – missing permission.

500

Internal Server Error.

post/mismatch-observations

HTTPcURLJavaScriptPython

POST /mismatch-observations HTTP/1.1
Host: api.genlogs.io
Access-Token: YOUR_API_KEY
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 31

{
  "usdots": [
    "1234567"
  ],
  "mcs": []
}

USDOT only, no nameWith optional alert nameUSDOT and MC listsPaired MC and USDOT

{
  "message": "Mismatch alerts created successfully.",
  "data": {
    "created": 3
  }
}