HitCom
Function to communicate via HIT-Protokoll
| API | Description |
|---|---|
| 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}&Session={Session}&Secret={Secret}&Timeout={Timeout}&Ausgabeform={Ausgabeform}&Context={Context} |
GET - Ausführen des HIT-Protokoll Befehls RS zum Retrieve/Lesen von Daten Getting a Resource (cRud) |
| POST api/HitCom |
POST - IS Insert Inserting a Resource (Crud) |
| PUT api/HitCom |
PUT - XS Excecute 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). |
| GET apis/HitCom |
Prüft Verfügbarkeit des Rest-Services und gibt Version zurück. Aufruf: GET /api/hitcom |
| GET apis/HitCom?Bnr={Bnr}&Mbn={Mbn}&Pin={Pin}&Mandant={Mandant}&Parameter={Parameter}&Subcode={Subcode}&Meldung={Meldung}&Feldliste={Feldliste}&Datenliste={Datenliste}&Session={Session}&Secret={Secret}&Timeout={Timeout}&Ausgabeform={Ausgabeform}&Context={Context} |
GET - Ausführen des HIT-Protokoll Befehls RS zum Retrieve/Lesen von Daten Getting a Resource (cRud) |
| POST apis/HitCom |
POST - IS Insert Inserting a Resource (Crud) |
| PUT apis/HitCom |
PUT - XS Excecute Updating a Resource (crUd) |
| DELETE apis/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). |
Values
Class ValuesController: Beispieltext für Dokumentation CodeWort wieder Text anderes CodeWort wie z.B. Klasse. Das ist schön. codezeile1 codezeile2
| API | Description |
|---|---|
| GET api/Values |
Function ValuesController.Get: GET api/values |
| GET api/Values/{id} |
hzxx-1?? summary - GET api/values/5 |
| POST api/Values |
hzxx-2?? POST api/values |
| PUT api/Values/{id} |
hzxx-3?? PUT api/values/5 |
| DELETE api/Values/{id} |
hzxx-4?? DELETE api/values/5 |
| GET apis/Values |
Function ValuesController.Get: GET api/values |
| GET apis/Values/{id} |
hzxx-1?? summary - GET api/values/5 |
| POST apis/Values |
hzxx-2?? POST api/values |
| PUT apis/Values/{id} |
hzxx-3?? PUT api/values/5 |
| DELETE apis/Values/{id} |
hzxx-4?? DELETE api/values/5 |
HitBatch
Function to translate HitBatch-Interface to HitRaw-Interface
| API | Description |
|---|---|
| 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}&Session={Session}&Secret={Secret}&Timeout={Timeout}&Ausgabeform={Ausgabeform}&Context={Context} |
GET - alle Commnands im Satzmodus |
| POST api/HitBatch |
POST - alle Commands im Satzmodus |
| GET apis/HitBatch |
Prüft Verfügbarkeit des Rest-Services und gibt Version zurück. Aufruf: GET /api/hitcom |
| GET apis/HitBatch?Bnr={Bnr}&Mbn={Mbn}&Pin={Pin}&Mandant={Mandant}&Parameter={Parameter}&Befehl={Befehl}&Meldung={Meldung}&Daten={Daten}&Session={Session}&Secret={Secret}&Timeout={Timeout}&Ausgabeform={Ausgabeform}&Context={Context} |
GET - alle Commnands im Satzmodus |
| POST apis/HitBatch |
POST - alle Commands im Satzmodus |
HitRaw
| API | Description |
|---|---|
| GET api/HitRaw |
Prüft Verfügbarkeit des Rest-Services und gibt Version zurück. Aufruf: GET /api/hitraw |
| GET api/HitRaw?Bnr={Bnr}&Mbn={Mbn}&Pin={Pin}&Mandant={Mandant}&Parameter={Parameter}&Befehlspuffer={Befehlspuffer}&Ausgabeform={Ausgabeform}&Session={Session}&Secret={Secret}&Timeout={Timeout}&Context={Context} |
Führt einzelnen HIT-Protokollbefehl aus und gibt Antwort zurück. Aufruf: GET /api/hitraw/Get?befehl=*1:XS:LOGON/BNR15;PIN;MELD_WG;MAXCERR;TIMEOUT:276090000000001;900001;3;0;1200 400 bad request ... The GetProduct method throws an exception of type HttpResponseException if id is not valid. This exception will be translated by the framework into a 404 (Not Found) error. |
| POST api/HitRaw |
Creating a Resource ... Return unklar ???? sollte 201 sein ? CRUD Pattern: http://www.asp.net/web-api/overview/creating-web-apis/creating-a-web-api-that-supports-crud-operations This implementation will work, but it is not quite complete. Ideally, we would like the HTTP response to include the following: Response code: By default, the Web API framework sets the response status code to 200 (OK). But according to the HTTP/1.1 protocol, when a POST request results in the creation of a resource, the server should reply with status 201 (Created). Location: When the server creates a resource, it should include the URI of the new resource in the Location header of the response. |
| GET apis/HitRaw |
Prüft Verfügbarkeit des Rest-Services und gibt Version zurück. Aufruf: GET /api/hitraw |
| GET apis/HitRaw?Bnr={Bnr}&Mbn={Mbn}&Pin={Pin}&Mandant={Mandant}&Parameter={Parameter}&Befehlspuffer={Befehlspuffer}&Ausgabeform={Ausgabeform}&Session={Session}&Secret={Secret}&Timeout={Timeout}&Context={Context} |
Führt einzelnen HIT-Protokollbefehl aus und gibt Antwort zurück. Aufruf: GET /api/hitraw/Get?befehl=*1:XS:LOGON/BNR15;PIN;MELD_WG;MAXCERR;TIMEOUT:276090000000001;900001;3;0;1200 400 bad request ... The GetProduct method throws an exception of type HttpResponseException if id is not valid. This exception will be translated by the framework into a 404 (Not Found) error. |
| POST apis/HitRaw |
Creating a Resource ... Return unklar ???? sollte 201 sein ? CRUD Pattern: http://www.asp.net/web-api/overview/creating-web-apis/creating-a-web-api-that-supports-crud-operations This implementation will work, but it is not quite complete. Ideally, we would like the HTTP response to include the following: Response code: By default, the Web API framework sets the response status code to 200 (OK). But according to the HTTP/1.1 protocol, when a POST request results in the creation of a resource, the server should reply with status 201 (Created). Location: When the server creates a resource, it should include the URI of the new resource in the Location header of the response. |