Zum Inhalt springen
BatteryPass Docs
Portal
Erste SchritteAnleitungenRezepteIntegrationenAPI-ReferenzÄnderungen
Werte

Registry evaluation of the model-level fields

Scope: readSiehe auch:Authentifizierung ·Fehler ·Paginierung ·Ratenlimits
GET
/model-versions/{versionId}/completeness

Any member. Evaluated against the category, the version's effective date and the organisation's facts.

Autorisierung

apiKey
headerAutorisierungBearer <Token>

Organisation API key sent as Authorization: Bearer bp_live_… (ADR-017). Accepted only by the operations that list this scheme, with the scope in their x-api-key-scope.

Pfad-Parameter

versionId*string
Formatuuid

Antwort-Body

The evaluation.

application/json
  1. response
category*BatteryCategory

Battery category per Regulation (EU) 2023/1542; drives registry requirements.

Wert in"ev""lmt""industrial""stationary""industrial_without_bms"
fields*array<>

Visible fields in registry order (hidden fields are left out).

model_version?
reference_date?string

The placed-on-market date obligations were evaluated for.

Formatdate
registry*
summary*
target*
Beispielanfrage
curl -X GET 'https://example.com/api/v1/model-versions/497f6eca-6276-4993-bfeb-53cbbbba6f08/completeness'
Beispielantwort
{  "category": "ev",  "fields": [    {      "applies_from": "2019-08-24",      "display": "required_missing",      "field_key": "string",      "not_applicable_reason": "string",      "reason": "rule",      "requirement": "required",      "section": "string",      "trigger": {        "de": "string",        "en": "string"      },      "value_status": "missing"    }  ],  "model_version": {    "blocking": 0,    "counts": {      "later_required": 0,      "not_applicable": 0,      "ok": 0,      "optional_missing": 0,      "required_missing": 0,      "required_pending_review": 0    },    "total": 0  },  "reference_date": "2019-08-24",  "registry": {    "hash": "string",    "status": "seed",    "version": "string"  },  "summary": {    "blocking": 0,    "counts": {      "later_required": 0,      "not_applicable": 0,      "ok": 0,      "optional_missing": 0,      "required_missing": 0,      "required_pending_review": 0    },    "total": 0  },  "target": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "type": "model_version"  }}

Registry evaluation of the unit-level fields GET

Any member. Evaluated against the category, the unit's putting-into-service date (else its manufacturing date, else the version's effective date) and the organisation's facts; includes the summary of its model version.

All revisions of one unit-level value, newest first GET

Any member.