SystemApi Resource

Systeminformationen abfragen

GET /api/v1/system/costbearingunit

Eine Liste aller im System befindlichen Kostenträger ermitteln

Request Parameters
name type description constraints
limit query int
startIndex query  
userid query  
Response Body
media type data type description
application/json CostBearingUnitEntryList (JSON) eine (leere) Liste der Kostenträger
application/xml;charset=UTF-8 object

Example

Request
GET /api/v1/system/costbearingunit
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "entries" : [ {
    "description" : "...",
    "id" : 12345
  }, {
    "description" : "...",
    "id" : 12345
  } ],
  "rowCount" : 12345
}

GET /api/v1/system/country

Die Liste aller im System bekannten Länder

Request Parameters
name type description constraints
limit query int
startIndex query  
userid query  
Response Body
media type data type description
application/json CountryEntryList (JSON) die (leere) Liste aller im System bekannten Länder
application/xml;charset=UTF-8 object
text/html object

Example

Request
GET /api/v1/system/country
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "entries" : [ {
    "cnr" : "...",
    "name" : "...",
    "currency" : "...",
    "id" : 12345
  }, {
    "cnr" : "...",
    "name" : "...",
    "currency" : "...",
    "id" : 12345
  } ],
  "rowCount" : 12345
}

GET /api/v1/system/itemunit

Eine Liste aller im System befindlichen Einheiten (Artikel)

description wird dabei in der Sprache geliefert, mit der der API-Anwender angemeldet ist. Sollte keine Übersetzung für die Sprache verfügbar sein, ist die Property nicht vorhanden/leer.

Request Parameters
name type description constraints
cnr query die optionale Einheit die ermittelt werden soll  
limit query int
startIndex query  
userid query  
Response Body
media type data type description
application/json ItemUnitEntryList (JSON) eine (leere) Liste aller im System bekannten Einheiten
application/xml;charset=UTF-8 object

Example

Request
GET /api/v1/system/itemunit
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "entries" : [ {
    "description" : "...",
    "dimension" : 12345,
    "cnr" : "..."
  }, {
    "description" : "...",
    "dimension" : 12345,
    "cnr" : "..."
  } ],
  "rowCount" : 12345
}

GET /api/v1/system/localping

Prüft, ob ein Zugriff auf den API-Server möglich ist.

Liefert zusätzlich Informationen über den API Server

Response Body
media type data type description
application/json LocalPingResult (JSON) verschiedene Informationen über das System
application/xml;charset=UTF-8 object
text/html object

Example

Request
GET /api/v1/system/localping
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "apiTime" : 12345,
  "apiBuildNumber" : 12345,
  "apiVersionNumber" : "..."
}

POST /api/v1/system/log

Einen Log-Eintrag erzeugen

Request Body
media type data type description
application/json LogMessageEntry (JSON) enthält die Daten des Logeintrags
application/xml;charset=UTF-8 object

Example

Request
POST /api/v1/system/log
Content-Type: application/json

                
{
  "severity" : "WARN",
  "msg" : "...",
  "time" : 12345
}
Response
HTTP/1.1 201 Created

POST /api/v1/system/logbarcode

Einen "unbekannten" Barcode protokollieren

Request Body
media type data type description
application/json LogBarcodeEntry (JSON) der Inhalt/Zeitstempel des Barcodes
application/xml;charset=UTF-8 object

Example

Request
POST /api/v1/system/logbarcode
Content-Type: application/json

                
{
  "barcode" : "...",
  "time" : 12345
}
Response
HTTP/1.1 201 Created

GET /api/v1/system/ping

Prüft, ob vom API-Server ein Zugriff auf den HELIUM V Server möglich ist.

Liefert zusätzlich Informationen über den verbundenen HELIUM V Server

Response Body
media type data type description
application/json PingResult (JSON) verschiedene Informationen über das System
application/xml;charset=UTF-8 object
text/html object

Example

Request
GET /api/v1/system/ping
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "apiTime" : 12345,
  "serverTime" : 12345,
  "serverBuildNumber" : 12345,
  "serverVersionNumber" : "...",
  "serverDuration" : 12345,
  "serverId" : 12345
}

GET /api/v1/system/taxdescription

Eine Liste aller im System befindlichen Mehrwertsteuersatzbezeichnungen

Request Parameters
name type description constraints
limit query int
startIndex query  
userid query  
Response Body
media type data type description
application/json TaxDescriptionEntryList (JSON)
application/xml;charset=UTF-8 object

Example

Request
GET /api/v1/system/taxdescription
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "entries" : [ {
    "description" : "...",
    "id" : 12345
  }, {
    "description" : "...",
    "id" : 12345
  } ],
  "rowCount" : 12345
}

GET /api/v1/system/textblock

Eine Liste aller im System befindlichen Textbausteine ermitteln

Request Parameters
name type description constraints
addContents query wenn true werden auch die Inhalte der Textbausteine - also die Texte, oder Bildinhalte - übermittelt boolean
filter_withHidden query boolean
limit query int
startIndex query  
userid query  
Response Body
media type data type description
application/json TextblockEntryList (JSON)
application/xml;charset=UTF-8 object

Example

Request
GET /api/v1/system/textblock
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "entries" : [ {
    "description" : "...",
    "hidden" : true,
    "mimeType" : "IMAGEJPEG",
    "localeCnr" : "...",
    "filename" : "...",
    "text" : "...",
    "blob" : "...",
    "id" : 12345
  }, {
    "description" : "...",
    "hidden" : true,
    "mimeType" : "IMAGEPNG",
    "localeCnr" : "...",
    "filename" : "...",
    "text" : "...",
    "blob" : "...",
    "id" : 12345
  } ],
  "rowCount" : 12345
}