Zum Hauptinhalt springen

Licence Connect API (v0)

Download OpenAPI specification:Download

client-licence-holder-filter-controller

getLicenceHolders

Authorizations:
apiKey
path Parameters
clientName
required
string

Responses

updateLicenceHolder

Authorizations:
apiKey
path Parameters
clientName
required
string
Request Body schema: application/json
required
availableLicenceHolders
required
Array of strings
Items Enum: "ARIX" "BILO_V1" "BILO_V2"

Responses

Request samples

Content type
application/json
{
  • "availableLicenceHolders": [
    ]
}

bilo-v-1-controller

request

Authorizations:
apiKey
query Parameters
userId
required
string
clientId
required
string
schulkennung
string
bundesland
required
string
Enum: "MV" "RP" "BW" "BY" "BE" "BB" "HB" "HH" "HE" "NI" "NW" "SL" "SN" "ST" "SH" "TH" "DE_MV" "DE_RP" "DE_BW" "DE_BY" "DE_BE" "DE_BB" "DE_HB" "DE_HH" "DE_HE" "DE_NI" "DE_NW" "DE_SL" "DE_SN" "DE_ST" "DE_SH" "DE_TH" "STK"

Responses

licences-controller

request_1

Authorizations:
apiKey
query Parameters
bundesland
required
string
Enum: "MV" "RP" "BW" "BY" "BE" "BB" "HB" "HH" "HE" "NI" "NW" "SL" "SN" "ST" "SH" "TH" "DE_MV" "DE_RP" "DE_BW" "DE_BY" "DE_BE" "DE_BB" "DE_HB" "DE_HH" "DE_HE" "DE_NI" "DE_NW" "DE_SL" "DE_SN" "DE_ST" "DE_SH" "DE_TH" "STK"
standortnummer
string
schulnummer
string
userId
string
clientName
required
string

Responses

health-check-controller

healthcheck

Authorizations:
apiKey

Responses

bilo-v-2-controller

request_2

Authorizations:
apiKey
path Parameters
userId
required
string
query Parameters
clientName
required
string

Responses