{ "openapi": "3.1.0", "info": { "title": "Unified Clockworks API", "description": "Like OneAPI but newer", "version": "0.1.0" }, "paths": { "/blicker/alive": { "get": { "tags": [ "utility" ], "summary": "Check whether API is online", "description": "Endpoint that can be used to check whether the API is up and running.", "operationId": "_alive_endpoint_blicker_alive_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } } }, "/blicker/2020-02-01": { "post": { "tags": [ "AI" ], "summary": "Blicker Endpoint 2020-02-01", "description": "# Using the blicker API - version: 2020-02-01\n\nThis takes the image provided as file in multipart formdata and reads the\nmeter in the image. The other parameters below may be included in the form or\nspecified as query parameters.\n\n\n\nAlternatively, you may provide the image directly as body with optional base64\nencoding. In that case, the parameters below can only be specified as query\nparameters.\n\n\n\nThe header should contain your 'subscription-key'.\n\n\n\nThe form body supports the following parameters:\n\n- **image** : The image (as a .jpg, .png, .bmp, .tiff, .webp, .jp2, .heif, or\n.heic) to analyse. The original image must be at least 320 x 320 and can be at\nmost 20 MB.\n- **ranges** : {_\"display_index\"_: {\"min\": _the minimum expected value_,\n\"max\": _the maximum expected value_} The range within which the display\nreading is expected. The AI could favour likely readings within this.\nEither _min_ or _max_ or both could be provided.\n- **serialNumber** : [_expected serial number_] The expected serial number of\nthe meter. If this serial number is found, no warnings are given. Otherwise we\n notify that we could not verify that the meter has the provided serial number.\n This does not necessarily mean that it is not the correct meter!\n- **referenceId**: A string that will be returned in the result, can be used\n for client-side bookkeeping. The referenceId will also be logged by us, and\n can therefore be used in support requests.\n- **meterCategory** : The expected meter category of the meter. One of:\n [_'electricity'_, _'gas'_, _'water'_]\n- **displayType** : The expected display type of the meter. One of:\n ['analog', 'digital']\n- **language** : The language in which the warnings should be returned.\n- **nDigits** : The number of expected digits per display.\n- **nDisplays** : The number of expected displays.", "operationId": "Blicker_endpoint_2020_02_01_blicker_2020_02_01_post", "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_Blicker_endpoint_2020_02_01_blicker_2020_02_01_post" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlickerAPIResponseModel_2020_02_01" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/blicker/2020-05-01": { "post": { "tags": [ "AI" ], "summary": "Blicker Endpoint 2020-05-01", "description": "# Using the blicker API - version: 2020-05-01\n\nThis takes the image provided as file in multipart formdata and reads the\nmeter in the image. The other parameters below may be included in the form or\nspecified as query parameters.\n\n\n\nAlternatively, you may provide the image directly as body with optional base64\nencoding. In that case, the parameters below can only be specified as query\nparameters.\n\n\n\nThe header should contain your 'subscription-key'.\n\n\n\nThe form body supports the following parameters:\n\n- **image** : The image (as a .jpg, .png, .bmp, .tiff, .webp, .jp2, .heif, or\n.heic) to analyse. The original image must be at least 320 x 320 and can be at\nmost 20 MB.\n- **ranges** : {_\"display_index\"_: {\"min\": _the minimum expected value_,\n\"max\": _the maximum expected value_} The range within which the display\nreading is expected. The AI could favour likely readings within this.\nEither _min_ or _max_ or both could be provided.\n- **serialNumber** : [_expected serial number_] The expected serial number of\nthe meter. If this serial number is found, no warnings are given. Otherwise we\n notify that we could not verify that the meter has the provided serial number.\n This does not necessarily mean that it is not the correct meter!\n- **referenceId**: A string that will be returned in the result, can be used\n for client-side bookkeeping. The referenceId will also be logged by us, and\n can therefore be used in support requests.\n- **meterCategory** : The expected meter category of the meter. One of:\n [_'electricity'_, _'gas'_, _'water'_]\n- **displayType** : The expected display type of the meter. One of:\n ['analog', 'digital']\n- **language** : The language in which the warnings should be returned.\n- **nDigits** : The number of expected digits per display.\n- **nDisplays** : The number of expected displays.\n\n- **GPSLocation** : The expected GPS location of the image taken.\n- **datetime** : The expected datetime of the image taken.", "operationId": "Blicker_endpoint_2020_05_01_blicker_2020_05_01_post", "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_Blicker_endpoint_2020_05_01_blicker_2020_05_01_post" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlickerAPIResponseModel_2020_05_01" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/blicker/2020-10-01": { "post": { "tags": [ "AI" ], "summary": "Blicker Endpoint 2020-10-01", "description": "# Using the blicker API - version: 2020-10-01\n\nThis takes the image provided as file in multipart formdata and reads the\nmeter in the image. The other parameters below may be included in the form or\nspecified as query parameters.\n\n\n\nAlternatively, you may provide the image directly as body with optional base64\nencoding. In that case, the parameters below can only be specified as query\nparameters.\n\n\n\nThe header should contain your 'subscription-key'.\n\n\n\nThe form body supports the following parameters:\n\n- **image** : The image (as a .jpg, .png, .bmp, .tiff, .webp, .jp2, .heif, or\n.heic) to analyse. The original image must be at least 320 x 320 and can be at\nmost 20 MB.\n- **ranges** : {_\"display_index\"_: {\"min\": _the minimum expected value_,\n\"max\": _the maximum expected value_} The range within which the display\nreading is expected. The AI could favour likely readings within this.\nEither _min_ or _max_ or both could be provided.\n- **serialNumber** : [_expected serial number_] The expected serial number of\nthe meter. If this serial number is found, no warnings are given. Otherwise we\n notify that we could not verify that the meter has the provided serial number.\n This does not necessarily mean that it is not the correct meter!\n- **referenceId**: A string that will be returned in the result, can be used\n for client-side bookkeeping. The referenceId will also be logged by us, and\n can therefore be used in support requests.\n- **meterCategory** : The expected meter category of the meter. One of:\n [_'electricity'_, _'gas'_, _'water'_]\n- **displayType** : The expected display type of the meter. One of:\n ['analog', 'digital']\n- **language** : The language in which the warnings should be returned.\n- **nDigits** : The number of expected digits per display.\n- **nDisplays** : The number of expected displays.\n\n- **GPSLocation** : The expected GPS location of the image taken.\n- **datetime** : The expected datetime of the image taken.\n\n- **tags** : Comma-separated tags to be added to the request.", "operationId": "Blicker_endpoint_2020_10_01_blicker_2020_10_01_post", "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_Blicker_endpoint_2020_10_01_blicker_2020_10_01_post" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlickerAPIReponseModel_2020_10_01" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/blicker/2020-10-01/feedback": { "put": { "tags": [ "Feedback" ], "summary": "Blicker Feedback Endpoint 2020-10-01", "description": "# Using the blicker feedback API - version: 2020-10-01\n\n\n\nThis endpoint allows you to provide feedback on the result of a Blicker API\ncall. Your request should contain a JSON document with a requestId at the very\nleast.\n\n\n\nFeedback can be provided on the same request multiple times, where the specified\nfields will replace the values provided earlier. For example, if you provide a\nnew list of tags, they will fully replace the existing tags rather than being\nmerged with the previous list.\n\n\n\nThe feedback request must be made with the same subscription as the original\nrequest and the current data region must match the original request, otherwise\na 404 error will be returned.\n\n\n\nThe JSON object supports the following fields:\n\n* ***requestId** : The request to provide feedback on.\n* **tags** : The tags to set for the request.\n* **referenceId** : The reference ID to associate with the request.\n* **objects** : The corrected tree of objects for the image associated with this\n request.", "operationId": "Blicker_feedback_endpoint_2020_10_01_blicker_2020_10_01_feedback_put", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/blicker__api__blicker__api_responders__response_constructor_2020_10_01__BlickerAPIFeedbackResponseConstructor_2020_10_01__RequestParams" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlickerAPIFeedbackResponse_model_2020_10_01" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/blicker/2024-03-01": { "post": { "tags": [ "AI" ], "summary": "Blicker Endpoint 2024-03-01", "description": "# Using the blicker API - version: 2024-03-01\n\nThis takes the image provided as file in multipart formdata and reads the\nmeter in the image. The other parameters below may be included in the form or\nspecified as query parameters.\n\n\n\nAlternatively, you may provide the image directly as body with optional base64\nencoding. In that case, the parameters below can only be specified as query\nparameters.\n\n\n\nThe header should contain your 'subscription-key'.\n\n\n\nThe form body supports the following parameters:\n\n- **image** : The image (as a .jpg, .png, .bmp, .tiff, .webp, .jp2, .heif, or\n.heic) to analyse. The original image must be at least 320 x 320 and can be at\nmost 20 MB.\n- **ranges** : {_\"display_index\"_: {\"min\": _the minimum expected value_,\n\"max\": _the maximum expected value_} The range within which the display\nreading is expected. The AI could favour likely readings within this.\nEither _min_ or _max_ or both could be provided.\n- **serialNumber** : [_expected serial number_] The expected serial number of\nthe meter. If this serial number is found, no warnings are given. Otherwise we\n notify that we could not verify that the meter has the provided serial number.\n This does not necessarily mean that it is not the correct meter!\n- **referenceId**: A string that will be returned in the result, can be used\n for client-side bookkeeping. The referenceId will also be logged by us, and\n can therefore be used in support requests.\n- **meterCategory** : The expected meter category of the meter. One of:\n [_'electricity'_, _'gas'_, _'water'_]\n- **displayType** : The expected display type of the meter. One of:\n ['analog', 'digital']\n- **language** : The language in which the warnings should be returned.\n- **nDigits** : The number of expected digits per display.\n- **nDisplays** : The number of expected displays.\n\n- **GPSLocation** : The expected GPS location of the image taken.\n- **datetime** : The expected datetime of the image taken.\n\n- **tags** : Comma-separated tags to be added to the request.", "operationId": "Blicker_endpoint_2024_03_01_blicker_2024_03_01_post", "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_Blicker_endpoint_2024_03_01_blicker_2024_03_01_post" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlickerAPIReponseModel_2024_03_01" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/blicker/2024-03-01/feedback": { "put": { "tags": [ "Feedback" ], "summary": "Blicker Feedback Endpoint 2024-03-01", "description": "# Using the blicker feedback API - version: 2024-03-01\n\n\n\nThis endpoint allows you to provide feedback on the result of a Blicker API\ncall. Your request should contain a JSON document with a requestId at the very\nleast.\n\n\n\nFeedback can be provided on the same request multiple times, where the specified\nfields will replace the values provided earlier. For example, if you provide a\nnew list of tags, they will fully replace the existing tags rather than being\nmerged with the previous list.\n\n\n\nThe feedback request must be made with the same subscription as the original\nrequest and the current data region must match the original request, otherwise\na 404 error will be returned.\n\n\n\nThe JSON object supports the following fields:\n\n* ***requestId** : The request to provide feedback on.\n* **tags** : The tags to set for the request.\n* **referenceId** : The reference ID to associate with the request.\n* **objects** : The corrected tree of objects for the image associated with this\n request.", "operationId": "Blicker_feedback_endpoint_2024_03_01_blicker_2024_03_01_feedback_put", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/blicker__api__blicker__api_responders__response_constructor_2024_03_01__BlickerAPIFeedbackResponseConstructor_2024_03_01__RequestParams" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlickerAPIFeedbackResponse_model_2020_10_01" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/blicker/2025-01-01": { "post": { "tags": [ "AI" ], "summary": "Blicker Endpoint 2025-01-01", "description": "# Using the blicker API - version: 2025-01-01\n\nThis takes the image provided as file in multipart formdata and reads the\nmeter in the image. The other parameters below may be included in the form or\nspecified as query parameters.\n\n\n\nAlternatively, you may provide the image directly as body with optional base64\nencoding. In that case, the parameters below can only be specified as query\nparameters.\n\n\n\nThe header should contain your 'subscription-key'.\n\n\n\nThe form body supports the following parameters:\n\n- **image** : The image (as a .jpg, .png, .bmp, .tiff, .webp, .jp2, .heif, or\n.heic) to analyse. The original image must be at least 320 x 320 and can be at\nmost 20 MB.\n- **ranges** : {_\"display_index\"_: {\"min\": _the minimum expected value_,\n\"max\": _the maximum expected value_} The range within which the display\nreading is expected. The AI could favour likely readings within this.\nEither _min_ or _max_ or both could be provided.\n- **serialNumber** : [_expected serial number_] The expected serial number of\nthe meter. If this serial number is found, no warnings are given. Otherwise we\n notify that we could not verify that the meter has the provided serial number.\n This does not necessarily mean that it is not the correct meter!\n- **referenceId**: A string that will be returned in the result, can be used\n for client-side bookkeeping. The referenceId will also be logged by us, and\n can therefore be used in support requests.\n- **meterCategory** : The expected meter category of the meter. One of:\n [_'electricity'_, _'gas'_, _'water'_]\n- **displayType** : The expected display type of the meter. One of:\n ['analog', 'digital']\n- **language** : The language in which the warnings should be returned.\n- **nDigits** : The number of expected digits per display.\n- **nDisplays** : The number of expected displays.\n- **GPSLocation** : The expected GPS location of the image taken.\n- **datetime** : The expected datetime of the image taken.\n- **tags** : Comma-separated tags to be added to the request.", "operationId": "Blicker_endpoint_2025_01_01_blicker_2025_01_01_post", "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_Blicker_endpoint_2025_01_01_blicker_2025_01_01_post" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlickerAPIReponseModel_2025_01_01" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/blicker/2025-01-01/feedback": { "put": { "tags": [ "Feedback" ], "summary": "Blicker Feedback Endpoint 2025-01-01", "description": "# Using the blicker feedback API - version: 2025-01-01\n\n\n\nThis endpoint allows you to provide feedback on the result of a Blicker API\ncall. Your request should contain a JSON document with a requestId at the very\nleast.\n\n\n\nFeedback can be provided on the same request multiple times, where the specified\nfields will replace the values provided earlier. For example, if you provide a\nnew list of tags, they will fully replace the existing tags rather than being\nmerged with the previous list.\n\n\n\nThe feedback request must be made with the same subscription as the original\nrequest and the current data region must match the original request, otherwise\na 404 error will be returned.\n\n\n\nThe JSON object supports the following fields:\n\n* ***requestId** : The request to provide feedback on.\n* **tags** : The tags to set for the request.\n* **referenceId** : The reference ID to associate with the request.\n* **objects** : The corrected tree of objects for the image associated with this\n request.", "operationId": "Blicker_feedback_endpoint_2025_01_01_blicker_2025_01_01_feedback_put", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/blicker__api__blicker__api_responders__response_constructor_2025_01_01__BlickerAPIFeedbackResponseConstructor_2025_01_01__RequestParams" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlickerAPIFeedbackResponse_model_2025_01_01" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/blicker/2026-01-01": { "post": { "tags": [ "AI" ], "summary": "Blicker Endpoint 2026-01-01", "description": "# Using the blicker API - version: 2026-01-01\n\nThis takes the image provided as file in multipart formdata and reads the\nmeter in the image. The other parameters below may be included in the form or\nspecified as query parameters.\n\n\n\nAlternatively, you may provide the image directly as body with optional base64\nencoding. In that case, the parameters below can only be specified as query\nparameters.\n\n\n\nThe header should contain your 'subscription-key'.\n\n\n\nThe form body supports the following parameters:\n\n- **image** : The image (as a .jpg, .png, .bmp, .tiff, .webp, .jp2, .heif, or\n.heic) to analyse. The original image must be at least 320 x 320 and can be at\nmost 20 MB.\n- **ranges** : {_\"display_index\"_: {\"min\": _the minimum expected value_,\n\"max\": _the maximum expected value_} The range within which the display\nreading is expected. The AI could favour likely readings within this.\nEither _min_ or _max_ or both could be provided.\n- **serialNumber** : [_expected serial number_] The expected serial number of\nthe meter. If this serial number is found, no warnings are given. Otherwise we\n notify that we could not verify that the meter has the provided serial number.\n This does not necessarily mean that it is not the correct meter!\n- **referenceId**: A string that will be returned in the result, can be used\n for client-side bookkeeping. The referenceId will also be logged by us, and\n can therefore be used in support requests.\n- **meterCategory** : The expected meter category of the meter. One of:\n [_'electricity'_, _'gas'_, _'water'_, _'heat'_]\n- **displayType** : The expected display type of the meter. One of:\n ['analog', 'digital']\n- **language** : The language in which the warnings should be returned.\n- **nDigits** : The number of expected digits per display.\n- **nDisplays** : The number of expected displays.\n- **GPSLocation** : The expected GPS location of the image taken.\n- **datetime** : The expected datetime of the image taken.\n- **tags** : Comma-separated tags to be added to the request.", "operationId": "Blicker_endpoint_2026_01_01_blicker_2026_01_01_post", "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_Blicker_endpoint_2026_01_01_blicker_2026_01_01_post" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlickerAPIReponseModel_2026_01_01" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/blicker/2026-01-01/feedback": { "put": { "tags": [ "Feedback" ], "summary": "Blicker Feedback Endpoint 2026-01-01", "description": "# Using the blicker feedback API - version: 2026-01-01\n\n\n\nThis endpoint allows you to provide feedback on the result of a Blicker API\ncall. Your request should contain a JSON document with a requestId at the very\nleast.\n\n\n\nFeedback can be provided on the same request multiple times, where the specified\nfields will replace the values provided earlier. For example, if you provide a\nnew list of tags, they will fully replace the existing tags rather than being\nmerged with the previous list.\n\n\n\nThe feedback request must be made with the same subscription as the original\nrequest and the current data region must match the original request, otherwise\na 404 error will be returned.\n\n\n\nThe JSON object supports the following fields:\n\n* ***requestId** : The request to provide feedback on.\n* **tags** : The tags to set for the request.\n* **referenceId** : The reference ID to associate with the request.\n* **objects** : The corrected tree of objects for the image associated with this\n request.", "operationId": "Blicker_feedback_endpoint_2026_01_01_blicker_2026_01_01_feedback_put", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/blicker__api__blicker__api_responders__response_constructor_2026_01_01__BlickerAPIFeedbackResponseConstructor_2026_01_01__RequestParams" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlickerAPIFeedbackResponse_model_2026_01_01" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/requests/{request_ids}": { "get": { "tags": [ "Request management" ], "summary": "Retrieve details of requests and their latest responses", "description": "This endpoint allows you to retrieve details about one or more requests,\nincluding the latest response, by specifying a comma separated list of request\nIDs. The response may be identical to the original response or may have been\nupdated as part of a background operation.\n\nThe images associated with the requests can be retrieved as well by setting the\n*image* query parameter to *true*.\n\n**You can only retrieve requests using the same subscription as they were\noriginally made with. It is possible to retrieve up to 10 requests in a single\ncall.**", "operationId": "global_request_retrieval_endpoint_requests__request_ids__get", "parameters": [ { "name": "request_ids", "in": "path", "required": true, "schema": { "type": "string", "title": "Request Ids" } }, { "name": "image", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Image" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrievalResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } } }, "components": { "schemas": { "BlickerAPIFeedbackResponse_model_2020_10_01": { "properties": { "success": { "type": "boolean", "title": "Success" } }, "additionalProperties": false, "type": "object", "required": [ "success" ], "title": "BlickerAPIFeedbackResponse_model_2020_10_01" }, "BlickerAPIFeedbackResponse_model_2025_01_01": { "properties": { "success": { "type": "boolean", "title": "Success" } }, "additionalProperties": false, "type": "object", "required": [ "success" ], "title": "BlickerAPIFeedbackResponse_model_2025_01_01" }, "BlickerAPIFeedbackResponse_model_2026_01_01": { "properties": { "success": { "type": "boolean", "title": "Success" } }, "additionalProperties": false, "type": "object", "required": [ "success" ], "title": "BlickerAPIFeedbackResponse_model_2026_01_01" }, "BlickerAPIReponseModel_2020_10_01": { "properties": { "requestId": { "type": "string", "format": "uuid4", "title": "Requestid" }, "apiVersion": { "$ref": "#/components/schemas/BlickerApiVersion" }, "language": { "$ref": "#/components/schemas/Language" }, "messages": { "items": { "$ref": "#/components/schemas/BlickerMessage" }, "type": "array", "title": "Messages", "default": [] }, "metaData": { "$ref": "#/components/schemas/MetaData" }, "objects": { "additionalProperties": { "items": { "$ref": "#/components/schemas/BlickerMeter_2020_10_01" }, "type": "array" }, "type": "object", "title": "objects", "description": "List of meter objects detected in the image." }, "referenceId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Referenceid" }, "expectedGPSLocation": { "anyOf": [ { "$ref": "#/components/schemas/ExpectedGPSLocation" }, { "type": "null" } ] }, "expectedDatetime": { "anyOf": [ { "$ref": "#/components/schemas/ExpectedDatetime" }, { "type": "null" } ] }, "tags": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Tags" } }, "additionalProperties": false, "type": "object", "required": [ "requestId", "apiVersion", "language", "metaData", "objects" ], "title": "BlickerAPIReponseModel_2020_10_01", "description": "The general fields of an api response\n\n- **apiVersion** : The received api version.\n- **language** : The received language code as a language tag (BCP 47).\n- **messages** : List of complete message objects relating to either the request as\na whole, or any of the specific objects detected.\n- **metaData** : Metadata retrieved from the EXIF tag of the input image, if\npresent in the image.\n- **objects** : List of meter objects detected in the image.\n- **expectedGPSLocation** : The expected GPS location of the image taken.\n- **expectedDatetime** : The expected datetime of the image taken.\n- **referenceId** : The received referenceId.\n- **requestId** : A generated UUID specific to this API call.\n- **tags** : The received tags." }, "BlickerAPIReponseModel_2024_03_01": { "properties": { "requestId": { "type": "string", "format": "uuid4", "title": "Requestid" }, "apiVersion": { "$ref": "#/components/schemas/BlickerApiVersion" }, "language": { "$ref": "#/components/schemas/Language" }, "messages": { "items": { "$ref": "#/components/schemas/BlickerMessage" }, "type": "array", "title": "Messages", "default": [] }, "metaData": { "$ref": "#/components/schemas/MetaData" }, "objects": { "additionalProperties": { "items": { "$ref": "#/components/schemas/BlickerMeter_2024_03_01" }, "type": "array" }, "type": "object", "title": "objects", "description": "List of meter objects detected in the image." }, "referenceId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Referenceid" }, "expectedGPSLocation": { "anyOf": [ { "$ref": "#/components/schemas/ExpectedGPSLocation" }, { "type": "null" } ] }, "expectedDatetime": { "anyOf": [ { "$ref": "#/components/schemas/ExpectedDatetime" }, { "type": "null" } ] }, "tags": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Tags" } }, "additionalProperties": false, "type": "object", "required": [ "requestId", "apiVersion", "language", "metaData", "objects" ], "title": "BlickerAPIReponseModel_2024_03_01", "description": "The general fields of an api response\n\n- **apiVersion** : The received api version.\n- **language** : The received language code as a language tag (BCP 47).\n- **messages** : List of complete message objects relating to either the request as\na whole, or any of the specific objects detected.\n- **metaData** : Metadata retrieved from the EXIF tag of the input image, if\npresent in the image.\n- **objects** : List of meter objects detected in the image.\n- **expectedGPSLocation** : The expected GPS location of the image taken.\n- **expectedDatetime** : The expected datetime of the image taken.\n- **referenceId** : The received referenceId.\n- **requestId** : A generated UUID specific to this API call.\n- **tags** : The received tags." }, "BlickerAPIReponseModel_2025_01_01": { "properties": { "requestId": { "type": "string", "format": "uuid4", "title": "Requestid" }, "apiVersion": { "$ref": "#/components/schemas/BlickerApiVersion" }, "language": { "$ref": "#/components/schemas/Language" }, "messages": { "items": { "$ref": "#/components/schemas/BlickerMessage" }, "type": "array", "title": "Messages", "default": [] }, "metaData": { "$ref": "#/components/schemas/MetaData" }, "objects": { "additionalProperties": { "items": { "$ref": "#/components/schemas/BlickerMeter_2025_01_01" }, "type": "array" }, "type": "object", "title": "objects", "description": "List of meter objects detected in the image." }, "expectedGPSLocation": { "anyOf": [ { "$ref": "#/components/schemas/ExpectedGPSLocation" }, { "type": "null" } ] }, "expectedDatetime": { "anyOf": [ { "$ref": "#/components/schemas/ExpectedDatetime" }, { "type": "null" } ] }, "referenceId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Referenceid" }, "tags": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Tags" } }, "additionalProperties": false, "type": "object", "required": [ "requestId", "apiVersion", "language", "metaData", "objects" ], "title": "BlickerAPIReponseModel_2025_01_01", "description": "The general fields of an api response\n\n- **apiVersion** : The received api version.\n- **language** : The received language code as a language tag (BCP 47).\n- **messages** : List of complete message objects relating to either the request as\na whole, or any of the specific objects detected.\n- **metaData** : Metadata retrieved from the EXIF tag of the input image, if\npresent in the image.\n- **objects** : List of meter objects detected in the image.\n- **expectedGPSLocation** : The expected GPS location of the image taken.\n- **expectedDatetime** : The expected datetime of the image taken.\n- **referenceId** : The received referenceId.\n- **requestId** : A generated UUID specific to this API call.\n- **tags** : The received tags." }, "BlickerAPIReponseModel_2026_01_01": { "properties": { "requestId": { "type": "string", "format": "uuid4", "title": "Requestid" }, "apiVersion": { "$ref": "#/components/schemas/BlickerApiVersion" }, "language": { "$ref": "#/components/schemas/Language" }, "messages": { "items": { "$ref": "#/components/schemas/BlickerMessage" }, "type": "array", "title": "Messages", "default": [] }, "metaData": { "$ref": "#/components/schemas/MetaData" }, "objects": { "additionalProperties": { "items": { "$ref": "#/components/schemas/BlickerMeter_2026_01_01" }, "type": "array" }, "type": "object", "title": "objects", "description": "List of meter objects detected in the image." }, "expectedGPSLocation": { "anyOf": [ { "$ref": "#/components/schemas/ExpectedGPSLocation" }, { "type": "null" } ] }, "expectedDatetime": { "anyOf": [ { "$ref": "#/components/schemas/ExpectedDatetime" }, { "type": "null" } ] }, "referenceId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Referenceid" }, "tags": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Tags" } }, "additionalProperties": false, "type": "object", "required": [ "requestId", "apiVersion", "language", "metaData", "objects" ], "title": "BlickerAPIReponseModel_2026_01_01", "description": "The general fields of an api response\n\n- **apiVersion** : The received api version.\n- **language** : The received language code as a language tag (BCP 47).\n- **messages** : List of complete message objects relating to either the request as\na whole, or any of the specific objects detected.\n- **metaData** : Metadata retrieved from the EXIF tag of the input image, if\npresent in the image.\n- **objects** : List of meter objects detected in the image.\n- **expectedGPSLocation** : The expected GPS location of the image taken.\n- **expectedDatetime** : The expected datetime of the image taken.\n- **referenceId** : The received referenceId.\n- **requestId** : A generated UUID specific to this API call.\n- **tags** : The received tags." }, "BlickerAPIResponseModel_2020_02_01": { "properties": { "requestId": { "type": "string", "format": "uuid4", "title": "Requestid" }, "apiVersion": { "$ref": "#/components/schemas/BlickerApiVersion" }, "language": { "$ref": "#/components/schemas/Language" }, "messages": { "items": { "$ref": "#/components/schemas/BlickerMessage" }, "type": "array", "title": "Messages", "default": [] }, "metaData": { "$ref": "#/components/schemas/MetaData" }, "objects": { "additionalProperties": { "items": { "$ref": "#/components/schemas/BlickerMeter_2020_02_01" }, "type": "array" }, "type": "object", "title": "Objects" }, "referenceId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Referenceid" } }, "additionalProperties": false, "type": "object", "required": [ "requestId", "apiVersion", "language", "metaData", "objects" ], "title": "BlickerAPIResponseModel_2020_02_01", "description": "The general fields of an api response\n\n- **apiVersion** : The received api version.\n- **language** : The received language code as a language tag (BCP 47).\n- **messages** : List of complete message objects relating to either the request as\na whole, or any of the specific objects detected.\n- **metaData** : Metadata retrieved from the EXIF tag of the input image, if\npresent in the image.\n- **objects** : List of meter objects detected in the image.\n- **referenceId** : The received referenceId.\n- **requestId** : A generated UUID specific to this API call." }, "BlickerAPIResponseModel_2020_05_01": { "properties": { "requestId": { "type": "string", "format": "uuid4", "title": "Requestid" }, "apiVersion": { "$ref": "#/components/schemas/BlickerApiVersion" }, "language": { "$ref": "#/components/schemas/Language" }, "messages": { "items": { "$ref": "#/components/schemas/BlickerMessage" }, "type": "array", "title": "Messages", "default": [] }, "metaData": { "$ref": "#/components/schemas/MetaData" }, "objects": { "additionalProperties": { "items": { "$ref": "#/components/schemas/BlickerMeter_2020_02_01" }, "type": "array" }, "type": "object", "title": "Objects" }, "referenceId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Referenceid" }, "expectedGPSLocation": { "anyOf": [ { "$ref": "#/components/schemas/ExpectedGPSLocation" }, { "type": "null" } ] }, "expectedDatetime": { "anyOf": [ { "$ref": "#/components/schemas/ExpectedDatetime" }, { "type": "null" } ] } }, "additionalProperties": false, "type": "object", "required": [ "requestId", "apiVersion", "language", "metaData", "objects" ], "title": "BlickerAPIResponseModel_2020_05_01", "description": "The general fields of an api response\n\n- **apiVersion** : The received api version.\n- **language** : The received language code as a language tag (BCP 47).\n- **messages** : List of complete message objects relating to either the request as\na whole, or any of the specific objects detected.\n- **metaData** : Metadata retrieved from the EXIF tag of the input image, if\npresent in the image.\n- **objects** : List of meter objects detected in the image.\n- **expectedGPSLocation** : The expected GPS location of the image taken.\n- **expectedDatetime** : The expected datetime of the image taken.\n- **referenceId** : The received referenceId.\n- **requestId** : A generated UUID specific to this API call." }, "BlickerApiVersion": { "type": "string", "enum": [ "2020-02-01", "2020-05-01", "2020-10-01", "2024-03-01", "2025-01-01", "2026-01-01" ], "title": "BlickerApiVersion" }, "BlickerDisplayObject_2025_01_01": { "properties": { "objectId": { "type": "string", "title": "Objectid" }, "index": { "type": "integer", "title": "Index" }, "confidence": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Confidence" }, "numericConfidence": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Numericconfidence" }, "boundingBox": { "anyOf": [ { "items": { "items": { "type": "number" }, "type": "array" }, "type": "array" }, { "type": "null" } ], "title": "Boundingbox" }, "verificationConfidence": { "anyOf": [ { "$ref": "#/components/schemas/ConfidenceLevel" }, { "type": "null" } ] }, "range": { "anyOf": [ { "$ref": "#/components/schemas/BlickerDisplayRange_2025_01_01" }, { "type": "null" } ], "title": "range", "description": "Range a meter reading is expected to be found in as prompted in the request body. Can contain either or both min and max values." }, "expectedSerialNumber": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Expectedserialnumber" }, "expectedNDigits": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Expectedndigits" }, "messages": { "items": { "type": "string" }, "type": "array", "title": "Messages" }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Value" }, "valueBeforeCorrection": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "valueBeforeCorrection", "description": " The read value as determined by Blicker, before possible correction by the provided expectation of the display range or serial number. May be the same as the `value` when no expectation was provided, when `value` already matched the expectation, or when Blicker could not correct `value` to match the expectation." }, "objects": { "additionalProperties": { "items": { "$ref": "#/components/schemas/BlickerMeterObject_2025_01_01" }, "type": "array" }, "propertyNames": { "$ref": "#/components/schemas/BlickerObjectResponseName_2025_01_01" }, "type": "object", "title": "objects", "description": "List of objects such as displays, barcodes, serial numbers, etc. found in this specific meter." } }, "additionalProperties": false, "type": "object", "required": [ "objectId", "index", "confidence", "messages", "objects" ], "title": "BlickerDisplayObject_2025_01_01", "description": "Extends BlickerMeterObject_2025_01_01 to include nested objects." }, "BlickerDisplayObject_2026_01_01": { "properties": { "objectId": { "type": "string", "title": "Objectid" }, "index": { "type": "integer", "title": "Index" }, "confidence": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Confidence" }, "numericConfidence": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Numericconfidence" }, "boundingBox": { "anyOf": [ { "items": { "items": { "type": "number" }, "type": "array" }, "type": "array" }, { "type": "null" } ], "title": "Boundingbox" }, "verificationConfidence": { "anyOf": [ { "$ref": "#/components/schemas/ConfidenceLevel" }, { "type": "null" } ] }, "range": { "anyOf": [ { "$ref": "#/components/schemas/BlickerDisplayRange_2026_01_01" }, { "type": "null" } ], "title": "range", "description": "Range a meter reading is expected to be found in as prompted in the request body. Can contain either or both min and max values." }, "expectedSerialNumber": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Expectedserialnumber" }, "expectedNDigits": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Expectedndigits" }, "messages": { "items": { "type": "string" }, "type": "array", "title": "Messages" }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Value" }, "valueBeforeCorrection": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "valueBeforeCorrection", "description": " The read value as determined by Blicker, before possible correction by the provided expectation of the display range or serial number. May be the same as the `value` when no expectation was provided, when `value` already matched the expectation, or when Blicker could not correct `value` to match the expectation." }, "objects": { "additionalProperties": { "items": { "$ref": "#/components/schemas/BlickerMeterObject_2026_01_01" }, "type": "array" }, "propertyNames": { "$ref": "#/components/schemas/BlickerObjectResponseName_2026_01_01" }, "type": "object", "title": "objects", "description": "List of objects such as displays, barcodes, serial numbers, etc. found in this specific meter." } }, "additionalProperties": false, "type": "object", "required": [ "objectId", "index", "confidence", "messages", "objects" ], "title": "BlickerDisplayObject_2026_01_01", "description": "Extends BlickerMeterObject_2026_01_01 to include nested objects." }, "BlickerDisplayRange_2020_02_01": { "properties": { "min": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Min" }, "max": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Max" } }, "additionalProperties": false, "type": "object", "title": "BlickerDisplayRange_2020_02_01", "description": "Range a meter reading is expected to be found in as prompted in the request body.\nCan contain either one of or both min and max values.\n\n- **min** : Expected minimum meter reading value\n- **max** : Expected maximum meter reading value" }, "BlickerDisplayRange_2020_10_01": { "properties": { "min": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "min", "description": "Expected minimum meter reading value" }, "max": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "max", "description": "Expected maximum meter reading value" } }, "additionalProperties": false, "type": "object", "title": "BlickerDisplayRange_2020_10_01", "description": "Range a meter reading is expected to be found in as prompted in the request body.\nCan contain either one of or both min and max values.\n\n- **min** : Expected minimum meter reading value\n- **max** : Expected maximum meter reading value" }, "BlickerDisplayRange_2024_03_01": { "properties": { "min": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "min", "description": "Expected minimum meter reading value" }, "max": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "max", "description": "Expected maximum meter reading value" } }, "additionalProperties": false, "type": "object", "title": "BlickerDisplayRange_2024_03_01", "description": "Range a meter reading is expected to be found in as prompted in the request body.\nCan contain either one of or both min and max values.\n\n- **min** : Expected minimum meter reading value\n- **max** : Expected maximum meter reading value" }, "BlickerDisplayRange_2025_01_01": { "properties": { "min": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "min", "description": "Expected minimum meter reading value" }, "max": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "max", "description": "Expected maximum meter reading value" } }, "additionalProperties": false, "type": "object", "title": "BlickerDisplayRange_2025_01_01", "description": "Range a meter reading is expected to be found in as prompted in the request body.\nCan contain either one of or both min and max values.\n\n- **min** : Expected minimum meter reading value\n- **max** : Expected maximum meter reading value" }, "BlickerDisplayRange_2026_01_01": { "properties": { "min": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "min", "description": "Expected minimum meter reading value" }, "max": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "max", "description": "Expected maximum meter reading value" } }, "additionalProperties": false, "type": "object", "title": "BlickerDisplayRange_2026_01_01", "description": "Range a meter reading is expected to be found in as prompted in the request body.\nCan contain either one of or both min and max values.\n\n- **min** : Expected minimum meter reading value\n- **max** : Expected maximum meter reading value" }, "BlickerDisplayType": { "type": "string", "enum": [ "digital", "analog" ], "title": "BlickerDisplayType" }, "BlickerFeedbackDisplayObjectObjects_2025_01_01": { "properties": { "obisCode": { "items": { "$ref": "#/components/schemas/BlickerFeedbackMeterObject_2025_01_01" }, "type": "array", "maxItems": 42, "title": "Obiscode" }, "displayUnit": { "items": { "$ref": "#/components/schemas/BlickerFeedbackMeterObject_2025_01_01" }, "type": "array", "maxItems": 42, "title": "Displayunit" } }, "type": "object", "required": [ "obisCode", "displayUnit" ], "title": "BlickerFeedbackDisplayObjectObjects_2025_01_01" }, "BlickerFeedbackDisplayObjectObjects_2026_01_01": { "properties": { "obisCode": { "items": { "$ref": "#/components/schemas/BlickerFeedbackMeterObject_2026_01_01" }, "type": "array", "maxItems": 42, "title": "Obiscode" }, "displayUnit": { "items": { "$ref": "#/components/schemas/BlickerFeedbackMeterObject_2026_01_01" }, "type": "array", "maxItems": 42, "title": "Displayunit" } }, "type": "object", "required": [ "obisCode", "displayUnit" ], "title": "BlickerFeedbackDisplayObjectObjects_2026_01_01" }, "BlickerFeedbackDisplayObject_2025_01_01": { "properties": { "objectId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Objectid" }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Value" }, "objects": { "$ref": "#/components/schemas/BlickerFeedbackDisplayObjectObjects_2025_01_01" } }, "type": "object", "required": [ "objects" ], "title": "BlickerFeedbackDisplayObject_2025_01_01" }, "BlickerFeedbackDisplayObject_2026_01_01": { "properties": { "objectId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Objectid" }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Value" }, "objects": { "$ref": "#/components/schemas/BlickerFeedbackDisplayObjectObjects_2026_01_01" } }, "type": "object", "required": [ "objects" ], "title": "BlickerFeedbackDisplayObject_2026_01_01" }, "BlickerFeedbackMeterObject_2020_10_01": { "properties": { "objectId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Objectid" }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Value" } }, "type": "object", "title": "BlickerFeedbackMeterObject_2020_10_01" }, "BlickerFeedbackMeterObject_2024_03_01": { "properties": { "objectId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Objectid" }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Value" } }, "type": "object", "title": "BlickerFeedbackMeterObject_2024_03_01" }, "BlickerFeedbackMeterObject_2025_01_01": { "properties": { "objectId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Objectid" }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Value" } }, "type": "object", "title": "BlickerFeedbackMeterObject_2025_01_01" }, "BlickerFeedbackMeterObject_2026_01_01": { "properties": { "objectId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Objectid" }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Value" } }, "type": "object", "title": "BlickerFeedbackMeterObject_2026_01_01" }, "BlickerFeedbackMeterObjects_2020_10_01": { "properties": { "serialNumber": { "items": { "$ref": "#/components/schemas/BlickerFeedbackMeterObject_2020_10_01" }, "type": "array", "maxItems": 42, "title": "Serialnumber" }, "display": { "items": { "$ref": "#/components/schemas/BlickerFeedbackMeterObject_2020_10_01" }, "type": "array", "maxItems": 42, "title": "Display" }, "barcode": { "items": { "$ref": "#/components/schemas/BlickerFeedbackMeterObject_2020_10_01" }, "type": "array", "maxItems": 42, "title": "Barcode" } }, "type": "object", "required": [ "serialNumber", "display", "barcode" ], "title": "BlickerFeedbackMeterObjects_2020_10_01" }, "BlickerFeedbackMeterObjects_2024_03_01": { "properties": { "serialNumber": { "items": { "$ref": "#/components/schemas/BlickerFeedbackMeterObject_2024_03_01" }, "type": "array", "maxItems": 42, "title": "Serialnumber" }, "display": { "items": { "$ref": "#/components/schemas/BlickerFeedbackMeterObject_2024_03_01" }, "type": "array", "maxItems": 42, "title": "Display" }, "barcode": { "items": { "$ref": "#/components/schemas/BlickerFeedbackMeterObject_2024_03_01" }, "type": "array", "maxItems": 42, "title": "Barcode" }, "qrCode": { "items": { "$ref": "#/components/schemas/BlickerFeedbackMeterObject_2024_03_01" }, "type": "array", "maxItems": 42, "title": "Qrcode" }, "datamatrix": { "items": { "$ref": "#/components/schemas/BlickerFeedbackMeterObject_2024_03_01" }, "type": "array", "maxItems": 42, "title": "Datamatrix" } }, "type": "object", "required": [ "serialNumber", "display", "barcode", "qrCode", "datamatrix" ], "title": "BlickerFeedbackMeterObjects_2024_03_01" }, "BlickerFeedbackMeterObjects_2025_01_01": { "properties": { "displayReading": { "items": { "$ref": "#/components/schemas/BlickerFeedbackDisplayObject_2025_01_01" }, "type": "array", "maxItems": 42, "title": "Displayreading" }, "serialNumber": { "items": { "$ref": "#/components/schemas/BlickerFeedbackMeterObject_2025_01_01" }, "type": "array", "maxItems": 42, "title": "Serialnumber" }, "barcode": { "items": { "$ref": "#/components/schemas/BlickerFeedbackMeterObject_2025_01_01" }, "type": "array", "maxItems": 42, "title": "Barcode" }, "qrCode": { "items": { "$ref": "#/components/schemas/BlickerFeedbackMeterObject_2025_01_01" }, "type": "array", "maxItems": 42, "title": "Qrcode" }, "datamatrix": { "items": { "$ref": "#/components/schemas/BlickerFeedbackMeterObject_2025_01_01" }, "type": "array", "maxItems": 42, "title": "Datamatrix" } }, "type": "object", "required": [ "displayReading", "serialNumber", "barcode", "qrCode", "datamatrix" ], "title": "BlickerFeedbackMeterObjects_2025_01_01" }, "BlickerFeedbackMeterObjects_2026_01_01": { "properties": { "displayReading": { "items": { "$ref": "#/components/schemas/BlickerFeedbackDisplayObject_2026_01_01" }, "type": "array", "maxItems": 42, "title": "Displayreading" }, "serialNumber": { "items": { "$ref": "#/components/schemas/BlickerFeedbackMeterObject_2026_01_01" }, "type": "array", "maxItems": 42, "title": "Serialnumber" }, "barcode": { "items": { "$ref": "#/components/schemas/BlickerFeedbackMeterObject_2026_01_01" }, "type": "array", "maxItems": 42, "title": "Barcode" }, "qrCode": { "items": { "$ref": "#/components/schemas/BlickerFeedbackMeterObject_2026_01_01" }, "type": "array", "maxItems": 42, "title": "Qrcode" }, "datamatrix": { "items": { "$ref": "#/components/schemas/BlickerFeedbackMeterObject_2026_01_01" }, "type": "array", "maxItems": 42, "title": "Datamatrix" } }, "type": "object", "required": [ "displayReading", "serialNumber", "barcode", "qrCode", "datamatrix" ], "title": "BlickerFeedbackMeterObjects_2026_01_01" }, "BlickerFeedbackMeter_2020_10_01": { "properties": { "meterCategory": { "$ref": "#/components/schemas/BlickerMeterCategory" }, "displayType": { "$ref": "#/components/schemas/BlickerDisplayType" }, "objectId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Objectid" }, "objects": { "anyOf": [ { "$ref": "#/components/schemas/BlickerFeedbackMeterObjects_2020_10_01" }, { "type": "null" } ] } }, "type": "object", "required": [ "meterCategory", "displayType" ], "title": "BlickerFeedbackMeter_2020_10_01" }, "BlickerFeedbackMeter_2024_03_01": { "properties": { "meterCategory": { "$ref": "#/components/schemas/BlickerMeterCategory" }, "displayType": { "$ref": "#/components/schemas/BlickerDisplayType" }, "objectId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Objectid" }, "objects": { "anyOf": [ { "$ref": "#/components/schemas/BlickerFeedbackMeterObjects_2024_03_01" }, { "type": "null" } ] } }, "type": "object", "required": [ "meterCategory", "displayType" ], "title": "BlickerFeedbackMeter_2024_03_01" }, "BlickerFeedbackMeter_2025_01_01": { "properties": { "meterCategory": { "$ref": "#/components/schemas/BlickerMeterCategory" }, "displayType": { "$ref": "#/components/schemas/BlickerDisplayType" }, "objectId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Objectid" }, "objects": { "anyOf": [ { "$ref": "#/components/schemas/BlickerFeedbackMeterObjects_2025_01_01" }, { "type": "null" } ] } }, "type": "object", "required": [ "meterCategory", "displayType" ], "title": "BlickerFeedbackMeter_2025_01_01" }, "BlickerFeedbackMeter_2026_01_01": { "properties": { "meterCategory": { "$ref": "#/components/schemas/BlickerMeterCategory" }, "displayType": { "$ref": "#/components/schemas/BlickerDisplayType" }, "objectId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Objectid" }, "objects": { "anyOf": [ { "$ref": "#/components/schemas/BlickerFeedbackMeterObjects_2026_01_01" }, { "type": "null" } ] } }, "type": "object", "required": [ "meterCategory", "displayType" ], "title": "BlickerFeedbackMeter_2026_01_01" }, "BlickerFeedbackObjectRoot_2020_10_01": { "properties": { "meter": { "items": { "$ref": "#/components/schemas/BlickerFeedbackMeter_2020_10_01" }, "type": "array", "maxItems": 42, "title": "Meter" } }, "type": "object", "required": [ "meter" ], "title": "BlickerFeedbackObjectRoot_2020_10_01" }, "BlickerFeedbackObjectRoot_2024_03_01": { "properties": { "meter": { "items": { "$ref": "#/components/schemas/BlickerFeedbackMeter_2024_03_01" }, "type": "array", "maxItems": 42, "title": "Meter" } }, "type": "object", "required": [ "meter" ], "title": "BlickerFeedbackObjectRoot_2024_03_01" }, "BlickerFeedbackObjectRoot_2025_01_01": { "properties": { "meter": { "items": { "$ref": "#/components/schemas/BlickerFeedbackMeter_2025_01_01" }, "type": "array", "maxItems": 42, "title": "Meter" } }, "type": "object", "required": [ "meter" ], "title": "BlickerFeedbackObjectRoot_2025_01_01" }, "BlickerFeedbackObjectRoot_2026_01_01": { "properties": { "meter": { "items": { "$ref": "#/components/schemas/BlickerFeedbackMeter_2026_01_01" }, "type": "array", "maxItems": 42, "title": "Meter" } }, "type": "object", "required": [ "meter" ], "title": "BlickerFeedbackObjectRoot_2026_01_01" }, "BlickerMessage": { "properties": { "code": { "$ref": "#/components/schemas/BlickerMessageCode" }, "message": { "type": "string", "title": "Message" }, "messageId": { "type": "string", "title": "Messageid" }, "objectId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Objectid" } }, "type": "object", "required": [ "code", "message", "messageId" ], "title": "BlickerMessage" }, "BlickerMessageCode": { "type": "string", "enum": [ "multiple_serial_numbers", "no_meter", "no_display_value", "no_serial_number_value", "missing_display_digits", "missing_serial_number_characters", "display_on_edge", "serial_number_on_edge", "short_display", "short_serial_number", "uneven_displays", "no_match_expected_n_displays", "no_match_expected_n_digits", "no_match_expected_display_range", "no_match_serial_number", "match_serial_number", "no_match_meter_category", "no_match_display_type", "no_match_gps_location", "no_valid_gps_location", "no_valid_datetime", "no_match_minimum_datetime", "no_match_maximum_datetime", "misclassified_d_as_zero" ], "title": "BlickerMessageCode" }, "BlickerMeterCategory": { "type": "string", "enum": [ "electricity", "gas", "water", "heat" ], "title": "BlickerMeterCategory" }, "BlickerMeterCategory_2020_02_01": { "type": "string", "enum": [ "electricity", "gas", "water" ], "title": "BlickerMeterCategory_2020_02_01" }, "BlickerMeterCategory_2025_01_01": { "type": "string", "enum": [ "electricity", "gas", "water" ], "title": "BlickerMeterCategory_2025_01_01" }, "BlickerMeterCategory_2026_01_01": { "type": "string", "enum": [ "electricity", "gas", "water", "heat" ], "title": "BlickerMeterCategory_2026_01_01" }, "BlickerMeterObject_2020_02_01": { "properties": { "objectId": { "type": "string", "title": "Objectid" }, "confidence": { "$ref": "#/components/schemas/ConfidenceLevel" }, "numericConfidence": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Numericconfidence" }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Value" }, "index": { "type": "integer", "title": "Index" }, "messages": { "items": { "type": "string" }, "type": "array", "title": "Messages" }, "boundingBox": { "anyOf": [ { "items": { "items": { "type": "number" }, "type": "array" }, "type": "array" }, { "type": "null" } ], "title": "Boundingbox" }, "verificationConfidence": { "anyOf": [ { "$ref": "#/components/schemas/ConfidenceLevel" }, { "type": "null" } ] }, "range": { "anyOf": [ { "$ref": "#/components/schemas/BlickerDisplayRange_2020_02_01" }, { "type": "null" } ] }, "expected_serial_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Expected Serial Number" }, "expected_n_digits": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Expected N Digits" } }, "additionalProperties": false, "type": "object", "required": [ "objectId", "confidence", "index", "messages" ], "title": "BlickerMeterObject_2020_02_01", "description": "Detected objects found on an individual meter such as; displays, serial numbers,\nbarcodes, etc.\n\n- **confidence** : Confidence level of the specific meter object (high,medium,low).\n- **numericConfidence**: Raw confidence of the specific meter object.\n- **boundingBox**: Rotated bounding box of the specific meter object.\n- **index** : Index of the object on the meter. For displays the index is related to\n the physical position of the displays on the meter. As a rule the lowest index\n display is the topmost or leftmost display, for vertically or horizontally layed\n out meters respectively.\n- **messages** : List of message Id's returned by the API, related specifically to\nthis MeterObject.\n- **objectId** : Unique ID used to identify this specific object in the API\nresponse (o-).\n- **value** : Value of the object (str). meter reading in the case the object is a\ndisplay, serial number or barcode.\n- **verificationConfidence** : Per serial number the verificationConfidence is high\nfor an exact match, medium for an approximate match (message 557), and low when no\nmatch is found (message 556) (all with any of the provided serial numbers).\n- **range** : Range a meter reading is expected to be found in as prompted in the\nrequest body. Can contain either or both min and max values.\n- **expectedSerialNumber** : Expected serial number (str) for this specific object.\nIs returned if it is included in the request.\n- **expectedNDigits** : Expected number of digits (int) for this specific object.\nIs returned if it is included in the request." }, "BlickerMeterObject_2020_10_01": { "properties": { "objectId": { "type": "string", "title": "Objectid" }, "confidence": { "$ref": "#/components/schemas/ConfidenceLevel" }, "numericConfidence": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Numericconfidence" }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Value" }, "index": { "type": "integer", "title": "Index" }, "messages": { "items": { "type": "string" }, "type": "array", "title": "Messages" }, "boundingBox": { "anyOf": [ { "items": { "items": { "type": "number" }, "type": "array" }, "type": "array" }, { "type": "null" } ], "title": "Boundingbox" }, "verificationConfidence": { "anyOf": [ { "$ref": "#/components/schemas/ConfidenceLevel" }, { "type": "null" } ] }, "range": { "anyOf": [ { "$ref": "#/components/schemas/BlickerDisplayRange_2020_10_01" }, { "type": "null" } ], "title": "range", "description": "Range a meter reading is expected to be found in as prompted in the request body. Can contain either or both min and max values." }, "expected_serial_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Expected Serial Number" }, "expected_n_digits": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Expected N Digits" }, "valueBeforeCorrection": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "valueBeforeCorrection", "description": " The read value as determined by Blicker, before possible correction by the provided expectation of the display range or serial number. May be the same as the `value` when no expectation was provided, when `value` already matched the expectation, or when Blicker could not correct `value` to match the expectation." } }, "additionalProperties": false, "type": "object", "required": [ "objectId", "confidence", "index", "messages" ], "title": "BlickerMeterObject_2020_10_01", "description": "Detected objects found on an individual meter, such as displays, serial numbers,\nbarcodes, etc.\n\n- **objectId** : Unique ID used to identify this specific object in the API\nresponse (o-).\n- **index** : Index of the object on the meter. For displays the index is related to\n the physical position of the displays on the meter. As a rule, the lowest index\n display is the topmost or leftmost display, for vertically or horizontally\nlaid out meters respectively.\n- **confidence** : Confidence level of the specific meter object (high,medium,low).\n- **numericConfidence**: Raw confidence of the specific meter object.\n- **boundingBox**: Rotated bounding box of the specific meter object.\n- **verificationConfidence** : Per serial number the verificationConfidence is high\nfor an exact match, medium for an approximate match (message 557), and low when no\nmatch is found (message 556) (all with any of the provided serial numbers).\n- **range** : Range a meter reading is expected to be found in as prompted in the\nrequest body. Can contain either or both min and max values.\n- **expectedSerialNumber** : Expected serial number (str) for this specific object.\nIs returned if it is included in the request.\n- **expectedNDigits** : Expected number of digits (int) for this specific object.\nIs returned if it is included in the request.\n- **messages** : List of message Id's returned by the API, related specifically to\nthis MeterObject.\n- **value** : Value of the object (str). meter reading in the case the object is a\ndisplay, serial number or barcode.\n - **valueBeforeCorrection** : The read value as determined by Blicker, before\n possible correction by the provided expectation of the display range or serial\n number. May be the same as the `value` when no expectation was provided,\n when `value` already matched the expectation, or when Blicker could not correct\n `value` to match the expectation." }, "BlickerMeterObject_2024_03_01": { "properties": { "objectId": { "type": "string", "title": "Objectid" }, "confidence": { "$ref": "#/components/schemas/ConfidenceLevel" }, "numericConfidence": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Numericconfidence" }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Value" }, "index": { "type": "integer", "title": "Index" }, "messages": { "items": { "type": "string" }, "type": "array", "title": "Messages" }, "boundingBox": { "anyOf": [ { "items": { "items": { "type": "number" }, "type": "array" }, "type": "array" }, { "type": "null" } ], "title": "Boundingbox" }, "verificationConfidence": { "anyOf": [ { "$ref": "#/components/schemas/ConfidenceLevel" }, { "type": "null" } ] }, "range": { "anyOf": [ { "$ref": "#/components/schemas/BlickerDisplayRange_2024_03_01" }, { "type": "null" } ], "title": "range", "description": "Range a meter reading is expected to be found in as prompted in the request body. Can contain either or both min and max values." }, "expected_serial_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Expected Serial Number" }, "expected_n_digits": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Expected N Digits" }, "valueBeforeCorrection": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "valueBeforeCorrection", "description": " The read value as determined by Blicker, before possible correction by the provided expectation of the display range or serial number. May be the same as the `value` when no expectation was provided, when `value` already matched the expectation, or when Blicker could not correct `value` to match the expectation." } }, "additionalProperties": false, "type": "object", "required": [ "objectId", "confidence", "index", "messages" ], "title": "BlickerMeterObject_2024_03_01", "description": "Detected objects found on an individual meter, such as displays, serial numbers,\nbarcodes, etc.\n\n- **objectId** : Unique ID used to identify this specific object in the API\nresponse (o-).\n- **index** : Index of the object on the meter. For displays the index is related to\n the physical position of the displays on the meter. As a rule, the lowest index\n display is the topmost or leftmost display, for vertically or horizontally\nlaid out meters respectively.\n- **confidence** : Confidence level of the specific meter object (high,medium,low).\n- **numericConfidence**: Raw confidence of the specific meter object.\n- **boundingBox**: Rotated bounding box of the specific meter object.\n- **verificationConfidence** : Per serial number the verificationConfidence is high\nfor an exact match, medium for an approximate match (message 557), and low when no\nmatch is found (message 556) (all with any of the provided serial numbers).\n- **range** : Range a meter reading is expected to be found in as prompted in the\nrequest body. Can contain either or both min and max values.\n- **expectedSerialNumber** : Expected serial number (str) for this specific object.\nIs returned if it is included in the request.\n- **expectedNDigits** : Expected number of digits (int) for this specific object.\nIs returned if it is included in the request.\n- **messages** : List of message Id's returned by the API, related specifically to\nthis MeterObject.\n- **value** : Value of the object (str). meter reading in the case the object is a\ndisplay, serial number or barcode.\n - **valueBeforeCorrection** : The read value as determined by Blicker, before\n possible correction by the provided expectation of the display range or serial\n number. May be the same as the `value` when no expectation was provided,\n when `value` already matched the expectation, or when Blicker could not correct\n `value` to match the expectation." }, "BlickerMeterObject_2025_01_01": { "properties": { "objectId": { "type": "string", "title": "Objectid" }, "index": { "type": "integer", "title": "Index" }, "confidence": { "$ref": "#/components/schemas/ConfidenceLevel" }, "numericConfidence": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Numericconfidence" }, "boundingBox": { "anyOf": [ { "items": { "items": { "type": "number" }, "type": "array" }, "type": "array" }, { "type": "null" } ], "title": "Boundingbox" }, "verificationConfidence": { "anyOf": [ { "$ref": "#/components/schemas/ConfidenceLevel" }, { "type": "null" } ] }, "range": { "anyOf": [ { "$ref": "#/components/schemas/BlickerDisplayRange_2025_01_01" }, { "type": "null" } ], "title": "range", "description": "Range a meter reading is expected to be found in as prompted in the request body. Can contain either or both min and max values." }, "expectedSerialNumber": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Expectedserialnumber" }, "expectedNDigits": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Expectedndigits" }, "messages": { "items": { "type": "string" }, "type": "array", "title": "Messages" }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Value" }, "valueBeforeCorrection": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "valueBeforeCorrection", "description": " The read value as determined by Blicker, before possible correction by the provided expectation of the display range or serial number. May be the same as the `value` when no expectation was provided, when `value` already matched the expectation, or when Blicker could not correct `value` to match the expectation." } }, "additionalProperties": false, "type": "object", "required": [ "objectId", "index", "confidence", "messages" ], "title": "BlickerMeterObject_2025_01_01", "description": "Detected objects found on an individual meter, such as displays, serial numbers,\nbarcodes, etc.\n\n- **objectId** : Unique ID used to identify this specific object in the API\nresponse (o-).\n- **index** : Index of the object on the meter. For displays the index is related to\nthe physical position of the displays on the meter. As a rule, the lowest index\ndisplay is the topmost or leftmost display, for vertically or horizontally\nlaid out meters respectively.\n- **confidence** : Confidence level of the specific meter object (high,medium,low).\n- **numericConfidence**: Raw confidence of the specific meter object.\n- **boundingBox**: Rotated bounding box of the specific meter object.\n- **verificationConfidence** : Per serial number the verificationConfidence is high\nfor an exact match, medium for an approximate match (message 557), and low when no\nmatch is found (message 556) (all with any of the provided serial numbers).\n- **range** : Range a meter reading is expected to be found in as prompted in the\nrequest body. Can contain either or both min and max values.\n- **expectedSerialNumber** : Expected serial number (str) for this specific object.\nIs returned if it is included in the request.\n- **expectedNDigits** : Expected number of digits (int) for this specific object.\nIs returned if it is included in the request.\n- **messages** : List of message Id's returned by the API, related specifically to\nthis MeterObject.\n- **value** : Value of the object (str). meter reading in the case the object is a\ndisplay, serial number or barcode.\n- **valueBeforeCorrection** : The read value as determined by Blicker, before\npossible correction by the provided expectation of the display range or serial\nnumber. May be the same as the `value` when no expectation was provided,\nwhen `value` already matched the expectation, or when Blicker could not correct\n`value` to match the expectation." }, "BlickerMeterObject_2026_01_01": { "properties": { "objectId": { "type": "string", "title": "Objectid" }, "index": { "type": "integer", "title": "Index" }, "confidence": { "$ref": "#/components/schemas/ConfidenceLevel" }, "numericConfidence": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Numericconfidence" }, "boundingBox": { "anyOf": [ { "items": { "items": { "type": "number" }, "type": "array" }, "type": "array" }, { "type": "null" } ], "title": "Boundingbox" }, "verificationConfidence": { "anyOf": [ { "$ref": "#/components/schemas/ConfidenceLevel" }, { "type": "null" } ] }, "range": { "anyOf": [ { "$ref": "#/components/schemas/BlickerDisplayRange_2026_01_01" }, { "type": "null" } ], "title": "range", "description": "Range a meter reading is expected to be found in as prompted in the request body. Can contain either or both min and max values." }, "expectedSerialNumber": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Expectedserialnumber" }, "expectedNDigits": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Expectedndigits" }, "messages": { "items": { "type": "string" }, "type": "array", "title": "Messages" }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Value" }, "valueBeforeCorrection": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "valueBeforeCorrection", "description": " The read value as determined by Blicker, before possible correction by the provided expectation of the display range or serial number. May be the same as the `value` when no expectation was provided, when `value` already matched the expectation, or when Blicker could not correct `value` to match the expectation." } }, "additionalProperties": false, "type": "object", "required": [ "objectId", "index", "confidence", "messages" ], "title": "BlickerMeterObject_2026_01_01", "description": "Detected objects found on an individual meter, such as displays, serial numbers,\nbarcodes, etc.\n\n- **objectId** : Unique ID used to identify this specific object in the API\nresponse (o-).\n- **index** : Index of the object on the meter. For displays the index is related to\nthe physical position of the displays on the meter. As a rule, the lowest index\ndisplay is the topmost or leftmost display, for vertically or horizontally\nlaid out meters respectively.\n- **confidence** : Confidence level of the specific meter object (high,medium,low).\n- **numericConfidence**: Raw confidence of the specific meter object.\n- **boundingBox**: Rotated bounding box of the specific meter object.\n- **verificationConfidence** : Per serial number the verificationConfidence is high\nfor an exact match, medium for an approximate match (message 557), and low when no\nmatch is found (message 556) (all with any of the provided serial numbers).\n- **range** : Range a meter reading is expected to be found in as prompted in the\nrequest body. Can contain either or both min and max values.\n- **expectedSerialNumber** : Expected serial number (str) for this specific object.\nIs returned if it is included in the request.\n- **expectedNDigits** : Expected number of digits (int) for this specific object.\nIs returned if it is included in the request.\n- **messages** : List of message Id's returned by the API, related specifically to\nthis MeterObject.\n- **value** : Value of the object (str). meter reading in the case the object is a\ndisplay, serial number or barcode.\n- **valueBeforeCorrection** : The read value as determined by Blicker, before\npossible correction by the provided expectation of the display range or serial\nnumber. May be the same as the `value` when no expectation was provided,\nwhen `value` already matched the expectation, or when Blicker could not correct\n`value` to match the expectation." }, "BlickerMeter_2020_02_01": { "properties": { "objectId": { "type": "string", "title": "Objectid" }, "meterCategory": { "$ref": "#/components/schemas/BlickerMeterCategory_2020_02_01" }, "expectedMeterCategory": { "anyOf": [ { "$ref": "#/components/schemas/BlickerMeterCategory_2020_02_01" }, { "type": "null" } ] }, "displayType": { "$ref": "#/components/schemas/BlickerDisplayType" }, "objects": { "additionalProperties": { "items": { "$ref": "#/components/schemas/BlickerMeterObject_2020_02_01" }, "type": "array" }, "propertyNames": { "$ref": "#/components/schemas/BlickerObjectResponseName_2020_02_01" }, "type": "object", "title": "Objects" }, "expectedDisplayType": { "anyOf": [ { "$ref": "#/components/schemas/BlickerDisplayType" }, { "type": "null" } ] }, "expectedNDisplays": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Expectedndisplays" }, "messages": { "items": { "type": "string" }, "type": "array", "title": "Messages", "default": [] } }, "additionalProperties": false, "type": "object", "required": [ "objectId", "meterCategory", "displayType", "objects" ], "title": "BlickerMeter_2020_02_01", "description": "Meter objects found the image.\n\n- **meterCategory** : Category of the meter (electricity,gas,water) as classified\nby Blicker.\n- **expectedMeterCategory** : Expected meter category (electricity/gas/water) is\nreturned if it is included in the request.\n- **displayType** : Display type (digital,analog) as classified by Blicker.\n- **expectedDisplayType** : Expected display type (digital/analog) is returned if\nit is included in the request.\n- **messages** : List of top level messages related to this specific detected meter.\n- **objectId** : Unique ID used to identify this specific object in the API\nresponse (o-).\n- **objects** : List of objects such as displays, barcodes, serial numbers, etc.\nfound in this specific meter.\n- **expectedNDisplays** : Expected number of displays (int) is returned if it is\nincluded in the request." }, "BlickerMeter_2020_10_01": { "properties": { "objectId": { "type": "string", "title": "Objectid" }, "meterCategory": { "$ref": "#/components/schemas/BlickerMeterCategory_2020_02_01" }, "expectedMeterCategory": { "anyOf": [ { "$ref": "#/components/schemas/BlickerMeterCategory_2020_02_01" }, { "type": "null" } ] }, "displayType": { "$ref": "#/components/schemas/BlickerDisplayType" }, "objects": { "additionalProperties": { "items": { "$ref": "#/components/schemas/BlickerMeterObject_2020_10_01" }, "type": "array" }, "propertyNames": { "$ref": "#/components/schemas/BlickerObjectResponseName_2020_02_01" }, "type": "object", "title": "objects", "description": "List of objects such as displays, barcodes, serial numbers, etc. found in this specific meter." }, "expectedDisplayType": { "anyOf": [ { "$ref": "#/components/schemas/BlickerDisplayType" }, { "type": "null" } ] }, "expectedNDisplays": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Expectedndisplays" }, "messages": { "items": { "type": "string" }, "type": "array", "title": "Messages", "default": [] }, "index": { "type": "integer", "title": "index", "description": "The index of the found meter. The ordering is currently arbitrary." } }, "additionalProperties": false, "type": "object", "required": [ "objectId", "meterCategory", "displayType", "objects", "index" ], "title": "BlickerMeter_2020_10_01", "description": "Meter objects found the image.\n\n- **objectId** : Unique ID used to identify this specific object in the API\nresponse (o-).\n- **index** : Index of the meter. The ordering is currently arbitrary.\n- **meterCategory** : Category of the meter (electricity,gas,water) as classified\nby Blicker.\n- **expectedMeterCategory** : Expected meter category (electricity/gas/water) is\nreturned if it is included in the request.\n- **displayType** : Display type (digital,analog) as classified by Blicker.\n- **expectedDisplayType** : Expected display type (digital/analog) is returned if\nit is included in the request.\n- **expectedNDisplays** : Expected number of displays (int) is returned if it is\nincluded in the request.\n- **messages** : List of top level messages related to this specific detected meter.\n- **objects** : List of objects such as displays, barcodes, serial numbers, etc.\nfound in this specific meter." }, "BlickerMeter_2024_03_01": { "properties": { "objectId": { "type": "string", "title": "Objectid" }, "meterCategory": { "$ref": "#/components/schemas/BlickerMeterCategory_2020_02_01" }, "expectedMeterCategory": { "anyOf": [ { "$ref": "#/components/schemas/BlickerMeterCategory_2020_02_01" }, { "type": "null" } ] }, "displayType": { "$ref": "#/components/schemas/BlickerDisplayType" }, "objects": { "additionalProperties": { "items": { "$ref": "#/components/schemas/BlickerMeterObject_2024_03_01" }, "type": "array" }, "propertyNames": { "$ref": "#/components/schemas/BlickerObjectResponseName_2024_03_01" }, "type": "object", "title": "objects", "description": "List of objects such as displays, barcodes, serial numbers, etc. found in this specific meter." }, "expectedDisplayType": { "anyOf": [ { "$ref": "#/components/schemas/BlickerDisplayType" }, { "type": "null" } ] }, "expectedNDisplays": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Expectedndisplays" }, "messages": { "items": { "type": "string" }, "type": "array", "title": "Messages", "default": [] }, "index": { "type": "integer", "title": "index", "description": "The index of the found meter. The ordering is currently arbitrary." } }, "additionalProperties": false, "type": "object", "required": [ "objectId", "meterCategory", "displayType", "objects", "index" ], "title": "BlickerMeter_2024_03_01", "description": "Meter objects found the image.\n\n- **objectId** : Unique ID used to identify this specific object in the API\nresponse (o-).\n- **index** : Index of the meter. The ordering is currently arbitrary.\n- **meterCategory** : Category of the meter (electricity,gas,water) as classified\nby Blicker.\n- **expectedMeterCategory** : Expected meter category (electricity/gas/water) is\nreturned if it is included in the request.\n- **displayType** : Display type (digital,analog) as classified by Blicker.\n- **expectedDisplayType** : Expected display type (digital/analog) is returned if\nit is included in the request.\n- **expectedNDisplays** : Expected number of displays (int) is returned if it is\nincluded in the request.\n- **messages** : List of top level messages related to this specific detected meter.\n- **objects** : List of objects such as displays, barcodes, serial numbers, etc.\nfound in this specific meter." }, "BlickerMeter_2025_01_01": { "properties": { "objectId": { "type": "string", "title": "Objectid" }, "index": { "type": "integer", "title": "index", "description": "The index of the found meter. The ordering is currently arbitrary." }, "meterCategory": { "$ref": "#/components/schemas/BlickerMeterCategory_2025_01_01" }, "expectedMeterCategory": { "anyOf": [ { "$ref": "#/components/schemas/BlickerMeterCategory_2025_01_01" }, { "type": "null" } ] }, "displayType": { "$ref": "#/components/schemas/BlickerDisplayType" }, "expectedDisplayType": { "anyOf": [ { "$ref": "#/components/schemas/BlickerDisplayType" }, { "type": "null" } ] }, "expectedNDisplays": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Expectedndisplays" }, "messages": { "items": { "type": "string" }, "type": "array", "title": "Messages", "default": [] }, "objects": { "additionalProperties": { "items": { "anyOf": [ { "$ref": "#/components/schemas/BlickerMeterObject_2025_01_01" }, { "$ref": "#/components/schemas/BlickerDisplayObject_2025_01_01" } ] }, "type": "array" }, "propertyNames": { "$ref": "#/components/schemas/BlickerObjectResponseName_2025_01_01" }, "type": "object", "title": "objects", "description": "List of objects such as displays, barcodes, serial numbers, etc. found in this specific meter." } }, "additionalProperties": false, "type": "object", "required": [ "objectId", "index", "meterCategory", "displayType", "objects" ], "title": "BlickerMeter_2025_01_01", "description": "Meter objects found the image.\n\n- **objectId** : Unique ID used to identify this specific object in the API\nresponse (o-).\n- **index** : Index of the meter. The ordering is currently arbitrary.\n- **meterCategory** : Category of the meter (electricity,gas,water) as classified\nby Blicker.\n- **expectedMeterCategory** : Expected meter category (electricity/gas/water) is\nreturned if it is included in the request.\n- **displayType** : Display type (digital,analog) as classified by Blicker.\n- **expectedDisplayType** : Expected display type (digital/analog) is returned if\nit is included in the request.\n- **expectedNDisplays** : Expected number of displays (int) is returned if it is\nincluded in the request.\n- **messages** : List of top level messages related to this specific detected meter.\n- **objects** : List of objects such as displays, barcodes, serial numbers, etc.\nfound in this specific meter." }, "BlickerMeter_2026_01_01": { "properties": { "objectId": { "type": "string", "title": "Objectid" }, "index": { "type": "integer", "title": "index", "description": "The index of the found meter. The ordering is currently arbitrary." }, "meterCategory": { "$ref": "#/components/schemas/BlickerMeterCategory_2026_01_01" }, "expectedMeterCategory": { "anyOf": [ { "$ref": "#/components/schemas/BlickerMeterCategory_2026_01_01" }, { "type": "null" } ] }, "displayType": { "$ref": "#/components/schemas/BlickerDisplayType" }, "expectedDisplayType": { "anyOf": [ { "$ref": "#/components/schemas/BlickerDisplayType" }, { "type": "null" } ] }, "expectedNDisplays": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Expectedndisplays" }, "messages": { "items": { "type": "string" }, "type": "array", "title": "Messages", "default": [] }, "objects": { "additionalProperties": { "items": { "anyOf": [ { "$ref": "#/components/schemas/BlickerMeterObject_2026_01_01" }, { "$ref": "#/components/schemas/BlickerDisplayObject_2026_01_01" } ] }, "type": "array" }, "propertyNames": { "$ref": "#/components/schemas/BlickerObjectResponseName_2026_01_01" }, "type": "object", "title": "objects", "description": "List of objects such as displays, barcodes, serial numbers, etc. found in this specific meter." } }, "additionalProperties": false, "type": "object", "required": [ "objectId", "index", "meterCategory", "displayType", "objects" ], "title": "BlickerMeter_2026_01_01", "description": "Meter objects found the image.\n\n- **objectId** : Unique ID used to identify this specific object in the API\nresponse (o-).\n- **index** : Index of the meter. The ordering is currently arbitrary.\n- **meterCategory** : Category of the meter (electricity,gas,water) as classified\nby Blicker.\n- **expectedMeterCategory** : Expected meter category (electricity/gas/water) is\nreturned if it is included in the request.\n- **displayType** : Display type (digital,analog) as classified by Blicker.\n- **expectedDisplayType** : Expected display type (digital/analog) is returned if\nit is included in the request.\n- **expectedNDisplays** : Expected number of displays (int) is returned if it is\nincluded in the request.\n- **messages** : List of top level messages related to this specific detected meter.\n- **objects** : List of objects such as displays, barcodes, serial numbers, etc.\nfound in this specific meter." }, "BlickerObjectResponseName_2020_02_01": { "type": "string", "enum": [ "display", "serialNumber", "barcode" ], "title": "BlickerObjectResponseName_2020_02_01" }, "BlickerObjectResponseName_2024_03_01": { "type": "string", "enum": [ "display", "serialNumber", "barcode", "qrCode", "datamatrix" ], "title": "BlickerObjectResponseName_2024_03_01" }, "BlickerObjectResponseName_2025_01_01": { "type": "string", "enum": [ "displayReading", "serialNumber", "barcode", "qrCode", "datamatrix", "obisCode", "displayUnit" ], "title": "BlickerObjectResponseName_2025_01_01" }, "BlickerObjectResponseName_2026_01_01": { "type": "string", "enum": [ "displayReading", "serialNumber", "barcode", "qrCode", "datamatrix", "obisCode", "displayUnit" ], "title": "BlickerObjectResponseName_2026_01_01" }, "Body_Blicker_endpoint_2020_02_01_blicker_2020_02_01_post": { "properties": { "image": { "type": "string", "contentMediaType": "application/octet-stream", "title": "Image", "description": "Image containing meters to be read by Blicker. Must be at least 320 x 320 and at most 20 MB." }, "ranges": { "anyOf": [ { "type": "string", "maxLength": 256, "minLength": 1 }, { "type": "null" } ], "title": "Ranges", "description": "{''<display index>'': {''min'': <minimum expected value>, ''max'': <maximum expected value>}} The range within which the display reading is expected. The AI could favour likely readings within this. Either ''min'' or ''max'' or both could be provided. If display at idx is not within the provided range, confidence of the display will be low and it will be indicated in a message (555). The matched range will also be returned as a display property.", "examples": [ "" ] }, "serialNumber": { "anyOf": [ { "type": "string", "maxLength": 256, "minLength": 1 }, { "type": "null" } ], "title": "Serialnumber", "description": "A list of serial numbers (formatted: [str(expected_serial_number),...]). If any of the detected serial numbers match any of the provided numbers, no message will be displayed. If no match is found, a message will be added. If this parameter is provided, a verificationConfidence as well as an expectedSerialNumber field is added to all returned serial numbers. Per serial number the verificationConfidence is high for an exact match, medium for an approximate match (message 557), and low when no match is found (message 556) (all with any of the provided serial numbers).", "examples": [ "" ] }, "referenceId": { "anyOf": [ { "type": "string", "maxLength": 256, "minLength": 1 }, { "type": "null" } ], "title": "Referenceid", "description": "This referenceId is returned in the output. Can be used to request calls from our database. And to couple them in your database.", "examples": [ "" ] }, "meterCategory": { "anyOf": [ { "$ref": "#/components/schemas/BlickerMeterCategory_2020_02_01" }, { "type": "null" } ], "title": "Metercategory", "description": "Expected category of the meter in the image (gas/electricity/water). If this parameter is provided, an expectedMeterCategory field is added to each meter object in the response. If the classified meter category does not match the provided category, a message is added (560).", "examples": [ "" ] }, "displayType": { "anyOf": [ { "$ref": "#/components/schemas/BlickerDisplayType" }, { "type": "null" } ], "title": "Displaytype", "description": "Expected type of display of the meter in the image (digital/analog). If this parameter is provided, an expectedDisplayType field is added to each display object in the response. If the classified display type does not match the provided type, a message is added (561).", "examples": [ "" ] }, "language": { "$ref": "#/components/schemas/Language", "description": "Language tag (BCP 47) to select the language in which to return the messages in the API response (default: en)", "default": "en" }, "nDigits": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Ndigits", "description": "The number of digits (of the full display, i.e. also after the comma) the displays are expected to contain. If this parameter is provided, an expectedNDigits field is added to each meter object the response. If this is not the case, the display-confidence is set to low and a message is added (553).", "examples": [ "" ] }, "nDisplays": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Ndisplays", "description": "The number of displays that should be found on the meter (note that a digital meter often has one display, but can have multiple registers, in this case nDisplays should still be 1). If this parameter is provided, an expectedNDisplays field is added to each meter object the response. If a different number of displays are detected, a message is returned (552).", "examples": [ "" ] } }, "type": "object", "required": [ "image" ], "title": "Body_Blicker_endpoint_2020_02_01_blicker_2020_02_01_post" }, "Body_Blicker_endpoint_2020_05_01_blicker_2020_05_01_post": { "properties": { "image": { "type": "string", "contentMediaType": "application/octet-stream", "title": "Image", "description": "Image containing meters to be read by Blicker. Must be at least 320 x 320 and at most 20 MB." }, "ranges": { "anyOf": [ { "type": "string", "maxLength": 256, "minLength": 1 }, { "type": "null" } ], "title": "Ranges", "description": "{''<display index>'': {''min'': <minimum expected value>, ''max'': <maximum expected value>}} The range within which the display reading is expected. The AI could favour likely readings within this. Either ''min'' or ''max'' or both could be provided. If display at idx is not within the provided range, confidence of the display will be low and it will be indicated in a message (555). The matched range will also be returned as a display property.", "examples": [ "" ] }, "serialNumber": { "anyOf": [ { "type": "string", "maxLength": 256, "minLength": 1 }, { "type": "null" } ], "title": "Serialnumber", "description": "A list of serial numbers (formatted: [str(expected_serial_number),...]). If any of the detected serial numbers match any of the provided numbers, no message will be displayed. If no match is found, a message will be added. If this parameter is provided, a verificationConfidence as well as an expectedSerialNumber field is added to all returned serial numbers. Per serial number the verificationConfidence is high for an exact match, medium for an approximate match (message 557), and low when no match is found (message 556) (all with any of the provided serial numbers).", "examples": [ "" ] }, "referenceId": { "anyOf": [ { "type": "string", "maxLength": 256, "minLength": 1 }, { "type": "null" } ], "title": "Referenceid", "description": "This referenceId is returned in the output. Can be used to request calls from our database. And to couple them in your database.", "examples": [ "" ] }, "meterCategory": { "anyOf": [ { "$ref": "#/components/schemas/BlickerMeterCategory_2020_02_01" }, { "type": "null" } ], "title": "Metercategory", "description": "Expected category of the meter in the image (gas/electricity/water). If this parameter is provided, an expectedMeterCategory field is added to each meter object in the response. If the classified meter category does not match the provided category, a message is added (560).", "examples": [ "" ] }, "displayType": { "anyOf": [ { "$ref": "#/components/schemas/BlickerDisplayType" }, { "type": "null" } ], "title": "Displaytype", "description": "Expected type of display of the meter in the image (digital/analog). If this parameter is provided, an expectedDisplayType field is added to each display object in the response. If the classified display type does not match the provided type, a message is added (561)." }, "language": { "$ref": "#/components/schemas/Language", "description": "Language tag (BCP 47) to select the language in which to return the messages in the API response (default: en)", "default": "en" }, "nDigits": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Ndigits", "description": "The number of digits (of the full display, i.e. also after the comma) the displays are expected to contain. If this parameter is provided, an expectedNDigits field is added to each meter object the response. If this is not the case, the display-confidence is set to low and a message is added (553).", "examples": [ "" ] }, "nDisplays": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Ndisplays", "description": "The number of displays that should be found on the meter (note that a digital meter often has one display, but can have multiple registers, in this case nDisplays should still be 1). If this parameter is provided, an expectedNDisplays field is added to each meter object the response. If a different number of displays are detected, a message is returned (552).", "examples": [ "" ] }, "GPSLocation": { "anyOf": [ { "type": "string", "maxLength": 256, "minLength": 1 }, { "type": "null" } ], "title": "Gpslocation", "description": "The GPS location at which the image is expected to be taken. Should be a string formatted as:\n{\"longitude\": <longitude>, \"latitude\": <latitude>, \"distance\": <distance>}. \n`distance` specifies the maximum distance from the expected location in meters and is optional. If not specified, it defaults to 1000.", "examples": [ "" ] }, "datetime": { "anyOf": [ { "type": "string", "maxLength": 256, "minLength": 1 }, { "type": "null" } ], "title": "Datetime", "description": "The datetime at which the image is expected to be taken. Should be a string formatted as:\n{\"min\": <minimum datetime>, \"max\": <maximum datetime>}. \nIt is possible to only specify a `min` or `max`. Datetime should be in ISO 8601 format like '2019-12-31T10:10:10'. Note that any supplied timezone information will be ignored, as EXIF data generally contains no timezone information either.", "examples": [ "" ] } }, "type": "object", "required": [ "image" ], "title": "Body_Blicker_endpoint_2020_05_01_blicker_2020_05_01_post" }, "Body_Blicker_endpoint_2020_10_01_blicker_2020_10_01_post": { "properties": { "image": { "type": "string", "contentMediaType": "application/octet-stream", "title": "Image", "description": "Image containing meters to be read by Blicker. Must be at least 320 x 320 and at most 20 MB." }, "ranges": { "anyOf": [ { "type": "string", "maxLength": 256, "minLength": 1 }, { "type": "null" } ], "title": "Ranges", "description": "{''<display index>'': {''min'': <minimum expected value>, ''max'': <maximum expected value>}} The range within which the display reading is expected. The AI could favour likely readings within this. Either ''min'' or ''max'' or both could be provided. If display at idx is not within the provided range, confidence of the display will be low and it will be indicated in a message (555). The matched range will also be returned as a display property.", "examples": [ "" ] }, "serialNumber": { "anyOf": [ { "type": "string", "maxLength": 256, "minLength": 1 }, { "type": "null" } ], "title": "Serialnumber", "description": "A list of serial numbers (formatted: [str(expected_serial_number),...]). If any of the detected serial numbers match any of the provided numbers, no message will be displayed. If no match is found, a message will be added. If this parameter is provided, a verificationConfidence as well as an expectedSerialNumber field is added to all returned serial numbers. Per serial number the verificationConfidence is high for an exact match, medium for an approximate match (message 557), and low when no match is found (message 556) (all with any of the provided serial numbers).", "examples": [ "" ] }, "referenceId": { "anyOf": [ { "type": "string", "maxLength": 128, "minLength": 1 }, { "type": "null" } ], "title": "Referenceid", "description": "This referenceId is returned in the output. Can be used to request calls from our database. And to couple them in your database.", "examples": [ "" ] }, "meterCategory": { "anyOf": [ { "$ref": "#/components/schemas/BlickerMeterCategory_2020_02_01" }, { "type": "null" } ], "title": "Metercategory", "description": "Expected category of the meter in the image (gas/electricity/water). If this parameter is provided, an expectedMeterCategory field is added to each meter object in the response. If the classified meter category does not match the provided category, a message is added (560).", "examples": [ "" ] }, "displayType": { "anyOf": [ { "$ref": "#/components/schemas/BlickerDisplayType" }, { "type": "null" } ], "title": "Displaytype", "description": "Expected type of display of the meter in the image (digital/analog). If this parameter is provided, an expectedDisplayType field is added to each display object in the response. If the classified display type does not match the provided type, a message is added (561).", "examples": [ "" ] }, "language": { "$ref": "#/components/schemas/Language", "description": "Language tag (BCP 47) to select the language in which to return the messages in the API response (default: en)", "default": "en" }, "nDigits": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Ndigits", "description": "The number of digits (of the full display, i.e. also after the comma) the displays are expected to contain. If this parameter is provided, an expectedNDigits field is added to each meter object the response. If this is not the case, the display-confidence is set to low and a message is added (553).", "examples": [ "" ] }, "nDisplays": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Ndisplays", "description": "The number of displays that should be found on the meter (note that a digital meter often has one display, but can have multiple registers, in this case nDisplays should still be 1). If this parameter is provided, an expectedNDisplays field is added to each meter object the response. If a different number of displays are detected, a message is returned (552).", "examples": [ "" ] }, "GPSLocation": { "anyOf": [ { "type": "string", "maxLength": 256, "minLength": 1 }, { "type": "null" } ], "title": "Gpslocation", "description": "The GPS location at which the image is expected to be taken. Should be a string formatted as:\n{\"longitude\": <longitude>, \"latitude\": <latitude>, \"distance\": <distance>}. \n`distance` specifies the maximum distance from the expected location in meters and is optional. If not specified, it defaults to 1000.", "examples": [ "" ] }, "datetime": { "anyOf": [ { "type": "string", "maxLength": 256, "minLength": 1 }, { "type": "null" } ], "title": "Datetime", "description": "The datetime at which the image is expected to be taken. Should be a string formatted as:\n{\"min\": <minimum datetime>, \"max\": <maximum datetime>}. \nIt is possible to only specify a `min` or `max`. Datetime should be in ISO 8601 format like '2019-12-31T10:10:10'. Note that any supplied timezone information will be ignored, as EXIF data generally contains no timezone information either.", "examples": [ "" ] }, "tags": { "anyOf": [ { "type": "string", "maxLength": 4096, "minLength": 1 }, { "type": "null" } ], "title": "Tags", "description": "These tags are added to the request and can be used in the portal to search. They should be formatted as a JSON array of strings.", "examples": [ "" ] } }, "type": "object", "required": [ "image" ], "title": "Body_Blicker_endpoint_2020_10_01_blicker_2020_10_01_post" }, "Body_Blicker_endpoint_2024_03_01_blicker_2024_03_01_post": { "properties": { "image": { "type": "string", "contentMediaType": "application/octet-stream", "title": "Image", "description": "Image containing meters to be read by Blicker. Must be at least 320 x 320 and at most 20 MB." }, "ranges": { "anyOf": [ { "type": "string", "maxLength": 256, "minLength": 1 }, { "type": "null" } ], "title": "Ranges", "description": "{''<display index>'': {''min'': <minimum expected value>, ''max'': <maximum expected value>}} The range within which the display reading is expected. The AI could favour likely readings within this. Either ''min'' or ''max'' or both could be provided. If display at idx is not within the provided range, confidence of the display will be low and it will be indicated in a message (555). The matched range will also be returned as a display property.", "examples": [ "" ] }, "serialNumber": { "anyOf": [ { "type": "string", "maxLength": 256, "minLength": 1 }, { "type": "null" } ], "title": "Serialnumber", "description": "A list of serial numbers (formatted: [str(expected_serial_number),...]). If any of the detected serial numbers match any of the provided numbers, no message will be displayed. If no match is found, a message will be added. If this parameter is provided, a verificationConfidence as well as an expectedSerialNumber field is added to all returned serial numbers. Per serial number the verificationConfidence is high for an exact match, medium for an approximate match (message 557), and low when no match is found (message 556) (all with any of the provided serial numbers).", "examples": [ "" ] }, "referenceId": { "anyOf": [ { "type": "string", "maxLength": 512, "minLength": 1 }, { "type": "null" } ], "title": "Referenceid", "description": "This referenceId is returned in the output. Can be used to request calls from our database. And to couple them in your database.", "examples": [ "" ] }, "meterCategory": { "anyOf": [ { "$ref": "#/components/schemas/BlickerMeterCategory_2020_02_01" }, { "type": "null" } ], "title": "Metercategory", "description": "Expected category of the meter in the image (gas/electricity/water). If this parameter is provided, an expectedMeterCategory field is added to each meter object in the response. If the classified meter category does not match the provided category, a message is added (560).", "examples": [ "" ] }, "displayType": { "anyOf": [ { "$ref": "#/components/schemas/BlickerDisplayType" }, { "type": "null" } ], "title": "Displaytype", "description": "Expected type of display of the meter in the image (digital/analog). If this parameter is provided, an expectedDisplayType field is added to each display object in the response. If the classified display type does not match the provided type, a message is added (561).", "examples": [ "" ] }, "language": { "$ref": "#/components/schemas/Language", "description": "Language tag (BCP 47) to select the language in which to return the messages in the API response (default: en)", "default": "en" }, "nDigits": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Ndigits", "description": "The number of digits (of the full display, i.e. also after the comma) the displays are expected to contain. If this parameter is provided, an expectedNDigits field is added to each meter object the response. If this is not the case, the display-confidence is set to low and a message is added (553).", "examples": [ "" ] }, "nDisplays": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Ndisplays", "description": "The number of displays that should be found on the meter (note that a digital meter often has one display, but can have multiple registers, in this case nDisplays should still be 1). If this parameter is provided, an expectedNDisplays field is added to each meter object the response. If a different number of displays are detected, a message is returned (552).", "examples": [ "" ] }, "GPSLocation": { "anyOf": [ { "type": "string", "maxLength": 256, "minLength": 1 }, { "type": "null" } ], "title": "Gpslocation", "description": "The GPS location at which the image is expected to be taken. Should be a string formatted as:\n{\"longitude\": <longitude>, \"latitude\": <latitude>, \"distance\": <distance>}. \n`distance` specifies the maximum distance from the expected location in meters and is optional. If not specified, it defaults to 1000.", "examples": [ "" ] }, "datetime": { "anyOf": [ { "type": "string", "maxLength": 256, "minLength": 1 }, { "type": "null" } ], "title": "Datetime", "description": "The datetime at which the image is expected to be taken. Should be a string formatted as:\n{\"min\": <minimum datetime>, \"max\": <maximum datetime>}. \nIt is possible to only specify a `min` or `max`. Datetime should be in ISO 8601 format like '2019-12-31T10:10:10'. Note that any supplied timezone information will be ignored, as EXIF data generally contains no timezone information either.", "examples": [ "" ] }, "tags": { "anyOf": [ { "type": "string", "maxLength": 16384, "minLength": 1 }, { "type": "null" } ], "title": "Tags", "description": "These tags are added to the request and can be used in the portal to search. They should be formatted as a JSON array of strings.", "examples": [ "" ] } }, "type": "object", "required": [ "image" ], "title": "Body_Blicker_endpoint_2024_03_01_blicker_2024_03_01_post" }, "Body_Blicker_endpoint_2025_01_01_blicker_2025_01_01_post": { "properties": { "image": { "type": "string", "contentMediaType": "application/octet-stream", "title": "Image", "description": "Image containing meters to be read by Blicker. Must be at least 320 x 320 and at most 20 MB." }, "ranges": { "anyOf": [ { "type": "string", "maxLength": 256, "minLength": 1 }, { "type": "null" } ], "title": "Ranges", "description": "{''<display index>'': {''min'': <minimum expected value>, ''max'': <maximum expected value>}} The range within which the display reading is expected. The AI could favour likely readings within this. Either ''min'' or ''max'' or both could be provided. If display at idx is not within the provided range, confidence of the display will be low and it will be indicated in a message (555). The matched range will also be returned as a display property.", "examples": [ "" ] }, "serialNumber": { "anyOf": [ { "type": "string", "maxLength": 256, "minLength": 1 }, { "type": "null" } ], "title": "Serialnumber", "description": "A list of serial numbers (formatted: [str(expected_serial_number),...]). If any of the detected serial numbers match any of the provided numbers, no message will be displayed. If no match is found, a message will be added. If this parameter is provided, a verificationConfidence as well as an expectedSerialNumber field is added to all returned serial numbers. Per serial number the verificationConfidence is high for an exact match, medium for an approximate match (message 557), and low when no match is found (message 556) (all with any of the provided serial numbers).", "examples": [ "" ] }, "referenceId": { "anyOf": [ { "type": "string", "maxLength": 512, "minLength": 1 }, { "type": "null" } ], "title": "Referenceid", "description": "This referenceId is returned in the output. Can be used to request calls from our database. And to couple them in your database.", "examples": [ "" ] }, "meterCategory": { "anyOf": [ { "$ref": "#/components/schemas/BlickerMeterCategory_2025_01_01" }, { "type": "null" } ], "title": "Metercategory", "description": "Expected category of the meter in the image (gas/electricity/water). If this parameter is provided, an expectedMeterCategory field is added to each meter object in the response. If the classified meter category does not match the provided category, a message is added (560).", "examples": [ "" ] }, "displayType": { "anyOf": [ { "$ref": "#/components/schemas/BlickerDisplayType" }, { "type": "null" } ], "title": "Displaytype", "description": "Expected type of display of the meter in the image (digital/analog). If this parameter is provided, an expectedDisplayType field is added to each display object in the response. If the classified display type does not match the provided type, a message is added (561).", "examples": [ "" ] }, "language": { "$ref": "#/components/schemas/Language", "description": "Language tag (BCP 47) to select the language in which to return the messages in the API response (default: en)", "default": "en" }, "nDigits": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Ndigits", "description": "The number of digits (of the full display, i.e. also after the comma) the displays are expected to contain. If this parameter is provided, an expectedNDigits field is added to each meter object the response. If this is not the case, the display-confidence is set to low and a message is added (553).", "examples": [ "" ] }, "nDisplays": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Ndisplays", "description": "The number of displays that should be found on the meter (note that a digital meter often has one display, but can have multiple registers, in this case nDisplays should still be 1). If this parameter is provided, an expectedNDisplays field is added to each meter object the response. If a different number of displays are detected, a message is returned (552).", "examples": [ "" ] }, "GPSLocation": { "anyOf": [ { "type": "string", "maxLength": 256, "minLength": 1 }, { "type": "null" } ], "title": "Gpslocation", "description": "The GPS location at which the image is expected to be taken. Should be a string formatted as:\n{\"longitude\": <longitude>, \"latitude\": <latitude>, \"distance\": <distance>}. \n`distance` specifies the maximum distance from the expected location in meters and is optional. If not specified, it defaults to 1000.", "examples": [ "" ] }, "datetime": { "anyOf": [ { "type": "string", "maxLength": 256, "minLength": 1 }, { "type": "null" } ], "title": "Datetime", "description": "The datetime at which the image is expected to be taken. Should be a string formatted as:\n{\"min\": <minimum datetime>, \"max\": <maximum datetime>}. \nIt is possible to only specify a `min` or `max`. Datetime should be in ISO 8601 format like '1996-12-20T13:14:15.16'. Note that any supplied timezone information will be ignored, as EXIF data generally contains no timezone information either.", "examples": [ "" ] }, "tags": { "anyOf": [ { "type": "string", "maxLength": 16384, "minLength": 1 }, { "type": "null" } ], "title": "Tags", "description": "These tags are added to the request and can be used in the portal to search. They should be formatted as a JSON array of strings.", "examples": [ "" ] } }, "type": "object", "required": [ "image" ], "title": "Body_Blicker_endpoint_2025_01_01_blicker_2025_01_01_post" }, "Body_Blicker_endpoint_2026_01_01_blicker_2026_01_01_post": { "properties": { "image": { "type": "string", "contentMediaType": "application/octet-stream", "title": "Image", "description": "Image containing meters to be read by Blicker. Must be at least 320 x 320 and at most 20 MB." }, "ranges": { "anyOf": [ { "type": "string", "maxLength": 256, "minLength": 1 }, { "type": "null" } ], "title": "Ranges", "description": "{''<display index>'': {''min'': <minimum expected value>, ''max'': <maximum expected value>}} The range within which the display reading is expected. The AI could favour likely readings within this. Either ''min'' or ''max'' or both could be provided. If display at idx is not within the provided range, confidence of the display will be low and it will be indicated in a message (555). The matched range will also be returned as a display property.", "examples": [ "" ] }, "serialNumber": { "anyOf": [ { "type": "string", "maxLength": 256, "minLength": 1 }, { "type": "null" } ], "title": "Serialnumber", "description": "A list of serial numbers (formatted: [str(expected_serial_number),...]). If any of the detected serial numbers match any of the provided numbers, no message will be displayed. If no match is found, a message will be added. If this parameter is provided, a verificationConfidence as well as an expectedSerialNumber field is added to all returned serial numbers. Per serial number the verificationConfidence is high for an exact match, medium for an approximate match (message 557), and low when no match is found (message 556) (all with any of the provided serial numbers).", "examples": [ "" ] }, "referenceId": { "anyOf": [ { "type": "string", "maxLength": 512, "minLength": 1 }, { "type": "null" } ], "title": "Referenceid", "description": "This referenceId is returned in the output. Can be used to request calls from our database. And to couple them in your database.", "examples": [ "" ] }, "meterCategory": { "anyOf": [ { "$ref": "#/components/schemas/BlickerMeterCategory_2026_01_01" }, { "type": "null" } ], "title": "Metercategory", "description": "Expected category of the meter in the image (gas/electricity/water/heat). If this parameter is provided, an expectedMeterCategory field is added to each meter object in the response. If the classified meter category does not match the provided category, a message is added (560).", "examples": [ "" ] }, "displayType": { "anyOf": [ { "$ref": "#/components/schemas/BlickerDisplayType" }, { "type": "null" } ], "title": "Displaytype", "description": "Expected type of display of the meter in the image (digital/analog). If this parameter is provided, an expectedDisplayType field is added to each display object in the response. If the classified display type does not match the provided type, a message is added (561).", "examples": [ "" ] }, "language": { "$ref": "#/components/schemas/Language", "description": "Language tag (BCP 47) to select the language in which to return the messages in the API response (default: en)", "default": "en" }, "nDigits": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Ndigits", "description": "The number of digits (of the full display, i.e. also after the comma) the displays are expected to contain. If this parameter is provided, an expectedNDigits field is added to each meter object the response. If this is not the case, the display-confidence is set to low and a message is added (553).", "examples": [ "" ] }, "nDisplays": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Ndisplays", "description": "The number of displays that should be found on the meter (note that a digital meter often has one display, but can have multiple registers, in this case nDisplays should still be 1). If this parameter is provided, an expectedNDisplays field is added to each meter object the response. If a different number of displays are detected, a message is returned (552).", "examples": [ "" ] }, "GPSLocation": { "anyOf": [ { "type": "string", "maxLength": 256, "minLength": 1 }, { "type": "null" } ], "title": "Gpslocation", "description": "The GPS location at which the image is expected to be taken. Should be a string formatted as:\n{\"longitude\": <longitude>, \"latitude\": <latitude>, \"distance\": <distance>}. \n`distance` specifies the maximum distance from the expected location in meters and is optional. If not specified, it defaults to 1000.", "examples": [ "" ] }, "datetime": { "anyOf": [ { "type": "string", "maxLength": 256, "minLength": 1 }, { "type": "null" } ], "title": "Datetime", "description": "The datetime at which the image is expected to be taken. Should be a string formatted as:\n{\"min\": <minimum datetime>, \"max\": <maximum datetime>}. \nIt is possible to only specify a `min` or `max`. Datetime should be in ISO 8601 format like '1996-12-20T13:14:15.16'. Note that any supplied timezone information will be ignored, as EXIF data generally contains no timezone information either.", "examples": [ "" ] }, "tags": { "anyOf": [ { "type": "string", "maxLength": 16384, "minLength": 1 }, { "type": "null" } ], "title": "Tags", "description": "These tags are added to the request and can be used in the portal to search. They should be formatted as a JSON array of strings.", "examples": [ "" ] } }, "type": "object", "required": [ "image" ], "title": "Body_Blicker_endpoint_2026_01_01_blicker_2026_01_01_post" }, "ConfidenceLevel": { "type": "string", "enum": [ "high", "medium", "low" ], "title": "ConfidenceLevel" }, "ExpectedDatetime": { "properties": { "min": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Min" }, "max": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Max" } }, "additionalProperties": false, "type": "object", "title": "ExpectedDatetime", "description": "Represents the expected date of the image taken, that was specified in the request\n\n- **min** : Minimum datetime\n- **max** : Maximum datetime" }, "ExpectedGPSLocation": { "properties": { "longitude": { "type": "number", "title": "Longitude" }, "latitude": { "type": "number", "title": "Latitude" }, "distance": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Distance" } }, "additionalProperties": false, "type": "object", "required": [ "longitude", "latitude" ], "title": "ExpectedGPSLocation", "description": "Represents the expected GPS location that was specified in the request\n\n- **longitude** : expected longitude\n- **latitude** : expected latitude\n- **distance** : maximum distance in meters" }, "GPSInfo": { "properties": { "GPSLatitude": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Gpslatitude" }, "GPSLongitude": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Gpslongitude" }, "GPSAltitude": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Gpsaltitude" } }, "additionalProperties": false, "type": "object", "title": "GPSInfo", "description": "GPS information is returned if this is contained in the EXIF tag of the input image.\n\n- **GPSLatitude** : GPS Latitude in decimal degrees.\n- **GPSLongitude** : GPS longitude in decimal degrees.\n- **GPSAltitude** : GPS altitude in meters above sea level." }, "HTTPValidationError": { "properties": { "detail": { "items": { "$ref": "#/components/schemas/ValidationError" }, "type": "array", "title": "Detail" } }, "type": "object", "title": "HTTPValidationError" }, "Language": { "type": "string", "enum": [ "nl", "en", "tlh" ], "title": "Language" }, "MetaData": { "properties": { "GPSInfo": { "anyOf": [ { "$ref": "#/components/schemas/GPSInfo" }, { "type": "null" } ] }, "datetime": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Datetime" } }, "additionalProperties": false, "type": "object", "title": "MetaData", "description": "Metadata retrieved from the EXIF tag of the input image, if present in the image.\n\n- **GPSInfo** : GPS information is returned if this is contained in the EXIF tag of\nthe input image.\n- **datetime** : Datetime string (if present) contained in the EXIF tag of the\nimage (if present)" }, "RetrievalResponse": { "properties": { "requests": { "additionalProperties": { "anyOf": [ { "$ref": "#/components/schemas/RetrievalResponseInfo" }, { "type": "null" } ] }, "type": "object", "title": "Requests" } }, "additionalProperties": false, "type": "object", "required": [ "requests" ], "title": "RetrievalResponse" }, "RetrievalResponseInfo": { "properties": { "request": { "$ref": "#/components/schemas/RetrievalResponseInfoRequest" }, "response": { "$ref": "#/components/schemas/RetrievalResponseInfoResponse" }, "feedback": { "anyOf": [ { "$ref": "#/components/schemas/RetrievalResponseInfoFeedback" }, { "type": "null" } ] }, "timestamp": { "type": "string", "title": "Timestamp" } }, "additionalProperties": false, "type": "object", "required": [ "request", "response", "feedback", "timestamp" ], "title": "RetrievalResponseInfo" }, "RetrievalResponseInfoFeedback": { "properties": { "body": { "additionalProperties": true, "type": "object", "title": "Body" } }, "additionalProperties": false, "type": "object", "required": [ "body" ], "title": "RetrievalResponseInfoFeedback" }, "RetrievalResponseInfoRequest": { "properties": { "params": { "additionalProperties": true, "type": "object", "title": "Params" }, "method": { "type": "string", "title": "Method" }, "path": { "type": "string", "title": "Path" }, "endpoint": { "type": "string", "title": "Endpoint" }, "version": { "type": "string", "title": "Version" }, "image": { "anyOf": [ { "$ref": "#/components/schemas/RetrievalResponseInfoRequestImage" }, { "type": "null" } ] } }, "additionalProperties": false, "type": "object", "required": [ "params", "method", "path", "endpoint", "version", "image" ], "title": "RetrievalResponseInfoRequest" }, "RetrievalResponseInfoRequestImage": { "properties": { "type": { "type": "string", "title": "Type" }, "data": { "type": "string", "title": "Data" } }, "additionalProperties": false, "type": "object", "required": [ "type", "data" ], "title": "RetrievalResponseInfoRequestImage" }, "RetrievalResponseInfoResponse": { "properties": { "status": { "type": "integer", "title": "Status" }, "body": { "additionalProperties": true, "type": "object", "title": "Body" } }, "additionalProperties": false, "type": "object", "required": [ "status", "body" ], "title": "RetrievalResponseInfoResponse" }, "ValidationError": { "properties": { "loc": { "items": { "anyOf": [ { "type": "string" }, { "type": "integer" } ] }, "type": "array", "title": "Location" }, "msg": { "type": "string", "title": "Message" }, "type": { "type": "string", "title": "Error Type" }, "input": { "title": "Input" }, "ctx": { "type": "object", "title": "Context" } }, "type": "object", "required": [ "loc", "msg", "type" ], "title": "ValidationError" }, "blicker__api__blicker__api_responders__response_constructor_2020_10_01__BlickerAPIFeedbackResponseConstructor_2020_10_01__RequestParams": { "properties": { "requestId": { "type": "string", "title": "Requestid" }, "tags": { "anyOf": [ { "items": { "type": "string", "maxLength": 64 }, "type": "array", "maxItems": 42, "uniqueItems": true }, { "type": "null" } ], "title": "Tags" }, "referenceId": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ], "title": "Referenceid" }, "objects": { "anyOf": [ { "$ref": "#/components/schemas/BlickerFeedbackObjectRoot_2020_10_01" }, { "type": "null" } ] } }, "type": "object", "required": [ "requestId" ], "title": "RequestParams" }, "blicker__api__blicker__api_responders__response_constructor_2024_03_01__BlickerAPIFeedbackResponseConstructor_2024_03_01__RequestParams": { "properties": { "requestId": { "type": "string", "title": "Requestid" }, "tags": { "anyOf": [ { "items": { "type": "string", "maxLength": 256 }, "type": "array", "maxItems": 256, "uniqueItems": true }, { "type": "null" } ], "title": "Tags" }, "referenceId": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ], "title": "Referenceid" }, "objects": { "anyOf": [ { "$ref": "#/components/schemas/BlickerFeedbackObjectRoot_2024_03_01" }, { "type": "null" } ] } }, "type": "object", "required": [ "requestId" ], "title": "RequestParams" }, "blicker__api__blicker__api_responders__response_constructor_2025_01_01__BlickerAPIFeedbackResponseConstructor_2025_01_01__RequestParams": { "properties": { "requestId": { "type": "string", "title": "Requestid" }, "tags": { "anyOf": [ { "items": { "type": "string", "maxLength": 256 }, "type": "array", "maxItems": 256, "uniqueItems": true }, { "type": "null" } ], "title": "Tags" }, "referenceId": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ], "title": "Referenceid" }, "objects": { "anyOf": [ { "$ref": "#/components/schemas/BlickerFeedbackObjectRoot_2025_01_01" }, { "type": "null" } ] } }, "type": "object", "required": [ "requestId" ], "title": "RequestParams" }, "blicker__api__blicker__api_responders__response_constructor_2026_01_01__BlickerAPIFeedbackResponseConstructor_2026_01_01__RequestParams": { "properties": { "requestId": { "type": "string", "title": "Requestid" }, "tags": { "anyOf": [ { "items": { "type": "string", "maxLength": 256 }, "type": "array", "maxItems": 256, "uniqueItems": true }, { "type": "null" } ], "title": "Tags" }, "referenceId": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ], "title": "Referenceid" }, "objects": { "anyOf": [ { "$ref": "#/components/schemas/BlickerFeedbackObjectRoot_2026_01_01" }, { "type": "null" } ] } }, "type": "object", "required": [ "requestId" ], "title": "RequestParams" } }, "securitySchemes": { "apiKeyHeader": { "type": "apiKey", "in": "header", "name": "subscription-key" }, "apiKeyParameter": { "type": "apiKey", "in": "query", "name": "subscription-key" } } }, "security": [ { "apiKeyHeader": [] }, { "apiKeyParameter": [] } ], "servers": [ { "url": "https://api.clockworks.co" } ] }