--- updatedAt: 2026-06-05T18:59:29.000Z agentTools: projectIndex: https://developer.eagleeyenetworks.com/llms.txt --- # /lprVehicleLists:listFieldValues Fetches the list of field values including possible values for each key in userData. # OpenAPI definition ```json { "openapi": "3.0.3", "info": { "title": "VEHICLE SURVEILLANCE PACKAGE", "version": "3.0.0" }, "servers": [ { "url": "https://{BaseUrl}/api/v3.0", "description": "Eagle Eye Networks API Server", "variables": { "BaseUrl": { "default": "api.cxxx.eagleeyenetworks.com", "description": "HTTPS Base url to use for all API calls, retrieved from https://api.eagleeyenetworks.com/api/v3.0/clientSettings" } } } ], "security": [ { "bearerAuth": [] } ], "tags": [ { "name": "LPR Vehicle Lists", "description": "Lists of vehicles that can be used in LPR rules." } ], "paths": { "/lprVehicleLists:listFieldValues": { "get": { "operationId": "getVehicleListFieldValues", "tags": [ "LPR Vehicle Lists" ], "description": "Fetches the list of field values including possible values for each key in userData.", "responses": { "200": { "description": "Possible values of each field", "content": { "application/json": { "schema": { "type": "object", "properties": { "accessType": { "type": "array", "items": { "$ref": "#/components/schemas/AccessType1" } }, "userData": { "type": "object", "description": "List of possible values for keys in user supplied data." }, "userTags": { "type": "array", "description": "List of possible values for userTags.", "items": { "type": "string" } }, "actor": { "type": "array", "description": "List of actors referenced by all lists collectively", "items": { "$ref": "#/components/schemas/Actor" } }, "securityStatus": { "type": "array", "description": "List of the distinct security statuses present across all the vehicle lists for this account.", "items": { "$ref": "#/components/schemas/SecurityStatus" } } }, "example": { "accessType": [ "allow", "deny" ], "userData": { "organization": [ "ABC", "PQR" ], "parkingType": [ "monthly", "visitor" ] }, "userTags": [ "John", "105A" ], "securityStatus": [ "hotlist", "exempted" ], "actor": [ { "type": "camera", "id": "camera-123456", "name": "entrance LPR" }, { "type": "camera", "id": "camera-876543", "name": "exit LPR" } ] } } } } }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "500": { "$ref": "#/components/responses/internalServerError" } } } } }, "components": { "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT" } }, "schemas": { "ActorFilter": { "type": "object", "description": "Specifies the attributes of an actor, useful for passing as a filter", "properties": { "id": { "type": "string", "description": "The id of the thing that caused the event This can be camera or location ID. If not supplied for any entry in the array, it is taken to mean as the entire account.", "example": "100b913c" }, "type": { "type": "string", "enum": [ "camera", "location" ], "default": "camera", "description": "Type of actor that caused the event." } }, "required": [ "type" ] }, "Actor": { "type": "object", "description": "Specifies the complete attributes of an actor, including the user-supplied field `name`", "allOf": [ { "$ref": "#/components/schemas/ActorFilter" }, { "type": "object", "properties": { "name": { "type": "string", "description": "User-defined name for the actor", "example": "Entrance LPR Camera" } } } ] }, "ApiV3Error": { "type": "object", "properties": { "code": { "description": "HTTP code defined in EEN Standard Code Values", "type": "integer" }, "status": { "description": "A string enum describing the code", "type": "string", "enum": [ "cancelled", "unknown", "invalidArgument", "deadlineExceeded", "notFound", "conflict", "permissionDenied", "resourceExhausted", "failedPrecondition", "aborted", "outOfRange", "unimplemented", "internal", "unavailable", "dataLoss", "unauthenticated", "mediaTypeNotSupported", "acceptNotSupported", "methodNotSupported", "tooManyRequests", "badGateway" ] }, "message": { "description": "Developer friendly human readable error message in English", "type": "string" }, "details": { "description": "An array of extensible objects that define error information", "type": "array", "items": { "$ref": "#/components/schemas/ExceptionDetail" } } }, "required": [ "code", "status", "message", "details" ] }, "ExceptionDetail": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/ErrorInfoExceptionDetail" }, { "$ref": "#/components/schemas/BadRequestExceptionDetail" }, { "$ref": "#/components/schemas/ResourceInfoExceptionDetail" } ], "discriminator": { "propertyName": "type", "mapping": { "errorInfo": "#/components/schemas/ErrorInfoExceptionDetail", "badRequest": "#/components/schemas/BadRequestExceptionDetail", "resourceInfo": "#/components/schemas/ResourceInfoExceptionDetail" } }, "properties": { "type": { "description": "A string enum describing the type of detail object.", "type": "string", "enum": [ "errorInfo", "badRequest", "resourceInfo" ] } }, "required": [ "type" ] }, "ErrorInfoExceptionDetail": { "properties": { "type": { "description": "A string enum describing the type of detail object.", "type": "string", "enum": [ "errorInfo" ] }, "reason": { "description": "The reason for the error. This is a constant value that identifies the proximate cause of the\nerror. Error reasons are unique within a particular domain of errors.\n", "type": "string", "enum": [ "unauthenticated", "unexpectedArgument", "missingRequiredArgument", "wrongArgumentValue", "invalidPermission", "wrongEdition", "wrongAccountType", "resourceNotFound", "endpointNotFound", "methodNotSupported", "unexpectedError", "acceptNotSupported", "alreadyExists", "foreignKeyConflict", "childDevicesExist", "contentNotSupported", "deadlineExpired", "tooManyRequests", "deviceUnavailable", "serviceUnavailable", "invalidJSON", "resourceLocked", "notSupportedOnBridge", "outOfRetention", "deviceIdentificationFailed", "credentialValidationFailed", "credentialSetupFailed", "localUrlValidationFailed", "hwRegistrationFailed", "failedAddingCameraAfterValidation", "neverConnected", "reconnectFailed", "unsupportedModel", "purged", "userBlocked", "userTemporarilyBlocked", "quotaExceeded", "alreadyValidated", "reAuthenticationRequired", "badGateway" ] }, "domain": { "description": "Logical grouping to which the \"reason\" belongs\n", "type": "string" }, "metadata": { "$ref": "#/components/schemas/ExceptionMetadata" } } }, "BadRequestExceptionDetail": { "properties": { "type": { "description": "A string enum describing the type of detail object.", "type": "string", "enum": [ "badRequest" ] }, "argumentViolations": { "type": "array", "items": { "$ref": "#/components/schemas/ArgumentViolation" } } } }, "ArgumentViolation": { "properties": { "argumentName": { "type": "string", "description": "Name of the argument" }, "description": { "type": "string", "description": "Description of the violation" } } }, "ResourceInfoExceptionDetail": { "properties": { "type": { "description": "A string enum describing the type of detail object.", "type": "string", "enum": [ "resourceInfo" ] }, "resource": { "description": "Referenced resource type, eg \"cameras\", \"bridges\", or \"locations\".", "type": "string" }, "ids": { "type": "array", "description": "Identities of resources", "items": { "type": "string" } } } }, "ExceptionMetadata": { "properties": { "path": { "description": "Path of the request", "type": "string" }, "method": { "description": "Method of the request", "type": "string" } } }, "SecurityStatus": { "type": "string", "deprecated": true, "enum": [ "hotlist", "exempted" ], "description": "Indicates whether vehicle is\n * hotlist: Vehicle flagged for tracking\n * exempted: Vehicle is exempt from watchlist rule and other rules. This is useful, for instance, when an organization wishes to avoid alerts on known vehicles, like employee vehicles.\n\n * none: Empty value provided when no special consideration for the vehicle", "example": "exempted" }, "AccessType1": { "type": "string", "enum": [ "allow", "deny" ] } }, "responses": { "unauthorized": { "description": "You are not authenticated. Please authenticate and try again.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiV3Error" }, "example": { "code": 401, "status": "unauthenticated", "message": "The client caller does not have a valid authentication credential", "details": [ { "type": "errorInfo", "reason": "unauthenticated", "domain": "apiv3", "metadata": { "path": "/api/v3.0/" } } ] } } } }, "forbidden": { "description": "You have no permission to access the specified resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiV3Error" }, "examples": { "invalidPermission": { "value": { "code": 403, "status": "permissionDenied", "message": "The client caller does not have permission for the specified operation", "details": [ { "type": "errorInfo", "reason": "invalidPermission", "domain": "apiv3", "metadata": { "path": "/api/v3.0/" } } ] } }, "wrongEdition": { "value": { "code": 403, "status": "permissionDenied", "message": "This feature is not enabled for the account", "details": [ { "type": "errorInfo", "reason": "wrongEdition", "domain": "apiv3", "metadata": { "path": "/api/v3.0/locations" } } ] } }, "wrongAccountType": { "value": { "code": 403, "status": "permissionDenied", "message": "This feature is only available for end users", "details": [ { "type": "errorInfo", "reason": "wrongAccountType", "domain": "apiv3", "metadata": { "path": "/api/v3.0/locations" } } ] } } } } } }, "internalServerError": { "description": "Something went wrong in the server. Please try again.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiV3Error" }, "example": { "code": 500, "status": "internal", "message": "An internal error has occurred. Please try again later.", "details": [ { "type": "errorInfo", "reason": "unexpectedError", "domain": "apiv3", "metadata": { "path": "/api/v3.0/" } } ] } } } } } }, "x-readme": { "explorer-enabled": true } } ```