HiOrg-Server Logo
API docs by Redocly

HiOrg-Server API (v1)

Download OpenAPI specification:Download

HiOrg Server GmbH: support@hiorg-server.de URL: https://info.hiorg-server.de/kontakt

Datenaustausch mit HiOrg-Server im Format JSON:API Download Repository für Talend API Tester

Personal

Personal im HiOrg-Server

GET /personal/selbst

Abfrage von eigenen Personaldaten

Authorizations:
OAuth2

Responses

Response samples

Content type
application/vnd.api+json
{
  • "jsonapi": {
    • "version": "1.0"
    },
  • "data": {
    • "type": "user",
    • "id": "9aabc46f91700bf0d97f625b7c5eeacf",
    • "links": {},
    • "attributes": {
      },
    • "relationships": {
      }
    }
}

GET /personal

Abfrage von Personaldaten

Authorizations:
OAuth2
query Parameters
filter[updated_since]
string <date>

Nur Personal, das seit dem angegebenen Zeitpunkt aktualisiert wurde. Datum im Format 'Y-m-dTH:i:sP'. Beispiel: 2022-07-21T17:32:28Z. Standard: nicht gesetzt.

filter[status]
string

Nur Personal, welches dem oder den angegebenen Status entspricht. Kommaseparierte Zeichenkette mit den Status. Beispiel: 'aktiv,eingeschraenkt,gesperrt,extern'

include
string

Verknüpfte Organisation, die mitgeliefert werden soll. Mögliche Werte sind z.B.: 'organisation' oder keine Angabe.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "jsonapi": {
    • "version": "1.0"
    },
  • "data": [
    • {
      }
    ]
}

POST /personal

Pflichtfelder sind "vorname" und "nachname"

Bearbeiten von Qualifikationen:

Die Qualifikation muss über ein eindeutiges Daten-Paar identifiziert werden:

  • position und rang
  • position und name_kurz
  • zentralliste_id und zentralliste_rang
  • zentralliste_id und zentralliste_name_kurz

Zum Löschen wird der zweite Wert auf null gesetzt.

DRAFT: Die API befindet sich derzeit noch in der Entwicklung. Daher kann es sein, dass sich die Spezifikation noch ändert.

Authorizations:
OAuth2
Request Body schema: application/vnd.api+json
required
required
object (user_post)

Beschreibt Personal im HiOrg-Server

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    • "type": "user",
    • "id": "9aabc46f91700bf0d97f625b7c5eeacf",
    • "links": {},
    • "attributes": {
      },
    • "relationships": {
      }
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "jsonapi": {
    • "version": "1.0"
    },
  • "data": {
    • "type": "user",
    • "id": "9aabc46f91700bf0d97f625b7c5eeacf",
    • "links": {},
    • "attributes": {
      },
    • "relationships": {
      }
    }
}

PATCH /personal/{userID}

Bearbeiten von Qualifikationen:

Die Qualifikation muss über ein eindeutiges Daten-Paar identifiziert werden:

  • position und rang
  • position und name_kurz
  • zentralliste_id und zentralliste_rang
  • zentralliste_id und zentralliste_name_kurz

Zum Löschen wird der zweite Wert auf null gesetzt.

DRAFT: Die API befindet sich derzeit noch in der Entwicklung. Daher kann es sein, dass sich die Spezifikation noch ändert.

Authorizations:
OAuth2
path Parameters
userID
required
string

UserID des Personals

Request Body schema: application/vnd.api+json
required
required
object (user_patch)

Beschreibt Personal im HiOrg-Server

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    • "type": "user",
    • "id": "9aabc46f91700bf0d97f625b7c5eeacf",
    • "links": {},
    • "attributes": {
      },
    • "relationships": {
      }
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "jsonapi": {
    • "version": "1.0"
    },
  • "data": {
    • "type": "user",
    • "id": "9aabc46f91700bf0d97f625b7c5eeacf",
    • "links": {},
    • "attributes": {
      },
    • "relationships": {
      }
    }
}

PUT /personal/{identifier_name}/{identifier_value}

Pflichtfelder bei Neuanlage sind "vorname" und "nachname"

Bearbeiten von Qualifikationen:

Die Qualifikation muss über ein eindeutiges Daten-Paar identifiziert werden:

  • position und rang
  • position und name_kurz
  • zentralliste_id und zentralliste_rang
  • zentralliste_id und zentralliste_name_kurz

Zum Löschen wird der zweite Wert auf null gesetzt.

DRAFT: Die API befindet sich derzeit noch in der Entwicklung. Daher kann es sein, dass sich die Spezifikation noch ändert.

Authorizations:
OAuth2
path Parameters
identifier_name
required
string
Examples:
  • user_id oder mitgliednr -

Name des Identifizierers des Personals

identifier_value
required
string
Examples:
  • Beispiel user_id: 'b77087a71bd0eaca744af39e65029ce3', Beispiel mitgliednr: 12345 -

Wert des Identifizierers des Personals

Request Body schema: application/vnd.api+json
required
required
object (user_put)

Beschreibt Personal im HiOrg-Server

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    • "type": "user",
    • "id": "9aabc46f91700bf0d97f625b7c5eeacf",
    • "links": {},
    • "attributes": {
      },
    • "relationships": {
      }
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "jsonapi": {
    • "version": "1.0"
    },
  • "data": {
    • "type": "user",
    • "id": "9aabc46f91700bf0d97f625b7c5eeacf",
    • "links": {},
    • "attributes": {
      },
    • "relationships": {
      }
    }
}

GET /personal/{userid}/ausbildungen

Abfrage von Personaldaten

Authorizations:
OAuth2
path Parameters
userId
required
integer

UserID des Personals

query Parameters
filter[updated_since]
string <date>

Nur Mitglieder/Mitarbeiter, die seit dem angegebenen Zeitpunkt aktualisiert wurden. Datum im Format 'Y-m-dTH:i:sP'. Beispiel: 2022-07-21T17:32:28Z. Standard: nicht gesetzt.

include
string

Verknüpfter User, der mitgeliefert werden soll. Mögliche Werte sind z.B.: 'user' oder keine Angabe.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "jsonapi": {
    • "version": "1.0"
    },
  • "data": [
    • {
      }
    ]
}

DELETE /personal/{userid}/ausbildungen/{id}

Löscht die AusbildungUser mit der ID {id}

DRAFT: Die API befindet sich derzeit noch in der Entwicklung. Daher kann es sein, dass sich die Spezifikation noch ändert.

Authorizations:
OAuth2
path Parameters
userId
required
integer

UserID des Personals

id
required
integer

ID der Ausbildung User

Responses

Response samples

Content type
application/vnd.api+json
Example
{
  • "errors": [
    • {
      }
    ]
}

GET /personal/{user_id}/ueberpruefungen

Abfrage von Regelmäßigen Überprüfungen

Hinweis: Das Attribut 'letze_pruefung' wird durch 'letzte_pruefung' ersetzt und zur Abwärtskompatibilität bis zum 31.01.25 weiterhin zusätzlich ausgegeben und danach entfernt.

Authorizations:
OAuth2
query Parameters
filter[updated_since]
string <date>

Nur Überprüfungen, die seit dem angegebenen Zeitpunkt geändert wurden. Datum im Format 'Y-m-dTH:i:sP'. Beispiel: 2022-07-21T17:32:28+02:00. Standard: nicht gesetzt.

include
string

Verknüpfter User, der mitgeliefert werden soll. Mögliche Werte sind z.B.: 'user' oder keine Angabe.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "jsonapi": {
    • "version": "1.0"
    },
  • "data": [
    • {
      }
    ]
}

GET /personal/{userid}/ehrungen

Abfrage von Ehrungen zu einem Personal

Authorizations:
OAuth2

Responses

Response samples

Content type
application/vnd.api+json
{
  • "jsonapi": {
    • "version": "1.0"
    },
  • "data": [
    • {
      }
    ]
}

Organisation

Organisation im HiOrg-Server, bspw. Ortsgliederung einer Hilfsorganisation

GET /organisation/selbst/stammdaten

Abfrage der Stammdaten der eigenen Organisation

Authorizations:
OAuth2

Responses

Response samples

Content type
application/vnd.api+json
{
  • "jsonapi": {
    • "version": "1.0"
    },
  • "data": {
    • "type": "orga",
    • "id": "14119",
    • "attributes": {
      }
    }
}

Benutzer

Angemeldeter Benutzer, entspricht meistens auch einem Mitglied (siehe Personal)

GET /oauth/v1/userinfo

OAuth: Infos zum eigenen Benutzer abfragen

Dieser Endpunkt wird in der OAuth2-Spezifikation beschrieben.

Authorizations:
OAuth2

Responses

Response samples

Content type
application/json
{
  • "sub": "9aabc46f91700bf0d97f625b7c5eeacf",
  • "name": "Max Muster",
  • "given_name": "Max",
  • "family_name": "Muster",
  • "preferred_username": "admin",
  • "email": "admin@example.com",
  • "email_verified": false,
  • "gender": "male",
  • "birthdate": "1985-08-12T00:00:00.000Z",
  • "phone_number": "0171-12345679",
  • "phone_number_verified": false,
  • "address": {
    • "formatted": "Max Muster\nEnsheimerstr. 12\n66386 St. Ingbert\nDeutschland",
    • "street_address": "Ensheimerstr. 12",
    • "locality": "St. Ingbert",
    • "postal_code": "66386",
    • "country": "Deutschland"
    },
  • "updated_at": 1572214287
}

Kalender

Liste mit Veranstaltungen

GET /ical/v1/veranstaltungen/private-{hash}/hiorg.ics

Ruft einen iCal-Feed eines privaten Kalenders ab

path Parameters
hash
required
string
Examples:
  • 1pq5f894012e49df5f894012e49e3 -

Hash des privaten Kalender-Feeds

Responses

Response samples

Content type
text/calendar; charset=utf-8
BEGIN:VCALENDAR
VERSION:2.0
CALSCALE:GREGORIAN
PRODID:-//HiOrg-Server.de//NONSGML HiOrg-Server//EN
X-LOTUS-CHARSET:UTF-8
X-WR-TIMEZONE:Europe/Berlin
X-WR-CALNAME:HiOrg-Server XXX
X-WR-CALDESC:HiOrg-Server XXX
BEGIN:VEVENT
UID:9719886-8955843@xxx.hiorg-server.de
CATEGORIES:HiOrg-Server
TRANSP:OPAQUE
CLASS:PUBLIC
SEQUENCE:0
DTSTAMP:20201015T124946Z
DTSTART:20201218T170000Z
DTEND:20201218T190000Z
SUMMARY:Dienstabend
LOCATION:
ORGANIZER:mailto:papierkorb@hiorg-server.de
DESCRIPTION:Treffpunkt: Vereinsheim
END:VEVENT
BEGIN:VEVENT
UID:9704352-8938947@xxx.hiorg-server.de
CATEGORIES:HiOrg-Server
TRANSP:OPAQUE
CLASS:PUBLIC
SEQUENCE:0
DTSTAMP:20201015T124946Z
DTSTART:20201222T140000Z
DTEND:20201222T180000Z
SUMMARY:Sanitätsdienst: Jahresendveranstaltung
LOCATION:Stadthalle Musterhausen
ORGANIZER:mailto:papierkorb@hiorg-server.de
END:VEVENT
END:VCALENDAR

GET /kalender

Gibt alle Kalender des Nutzers zurück

Authorizations:
OAuth2

Responses

Response samples

Content type
application/vnd.api+json
{
  • "jsonapi": {
    • "version": "1.0"
    },
  • "data": [
    • {
      }
    ]
}

POST /kalender

Erstellt einen neuen Kalender

DRAFT: Die API befindet sich derzeit noch in der Entwicklung. Daher kann es sein, dass sich die Spezifikation noch ändert.

Authorizations:
OAuth2
Request Body schema: application/vnd.api+json
required
required
object (kalender_post)

JSON API Kalender-Resource

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    • "type": "kalender",
    • "id": "1234",
    • "attributes": {
      }
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "jsonapi": {
    • "version": "1.0"
    },
  • "data": {
    • "type": "kalender",
    • "id": "1234",
    • "attributes": {
      },
    • "relationships": {
      }
    }
}

GET /kalender/{id}

Ruft Informationen zum Kalender mit der ID {id} ab

Authorizations:
OAuth2
path Parameters
id
required
integer
Examples:
  • 3 -

ID des Kalenders

Responses

Response samples

Content type
application/vnd.api+json
{
  • "jsonapi": {
    • "version": "1.0"
    },
  • "data": {
    • "type": "kalender",
    • "id": "1234",
    • "attributes": {
      },
    • "relationships": {
      }
    }
}

DELETE /kalender/{id}

EntferntKalender mit der ID {id}

Authorizations:
OAuth2
path Parameters
id
required
integer
Examples:
  • 3 -

ID des Kalenders

Responses

Response samples

Content type
application/vnd.api+json
Example
{
  • "errors": [
    • {
      }
    ]
}

Helferstunden

Helferstunden und Helferstunden-Anlässe

GET /helferstunden

Authorizations:
OAuth2
query Parameters
filter[eigene]
boolean

Nur die eigenen Helferstunden ausgeben. Standard: true

filter[von]
string <date>

Nur Helferstunden, deren Anfang oder Ende nach dem angegebenen Datum liegen. Datum im Format 'Y-m-d'. Standard: vor 6 Monaten

filter[bis]
string <date>

Nur Helferstunden, deren Anfang oder Ende vor dem angegebenen Datum liegen. Datum im Format 'Y-m-d'. Standard: leer

filter[changed_since]
string <date>

Nur Helferstunden, die seit dem angegebenen Zeitpunkt aktualisiert wurden. Datum im Format 'Y-m-dTH:i:sP'. Beispiel: 2022-07-21T17:32:28Z. Standard: nicht gesetzt.

include
string

Verknüpfte Objekte, die mitgeliefert werden sollen(als Kommaseparierte Liste). Mögliche Werte sind z.B.: 'anlass', 'typ', 'user' oder 'anlass.referenz'. 'anlass.referenz' referenziert hier die Veranstaltung bzw. Aufgabe mit der der Anlass verknüpft ist.

Hinweis: Referenzen werden derzeit nur für Helferstunden zu einem Dienst oder Termin ausgeben, welche dann den Ort der Veranstaltung enthalten.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "jsonapi": {
    • "version": "1.0"
    },
  • "data": [
    • {
      }
    ]
}

POST /helferstunden

Legt neuen Helferstunden-Eintrag an

DRAFT: Die API befindet sich derzeit noch in der Entwicklung. Daher kann es sein, dass sich die Spezifikation noch ändert.

Authorizations:
OAuth2
Request Body schema: application/vnd.api+json
required
required
object (helferstunden_post)

Helferstunden-Eintrag eines Nutzers zu einem Anlass

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    • "type": "helferstunden",
    • "id": "1234",
    • "attributes": {
      },
    • "relationships": {
      }
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "jsonapi": {
    • "version": "1.0"
    },
  • "data": {
    • "type": "helferstunden",
    • "id": "1234",
    • "attributes": {
      },
    • "relationships": {
      }
    }
}

GET /helferstunden/{id}

Ruft Informationen zum Helferstunden-Eintrag mit der ID {id} ab

DRAFT: Die API befindet sich derzeit noch in der Entwicklung. Daher kann es sein, dass sich die Spezifikation noch ändert.

Authorizations:
OAuth2
path Parameters
id
required
integer

ID des Helferstunden-Eintrags

Responses

Response samples

Content type
application/vnd.api+json
{
  • "jsonapi": {
    • "version": "1.0"
    },
  • "data": {
    • "type": "helferstunden",
    • "id": "1234",
    • "attributes": {
      },
    • "relationships": {
      }
    }
}

DELETE /helferstunden/{id}

Löscht den Helferstunden-Eintrag mit der ID {id}

DRAFT: Die API befindet sich derzeit noch in der Entwicklung. Daher kann es sein, dass sich die Spezifikation noch ändert.

Authorizations:
OAuth2
path Parameters
id
required
integer

ID des Helferstunden-Eintrags

Responses

Response samples

Content type
application/vnd.api+json
{
  • "errors": [
    • {
      }
    ]
}

PATCH /helferstunden/{id}

ändert einen Helferstunden-Eintrag

Authorizations:
OAuth2
path Parameters
id
required
integer

ID des Helferstunden-Eintrags

Request Body schema: application/vnd.api+json
required
required
object (helferstunden_patch)

Helferstunden-Eintrag eines Nutzers zu einem Anlass

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    • "type": "helferstunden",
    • "id": "1234",
    • "attributes": {
      },
    • "relationships": {
      }
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "jsonapi": {
    • "version": "1.0"
    },
  • "data": {
    • "type": "helferstunden",
    • "id": "1234",
    • "attributes": {
      },
    • "relationships": {
      }
    }
}

POST /helferstunden/anlass

Speichert einen Anlass für Helferstunden

DRAFT: Die API befindet sich derzeit noch in der Entwicklung. Daher kann es sein, dass sich die Spezifikation noch ändert.

Authorizations:
OAuth2
Request Body schema: application/vnd.api+json
required
required
object (helferstunden_anlass_post)

Ein Anlass zu dem mehrere Helferstunden gespeichert werden können (z.B. ein Dienstzeitraum oder freie Helferstunden)

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    • "type": "helferstunden_anlass",
    • "id": "1234",
    • "attributes": {
      },
    • "relationships": {
      }
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "jsonapi": {
    • "version": "1.0"
    },
  • "data": {
    • "type": "helferstunden_anlass",
    • "id": "1234",
    • "attributes": {
      },
    • "relationships": {
      }
    }
}

PATCH /helferstunden/anlass/{id}

Ändert einen Anlass für Helferstunden

DRAFT: Die API befindet sich derzeit noch in der Entwicklung. Daher kann es sein, dass sich die Spezifikation noch ändert.

Authorizations:
OAuth2
path Parameters
id
required
integer

Id des Anlasses

Request Body schema: application/vnd.api+json
required
required
object (helferstunden_anlass_patch)

Ein Anlass zu dem mehrere Helferstunden gespeichert werden können (z.B. ein Dienstzeitraum oder freie Helferstunden)

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    • "type": "helferstunden_anlass",
    • "id": "1234",
    • "attributes": {
      },
    • "relationships": {
      }
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "jsonapi": {
    • "version": "1.0"
    },
  • "data": {
    • "type": "helferstunden_anlass",
    • "id": "1234",
    • "attributes": {
      },
    • "relationships": {
      }
    }
}

GET /helferstunden/einstellungen/selbst

Gibt Helferstunden-Einstellungen bezogen auf den eigenen Nutzer zurück

DRAFT: Die API befindet sich derzeit noch in der Entwicklung. Daher kann es sein, dass sich die Spezifikation noch ändert.

Authorizations:
OAuth2

Responses

Response samples

Content type
application/vnd.api+json
{
  • "jsonapi": {
    • "version": "1.0"
    },
  • "data": {
    • "type": "helferstunden_einstellungen",
    • "id": "1234",
    • "attributes": {
      },
    • "relationships": {
      }
    },
  • "included": [
    • {
      }
    ]
}

Benachrichtigungen

Benachrichtigungen an den Nutzer

GET /benachrichtigungen

Authorizations:
OAuth2

Responses

Response samples

Content type
application/vnd.api+json
{
  • "jsonapi": {
    • "version": "1.0"
    },
  • "meta": {
    • "size": 0
    },
  • "data": [
    • {
      }
    ]
}

DELETE /benachrichtigungen/{id}

löscht eine Benachrichtigung

Authorizations:
OAuth2
path Parameters
id
required
string
Examples:
  • 123-9aabc46f91700bf0d97f625b7c5eeacf -

kombinierte Id aus Benachrichtigung und Empfaenger

Responses

Response samples

Content type
application/vnd.api+json
{
  • "errors": [
    • {
      }
    ]
}

PATCH /benachrichtigungen/{id}

ändert eine Benachrichtigung

Authorizations:
OAuth2
path Parameters
id
required
string
Examples:
  • 123-9aabc46f91700bf0d97f625b7c5eeacf -

kombinierte Id aus Benachrichtigung und Empfaenger

Request Body schema: application/vnd.api+json
required
required
object (benachrichtigung_patch)

Benachrichtigung eines Nutzers

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    • "type": "benachrichtigung",
    • "id": "123-9aabc46f91700bf0d97f625b7c5eeacf",
    • "attributes": {
      }
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "jsonapi": {
    • "version": "1.0"
    },
  • "data": {
    • "type": "benachrichtigung",
    • "id": "123-9aabc46f91700bf0d97f625b7c5eeacf",
    • "attributes": {
      }
    }
}

Formulare

Abruf von Formularen

GET /formulare/v1/liste

Authorizations:
OAuth2
query Parameters
typ
string

Typ des referenzierten Objekts: 'd für Dienst', 't für Termin', 'k für Kurs', 'm für Material', 'u für Personal'

id
string

ID des referenzierten Objekts, wobei beim Personal 'u' die User-ID verwendet wird, z.B. u=9aabc46f91700bf0d97f625b7c5eeacf, für Dienst/Termin/Kurs/Material z.B. d=9557967

Responses

Response samples

Content type
application/json
[
  • {
    • "titel": "Karteikarte",
    • "aktion": {
      }
    }
]