Schnittstellen

Hit

HIT-REST Version 2 GET: Abfragen mit RSPUT: Ändern mit XSPOST: Einfügen mit XSDELETE: Stornieren mit SS cacheTimeout als Parameter: Wenn positiv, dann wird neue Sitzung begonnen oder eine existierende wiederverwendet; wenn negativ wird LOGOFF durchgeführt.

APIDescription
GET api/hit

Liefere HitResponse mit Versionsnummer.
GET api/hit/{entity}?columns={columns}&condition={condition}&subcodes={subcodes}&format={format}&bnr={bnr}&mbn={mbn}&pin={pin}&mandant={mandant}&tfaToken={tfaToken}&tfaLight={tfaLight}&act={act}&cid={cid}&cacheTimeout={cacheTimeout}&cacheSecret={cacheSecret}&meldeWeg={meldeWeg}&bhvWrongCol={bhvWrongCol}&bhvFillCol={bhvFillCol}&kompeV2={kompeV2}&deltaSub={deltaSub}

Frage anhand Entität, gewünschter Spalten und einer Bedingung einen HitServer und liefere 1..n komplexe HIT-Anworten.
POST api/hit/{entity}?subcodes={subcodes}&aktion={aktion}&partitionierung={partitionierung}&bnr={bnr}&mbn={mbn}&pin={pin}&mandant={mandant}&tfaToken={tfaToken}&tfaLight={tfaLight}&act={act}&cid={cid}&cacheTimeout={cacheTimeout}&cacheSecret={cacheSecret}&meldeWeg={meldeWeg}&bhvWrongCol={bhvWrongCol}&bhvFillCol={bhvFillCol}&kompeV2={kompeV2}&deltaSub={deltaSub}

Füge ein oder mehreren Meldungen der gegebenen Entität ein. Die Meldungen können entweder ein JsonObject sein, welches Spalte-Wert-Paare enthält (=ein Datensatz wird eingefügt) oder ein JsonArray mit gleichartigen JsonObjects sein (=mehrere Executes). Da das HIT-Protokoll weitere Aktionen wie Update oder Check versteht, kann der POST hier alle Aktionen ausführen, wenn sie explizit angegeben werden.
POST api/hit/mixed?subcodes={subcodes}&aktion={aktion}&partitionierung={partitionierung}&bnr={bnr}&mbn={mbn}&pin={pin}&mandant={mandant}&tfaToken={tfaToken}&tfaLight={tfaLight}&act={act}&cid={cid}&cacheTimeout={cacheTimeout}&cacheSecret={cacheSecret}&meldeWeg={meldeWeg}&bhvWrongCol={bhvWrongCol}&bhvFillCol={bhvFillCol}&kompeV2={kompeV2}&deltaSub={deltaSub}

Verarbeite einen POST (=Einfügen) mit ein oder mehreren Meldungen. Da die Entität hier NICHT Teil der Route ist, können nur JsonObjects mit einer Property "entity" und einer Property "data" gemeldet werden. Die Property "data" wiederum ist entweder ein JsonObject, welches Spalte-Wert-Paare enthält (=ein Execute) oder ein JsonArray mit gleichartigen JsonObjects (=mehrere Executes).
PUT api/hit/{entity}?subcodes={subcodes}&bnr={bnr}&mbn={mbn}&pin={pin}&mandant={mandant}&tfaToken={tfaToken}&tfaLight={tfaLight}&act={act}&cid={cid}&cacheTimeout={cacheTimeout}&cacheSecret={cacheSecret}&meldeWeg={meldeWeg}&bhvWrongCol={bhvWrongCol}&bhvFillCol={bhvFillCol}&kompeV2={kompeV2}&deltaSub={deltaSub}

Verarbeite einen PUT (=Ändern) mit ein oder mehreren Meldungen.
PUT api/hit/mixed?subcodes={subcodes}&bnr={bnr}&mbn={mbn}&pin={pin}&mandant={mandant}&tfaToken={tfaToken}&tfaLight={tfaLight}&act={act}&cid={cid}&cacheTimeout={cacheTimeout}&cacheSecret={cacheSecret}&meldeWeg={meldeWeg}&bhvWrongCol={bhvWrongCol}&bhvFillCol={bhvFillCol}&kompeV2={kompeV2}&deltaSub={deltaSub}

Verarbeite einen PUT (=Ändern) mit ein oder mehreren Meldungen. Da die Entität hier nicht Teil der Route ist, können nur JsonObjects mit einer Property "entity" und einer Property "data" gemeldet werden. Die Property "data" wiederum ist entweder ein JsonObject, welches Spalte-Wert-Paare enthält (=ein Insert) oder ein JsonArray mit gleichartigen JsonObjects (=mehrere Inserts).
DELETE api/hit/{entity}?subcodes={subcodes}&bnr={bnr}&mbn={mbn}&pin={pin}&mandant={mandant}&tfaToken={tfaToken}&tfaLight={tfaLight}&act={act}&cid={cid}&cacheTimeout={cacheTimeout}&cacheSecret={cacheSecret}&meldeWeg={meldeWeg}&bhvWrongCol={bhvWrongCol}&bhvFillCol={bhvFillCol}&kompeV2={kompeV2}&deltaSub={deltaSub}

Verarbeite ein DELETE (=Stornieren) mit ein oder mehreren Meldungen.
DELETE api/hit/session?bnr={bnr}&mbn={mbn}&cacheSecret={cacheSecret}

Beendet die angegebene Session sauber.

 

Spezial

HIT-REST Version 2.x - Spezialisierte REST-API z.B. für Bestandsregister-Abfragen etc. Es gibt hier nur GET-Anfragen.

APIDescription
GET api/spezial/Bestandsregister?typ={typ}&Von={Von}&Bis={Bis}&BetriebSpalte={BetriebSpalte}&Sortierung={Sortierung}&GveModus={GveModus}&GveFaktor={GveFaktor}&LomSelektor={LomSelektor}&GveFehlerModus={GveFehlerModus}&VerbleibModus={VerbleibModus}&Horizont={Horizont}&UnBsModus={UnBsModus}&BeginnDatum={BeginnDatum}&UnBsModusKompakt={UnBsModusKompakt}&ImpfModus={ImpfModus}&Statistik={Statistik}&BasisMeldung={BasisMeldung}&betriebe={betriebe}&condition={condition}&format={format}&ausgabe={ausgabe}&funcfilter={funcfilter}&bnr={bnr}&mbn={mbn}&pin={pin}&mandant={mandant}&tfaToken={tfaToken}&tfaLight={tfaLight}&act={act}&cid={cid}&cacheTimeout={cacheTimeout}&cacheSecret={cacheSecret}&meldeWeg={meldeWeg}&bhvWrongCol={bhvWrongCol}&bhvFillCol={bhvFillCol}&kompeV2={kompeV2}&deltaSub={deltaSub}

Abrufen von Daten eines oder mehrerer Bestandsregister. Aufruf und Parameter orientieren sich an den entspechenden HIT-Funktionen #BESTREG usw. Dokumentation dazu siehe HIT-Entwicklungsbereich unter https://www.hi-tier.de/Entwicklung/Konzept/HITP/feink045.html#BESTREG .

 

PDF

HIT-REST Version 2.x - Spezialisierte REST-API z.B. für Bestandsregister-Abfragen etc. Es gibt hier nur GET-Anfragen.

APIDescription
GET api/pdf/uantrag?betrieb={betrieb}&bnr={bnr}&mbn={mbn}&pin={pin}&mandant={mandant}&act={act}&cid={cid}&cacheTimeout={cacheTimeout}&cacheSecret={cacheSecret}

Test für PDF-Generierung

 

Convert

HIT-REST Version 2.x - Sammlung allgemeiner, einfacher HIT-Funktionen Es gibt hier nur GET-Anfragen.

APIDescription
GET api/convert/ToLom/{lom}

Umwandeln einer beliebig formatierten Ohrmarke in die numerische bzw. alphanumerische normierte Darstellungsform. Liefert immer HTTP Status 200. Die Schwere zeigt an, ob die Ohrmarke korrekt ist oder nicht: ist sie kleiner 2, ist so korrekt, sonst fehlerhaft.
GET api/convert/NumToAlphaLom/{lom}

Umwandlung in Alpha-Darstellung der Rinder-Ohrmarke. Es wird nur die Zeichenkette mit der alphanumerischen Ohrmarke geliefert, kein Json etc! Ist die Ohrmarke falsch oder nicht rein numerisch, wird ein "Bad request" (HTTP 400) mit der Fehlermeldung als "Message" geliefert.
GET api/convert/AlphaToNumLom/{lom}

Umwandlung in numerische Darstellung der Rinder-Ohrmarke. Es wird nur die 15stellige Zahl der Ohrmarke geliefert, kein Json etc! Ist die Ohrmarke falsch, wird ein "Bad request" (HTTP 400) mit der Fehlermeldung als "Message" geliefert.
GET api/convert/ToBnr/{bnr}

Umwandeln einer beliebig formatierten Betriebsnummer in die numerische bzw. alphanumerische normierte Darstellungsform. Liefert immer HTTP Status 200. Die Schwere zeigt an, ob die Betriebsnummer korrekt ist oder nicht: ist sie kleiner 2, ist so korrekt, sonst fehlerhaft.
GET api/convert/NumToAlphaBnr/{bnr}

Umwandlung in Alpha-Darstellung einer Betriebsnummer. Es wird nur die Zeichenkette mit der alphanumerischen Betriebsnummer geliefert, kein Json etc! Ist die Betriebsnummer falsch oder nicht rein numerisch, wird ein "Bad request" (HTTP 400) mit der Fehlermeldung als "Message" geliefert.
GET api/convert/AlphaToNumBnr/{bnr}

Umwandlung in numerische Darstellung der Betriebsnummer. Es wird nur die 15stellige Zahl der Betriebsnummer geliefert, kein Json etc! Ist die Betriebsnummer falsch, wird ein "Bad request" (HTTP 400) mit der Fehlermeldung als "Message" geliefert.

 

DataDict

REST-Controller für DataDictionary-Abfragen Es gibt hier nur GET-Anfragen.

APIDescription
GET api/datadict/Meldungen?mitSYS={mitSYS}&format={format}

Liefere Liste der in der ZD bekannten Meldeentitäten.
GET api/datadict/Meldung/{entity}?mitSYS={mitSYS}&format={format}

Liefere Liste bestimmter Meldeentität oder, wenn nicht gefunden, Meldeentität als Namensbestandteil
GET api/datadict/Meldung/Typ/{typ}?mitSYS={mitSYS}&format={format}

Liefere Liste der Meldeentitäten, die zum bestimmten Melde-Typ gehören.
GET api/datadict/Spalten/{entity}?mitSYS={mitSYS}&format={format}

Liefere Spalten zur gegebenen Meldeentität oder, wenn nicht gefunden, Meldeentität als Namensbestandteil
GET api/datadict/Codes/{codeset}?mitSYS={mitSYS}&format={format}

Liefere Codes zum gegebenen Codeset oder, wenn nicht gefunden, Codeset als Namensbestandteil

 

Download

HIT-REST Version 2.x - Spezialisierte REST-API z.B. für Bestandsregister-Abfragen etc. Es gibt hier nur GET-Anfragen.

APIDescription
GET api/dl/KondiUVO?BNR15={BNR15}&BNR15_UNCC={BNR15_UNCC}&VOK_DAT={VOK_DAT}&RIS_JAHR={RIS_JAHR}&VOK_GEST={VOK_GEST}&format={format}&bnr={bnr}&mbn={mbn}&pin={pin}&mandant={mandant}&act={act}&cid={cid}&tfaToken={tfaToken}&tfaLight={tfaLight}&cacheTimeout={cacheTimeout}&cacheSecret={cacheSecret}&meldeWeg={meldeWeg}&bhvWrongCol={bhvWrongCol}&bhvFillCol={bhvFillCol}&kompeV2={kompeV2}&deltaSub={deltaSub}

 

HitCom

HIT-REST Version 1.x - Higher Level Interface to communicate via HIT-Protokoll, implementing CRUD pattern

APIDescription
GET api/HitCom

Prüft Verfügbarkeit des Rest-Services und gibt Version zurück. Aufruf: GET /api/hitcom
GET api/HitCom?Bnr={Bnr}&Mbn={Mbn}&Pin={Pin}&Mandant={Mandant}&Parameter={Parameter}&Subcode={Subcode}&Meldung={Meldung}&Feldliste={Feldliste}&Datenliste={Datenliste}&TOTP={TOTP}&Light={Light}&Session={Session}&Secret={Secret}&Timeout={Timeout}&Ausgabeform={Ausgabeform}&Context={Context}

Führt 1..n HIT-Abfragen (GET = RS) aus und gibt deren Antworten zurück. Die Anfrage besteht aus den Elementen Subcode für Zusatzparameter beim RS, Meldung (z.B. GEBURT), Feldliste (z.B. BNR15;LOM;GEB_DATR/S) und Datenliste, die in mehreren Zeilen die zur Feldliste passenden Daten enthält.
POST api/HitCom

POST - IS Insert Inserting a Resource (Crud)
PUT api/HitCom

PUT - XS Execute Updating a Resource (crUd)
DELETE api/HitCom

DELETE - SS Storno Deleting a Resource (cruD) If a DELETE request succeeds, it can return status 200 (OK) with an entity-body that describes the status; status 202 (Accepted) if the deletion is still pending; or status 204 (No Content) with no entity body. In this case, the DeleteProduct method has a void return type, so ASP.NET Web API automatically translates this into status code 204 (No Content).

 

HitRaw

HIT-REST Version 1.x - Low Level Interface to communicate via HIT-Protokoll, implementing CRUD pattern

APIDescription
GET api/HitRaw

No documentation available.
GET api/HitRaw?befehle={befehle}&Bnr={Bnr}&Mbn={Mbn}&Pin={Pin}&Mandant={Mandant}&Parameter={Parameter}&TOTP={TOTP}&Light={Light}&Ausgabeform={Ausgabeform}&Session={Session}&Secret={Secret}&Timeout={Timeout}&Context={Context}

Details siehe anderen Aufruf - einziger Unterschied ist der Parameter "befehle", der historisch bedingt dort "Befehlspuffer" heisst.
GET api/HitRaw?Befehlspuffer={Befehlspuffer}&Bnr={Bnr}&Mbn={Mbn}&Pin={Pin}&Mandant={Mandant}&Parameter={Parameter}&TOTP={TOTP}&Light={Light}&Ausgabeform={Ausgabeform}&Session={Session}&Secret={Secret}&Timeout={Timeout}&Context={Context}&ignore_parameter={ignore_parameter}

Führt 1..n HIT-Protokollbefehl(e) aus und gibt deren Antworten zurück. Man kann hiermit jeden HITP-Befehl senden, also sowohl Abfragen als auch Meldungen. Der GET-Request ermöglicht hier lediglich eine einfache Anfrage per URL.
POST api/HitRaw

Führt 1..n HIT-Protokollbefehl(e) aus und gibt deren Antworten zurück. Man kann hiermit jeden HITP-Befehl senden, also sowohl Abfragen als auch Meldungen. Der POST-Request ermöglicht hier lediglich eine Anfrage per JSON- oder HTTP-Formular-Daten.

 

HitBatch

HIT-REST Version 1.x - Special Interface to translate HitBatch-Request to HitRaw-Interface Function

APIDescription
GET api/HitBatch

Prüft Verfügbarkeit des Rest-Services und gibt Version zurück. Aufruf: GET /api/hitcom
GET api/HitBatch?Bnr={Bnr}&Mbn={Mbn}&Pin={Pin}&Mandant={Mandant}&Parameter={Parameter}&Befehl={Befehl}&Meldung={Meldung}&Daten={Daten}&TOTP={TOTP}&Light={Light}&Session={Session}&Secret={Secret}&Timeout={Timeout}&Ausgabeform={Ausgabeform}&Context={Context}

Führt 1..n HIT-Anfragen aus und gibt deren Antworten zurück. Die Anfrage besteht aus drei Elementen: Befehl (z.B. XS/S), Meldung (z.B. GEBURT) und Daten. Die Daten sind wie eine CSV-Datei aufgebaut: die erste Zeile ist die Kopfzeile, alle weiteren Zeilen die dazupassenden Datenzeilen. Man kann hiermit jeden HITP-Befehl senden, also sowohl Abfragen als auch Meldungen. Der GET-Request ermöglicht hier lediglich eine einfache Anfrage per URL.
POST api/HitBatch

Führt 1..n HIT-Anfragen aus und gibt deren Antworten zurück. Die Anfrage besteht aus drei Elementen: Befehl (z.B. XS/S), Meldung (z.B. GEBURT) und Daten. Die Daten sind wie eine CSV-Datei aufgebaut: die erste Zeile ist die Kopfzeile, alle weiteren Zeilen die dazupassenden Datenzeilen. Man kann hiermit jeden HITP-Befehl senden, also sowohl Abfragen als auch Meldungen. Der POST-Request ermöglicht hier lediglich eine Anfrage per JSON- oder HTTP-Formular-Daten.