WK Daten

MIL Aufgebotstableau API

Einleitung

Dies ist das offizielle REST API der Applikation MIL Aufgebotstableau über die WK Infodaten abgerufen werden können. Die aktuelle Version ist v1.

API Dokumentation

WK Daten

Die Ressource wk_entries gibt die hinterlegten WK-Daten zurück. Die gewünschten WK-Daten können durch Suchparameter eingeschränkt werden. Als Ausgabeformat stehen JSON und CSV zur Verfügung.

v1/wk_entries

Parameter für diese Ressource:

Name Required Beschreibung Example
type optional, default=json Das gewünschte Ausgabeformat "json "oder "csv" type=json
lang optional, default=de Die gewünschte Sprache, welche bei Sprachbezogenene Angaben berücksichtigt werden soll. Mögliche Werte sind "de", "fr" und "it". Ohne Angabe werden die Angaben zu den WK-Daten in "de" deutsch zurückgegeben. lang=fr
unit Pflichtangabe Suchparameter zum Filtern der Einheit. Enthält mind. 3 Zeichen.
Erlaubte Zeichen:
a-z, A-Z, Zahlen, Leerschläge, Umlaute wie ä,ö,ü,è,é,à und die Sonderzeichen / und -
Der Suchparameter unit wird auf alle Sprachvarianten einer Einheit angewendet und ist somit unabhängig des Parameters lang.		 unit=Abw
until Pflichtangabe Suchparameter zum Einschränken des Datumbereiches (bis-Datum). Alle WK-Daten, welche vor und einschliesslich dem angegebenen Datum eine Aktion aufweisen, werden berücksichtigt. Format YYYY-MM-DD until=2015-12-31
from optional Suchparameter zum einschränken des Datumbereiches (von-Datum). Alle WK-Daten, welche nach und einschliesslich dem von-Datum eine Aktion aufweisen, werden berücksichtigt. Format YYYY-MM-DD from=2014-01-01

Beispiel:

v1/wk_entries?from=2019-01-01&until=2019-12-31&unit=adv


JSON Antwort

In der JSON Antwort werden zu Begin allgemeine Informationen zur Anfrage und zum API zurückgegeben. Der "lang" Wert gibt die Sprache der Anfrage zurück. Der Wert von "numberOfUnits gibt die Anzahl der gefundenen Einheiten zurück. Alle gefundenen Einheiten werden unter "units" gelistet. Encoding UTF-8.

JSON Antwort: 
    {
      "statusCode": "200",
      "startTime": "2013-09-16",
      "processTime": "329ms",
      "apiVersion": "1",
      "lang": "de",
      "numberOfUnits": "2",
      "meta" :
      {
        ...
      },
      "units":   [
        ...
      ]
    }

Unter "meta" werden die passenden Beschriftungen zurückgegeben. Die Beschriftungen entsprechen der gewünschten Sprache aus dem Parameter "lang".

Meta: 
    {
      "meta" :
      {
        "labels":
        {
          "unit": "Einheit",
          "from": "von",
          "until": "bis",
          "comment": "Bemerkungen"
       }
    }

Alle gefundenen Einheiten finden sich unter "units". Ein optional hinterlegter Kommentar findet sich unter "comment", wird aber nicht angezeigt. Die Einheiten werden sortiert nach unit, from und until geliefert.

Units: 
      "units":   [
        {
          "unit": "FDK 1 C Flab, 1. Teil",
          "from": "2014-03-18",
          "until": "2014-03-20",
        },
        {
          "unit": "FDK 1 C Flab, 2. Teil",
          "from": "2014-11-18",
          "until": "2014-11-19",
          "comment": ""
        }
      ]
    }

CSV Antwort

Die erste Zeile beinhaltet die Spaltenüberschrift. Die Beschriftungen entsprechen der gewünschten Sprache aus dem Parameter "lang".

CSV Antwort: 
    Einheit;von;bis;Bemerkungen
    "FDK 1 C Flab, 1. Teil";"18.03.2014";"20.03.2014";""
    "FDK 1 C Flab, 2. Teil";"18.11.2014";"19.11.2014";""
    "ABC Abw Bat 10";"18.01.2015";"20.01.2015";""

HTTP Header: 
    Response.CharSet = "UTF-8"
    Response.ContentType = "text/csv"
    Response.AddHeader "Content-Disposition",
    "attachment; filename=aufgebotstableau.csv"

Info WK Daten

Die Ressource wk_infos gibt allgemeine Informationen zu den WK-Daten, wie das Aktualisierungsdatum, zurück.

v1/wk_infos

JSON Antwort

JSON Antwort: 
    {
      "lastUpdate": "2015-02-29"
    }

Kommunikation

Das REST API kommuniziert über das HTTP Protokoll und akzeptiert nur HTTP GET Anfragen.

Beispiel:
v1/wk_infos

HTTP Request: 

    v1/wk_entries?unit=FDK&lang=fr&from=2014-12-31&until=2015-12-31

HTTP Response header Im Normalfall wird die Antwort mit einem HTTP code 200 zurückgegeben.

Response HTTP header: 
    HTTP/1.1 200 OK
    Date: Mon, 16 Sep 2013 13:57:08 GMT
    Content-Type: application/json;charset=UTF-8

Bei einem Parameter-Fehler z.B. ungültiges Datumsformat, wird die Antwort mit einem HTTP code 200 zurückgegeben. 

    HTTP/1.1 200 OK
    Content-Type: application/json;charset=UTF-8
JSON Antwort: 
    {
      "statusCode": "400",
      "statusMessage": "Invalid format for parameter until or from",
      "apiVersion": "1",
    }

Bei einem internen Fehler wird die Antwort mit einem HTTP code 200 zurückgegeben. 

    HTTP/1.1 200 OK
    Content-Type: application/json;charset=UTF-8
JSON Antwort: 
    {
      "statusCode": "500",
      "statusMessage": "Internal Server Error",
      "apiVersion": "1",
    }

Wenn der Parameter until nicht angegeben wird wird ein HTTP code 200 zurückgegeben 

    HTTP/1.1 200 OK
    Content-Type: application/json;charset=UTF-8
JSON Antwort: 
    {
      "statusCode": "400",
      "statusMessage": "Parameter until is not specified",
      "apiVersion": "1",
    }

Wenn der Parameter from grösser ist als until, wird ein HTTP code 200 zurückgegeben 

    HTTP/1.1 200 OK
    Content-Type: application/json;charset=UTF-8
JSON Antwort: 
    {
      "statusCode": "400",
      "statusMessage": "Parameter from is newer than parameter until",
      "apiVersion": "1",
    }

Wenn der Parameter until ein nicht erlaubtes Zeichen enthält, wird ein HTTP code 200 zurückgegeben 

    HTTP/1.1 200 OK
    Content-Type: application/json;charset=UTF-8
JSON Antwort: 
    {
      "statusCode": "400",
      "statusMessage": "The parameter unit contains illegal characters",
      "apiVersion": "1",
    }

Wenn der Parameter unit zu wenige Zeichen enthält, wird ein HTTP code 200 zurückgegeben 

    HTTP/1.1 200 OK
    Content-Type: application/json;charset=UTF-8
JSON Antwort: 
    {
        "statusCode": "500",
        "statusMessage": "Internal Server Error: Bitte geben Sie mind. 3 Zeichen ein.",
        "apiVersion": "1"
    }

Release Notes

Dezember 2017

Februar 2019