API Dokumentation

Der Dienst ermöglicht die Validierung von JSON-Strukturen gegenüber dokumentierten API-ComNorm-Schemas.

Allgemeines

Im Erfolgsfall (Http-Statuscode 200) liefern die Requests die angegebenen JSON-Response-Strukturen zurück.
Ergeben sich Probleme, so kommt ein entsprechender Http-Statuscode mit einer JSON-Problem-Details-Struktur gemäss RFC 7807 zurück.
Die referenzierten Schemas für die Validierung befinden sich unter https://api.comnorm.com/schemas.
Für die Validierung wird vom Dienst die c#-Bibliothek Json.NET Schema verwendet.
Sind mehrerere Validierungsfehler vorhanden, so wird nur der erste gemeldet.

Validate Request
POST	https://api.comnorm.com/validate/api/validate/
Body	{ "schemaName": "...", "jsonObject": {...} }
Response	{ "isValid" : true, "validationMessage": "..." }
Status	200 Ok
Führt eine Validierung des Json-Objektes gegenüber dem angegebenen Schema aus. Statuscode 200 bedeutet, dass die Validierung ausgeführt werden konnte. Ob die übertragene JSON-Objekt-Struktur selbst valid ist, kann über das Antwort-Element 'isValid' ermittelt werden. Das Element 'validationMessage' enthält Details zur Validierung (z.B. Fehlerinformationen). Als 'schemaName' muss beim Aufruf der Dateiname des Schemas (z.B. 'product-info.schema.json') angegeben werden.

Schema Names Request
GET	https://api.comnorm.com/validate/api/schemas
Response	[ "account-info.schema.json", "address-info.schema.json", ... ]
Status	200 Ok
Ermittelt eine Liste mit den Dateinamen der Schemas, die validiert werden können.