Konfiguration abrufen
GET users/get_current_user |
Dieser Aufruf frägt alle Informationen zum aktuellen Benutzer und damit verknüpften Gemeinden sowie Beherbergern.
Dies ermöglicht es, in der Drittsoftware definierte Tarife, Meldeschein-Felder sowie weitere Informationen abzurufen und bereitzustellen.
Parameter
Keine Parameter notwendig
Aufbau Antwort
Allgemein
| Feld | Datentyp | Erklärung |
|---|---|---|
| user.* | object | Informationen zum aktuell angemeldeten Benutzer (über Token) |
| beherberger | array | Dem Account zugeordnete Vermieter |
| beherberger[].* | object | Sämtliche Informationen zum Vermieter |
| beherberger[].objekte | object | Alle Objekte des Vermieters, welche dem Account zugeordnet sind |
| gemeinden | array | Alle dem Account zugeordneten Gemeinden (i.d.R. eine) |
| gemeinden[].ortsteile | array | Alle definierten Ortsteile der Gemeinde |
| gemeinden[].tarifzonen | array | Alle definierten Tarifzonen der Gemeinde |
| gemeinden[].saisonzeiten | array | Alle definierten Saisonzeiten der Gemeinde |
| gemeinden[].meldeschein_fields | array | Alle definierten Felder des Elektronischen Meldescheins |
Meldeschein-Felder
Die definierten Gast/Meldescheinfelder sind unter folgendem Pfad zu finden:
gemeinden[GEMEINDE_ID].meldeschein_fields, wobei GEMEINDE_ID der jeweiligen Gemeinde entspricht
Relevante Felder:
| Feld | Datentyp | Erklärung |
|---|---|---|
| alias | string | Klartextbezeichnung |
| column_name | string | Der Wert der Datenbankspalte, dieser Wert wird bei der Übergabe in /buchen benötigt |
| data_type | string | Datentyp des Felds |
| required | boolean | Wird der Wert bei der Buchung eines Meldescheins benötigt? |
Hinweis
Alle Felder mit required = true müssen bei der Buchung eines Meldescheins übergeben werden
Definierte Tarife, Saisonzeiten, Tarifzonen
Die definierten Tarife, Saisonzeiten und Tarifzonen folgen dem gleichen Aufbau
Tarife: gemeinden[GEMEINDE_ID].tarife, wobei GEMEINDE_ID der jeweiligen Gemeinde entspricht Saisonzeiten: gemeinden[GEMEINDE_ID].saisonzeiten, wobei GEMEINDE_ID der jeweiligen Gemeinde entspricht Tarifzonen: gemeinden[GEMEINDE_ID].tarifzonen, wobei GEMEINDE_ID der jeweiligen Gemeinde entspricht
Beispiele
Folgendes Beispiel ruft die gesamte Konfiguration für einen Demo-Mandanten ab.
Response:
{
"user": {
"id": 14,
"username": "api_demo",
"first_name": "API",
"last_name": "Demo",
"email": "api_demo@apidemo.de",
"is_active": true,
"user_type": "beherberger",
"alias": "API Demo",
"last_login": "2019-10-24T11:35:18.015947+02:00"
},
"beherberger": [
{
"id": 9,
"objekte": [
{
"id": 9,
"tarifzone_id": 1,
"ortsteil_id": 1,
"beherberger_id": 9,
"tarifzone": {
"id": 1,
"created": "2019-08-21T15:41:56.239951+02:00",
"modified": "2019-08-21T15:41:56.240018+02:00",
"alias": "Hauptzone",
"gemeinde": 1
},
"ortsteil": {
"id": 1,
"created": "2019-08-21T15:42:02.596680+02:00",
"modified": "2019-08-21T15:42:02.596757+02:00",
"alias": "Fehmarn",
"gemeinde": 1
},
"beherberger": {
"firma": "DEMO",
"vorname": "Max",
"nachname": "Mustermann",
"comment": "",
"debitor_nr": null,
"alias": "DEMO"
},
"created": "2019-09-04T09:51:53.201523+02:00",
"modified": "2019-09-04T09:51:53.201585+02:00",
"anzahl_betten": 1,
"alias": "API-Objekt",
"strasse": "API-Strasse",
"plz": "86707",
"ort": "Westendorf"
}
],
"alias": "DEMO",
"created": "2019-09-04T09:49:52.052348+02:00",
"modified": "2019-09-04T09:56:22.192552+02:00",
"is_active": true,
"firma": "DEMO",
"anrede": "Herr",
"vorname": "DEMO",
"nachname": "DEMO",
"strasse": "DEMO",
"plz": "123456",
"ort": "DEMO",
"telefon": "12345",
"email": "demo@demo.de",
"allow_logins": true,
"create_invoices": true,
"custom_1": null,
"custom_2": null,
"custom_3": null,
"custom_4": null,
"debitor_nr": null,
"vermieter_nr": "API-TEST",
"comment": "",
"gemeinde": 1
}
],
"gemeinden": [
{
"id": 1,
"ortsteile": [
{
"id": 1,
"created": "2019-08-21T15:42:02.596680+02:00",
"modified": "2019-08-21T15:42:02.596757+02:00",
"alias": "Hauptbereich",
"gemeinde": 1
}
],
"tarifzonen": [
{
"id": 1,
"created": "2019-08-21T15:41:56.239951+02:00",
"modified": "2019-08-21T15:41:56.240018+02:00",
"alias": "Hauptzone",
"gemeinde": 1
}
],
"saisonzeiten": [
{
"id": 1,
"created": "2019-08-21T15:44:42.087596+02:00",
"modified": "2019-08-21T15:44:42.087663+02:00",
"alias": "Hauptsaison 2019",
"valid_from": "2019-05-15",
"valid_until": "2019-09-14",
"gemeinde": 1
},
{
"id": 2,
"created": "2019-08-22T10:11:18.114641+02:00",
"modified": "2019-08-22T10:11:18.114702+02:00",
"alias": "Nebensaison 1",
"valid_from": "2019-01-01",
"valid_until": "2019-05-14",
"gemeinde": 1
},
{
"id": 3,
"created": "2019-08-22T10:12:05.322441+02:00",
"modified": "2019-08-22T10:12:05.322534+02:00",
"alias": "Nebensaison 2",
"valid_from": "2019-09-15",
"valid_until": "2019-12-31",
"gemeinde": 1
}
],
"tarife": [
{
"id": 2,
"full_alias": "Behinderung 80% (SB 80 %)",
"created": "2019-08-22T10:16:22.572120+02:00",
"modified": "2019-08-22T10:16:22.572201+02:00",
"is_active": true,
"tarif_code": "SB 80 %",
"alias": "Behinderung 80%",
"allow_beherberger": true,
"print_kurkarte": true,
"default_selected": false,
"gemeinde": 1
},
{
"id": 3,
"full_alias": "Behinderung Begleitung (SBB 80 %)",
"created": "2019-08-22T10:16:58.052509+02:00",
"modified": "2019-08-22T10:16:58.052578+02:00",
"is_active": true,
"tarif_code": "SBB 80 %",
"alias": "Behinderung Begleitung",
"allow_beherberger": true,
"print_kurkarte": true,
"default_selected": false,
"gemeinde": 1
},
{
"id": 7,
"full_alias": "Beruflich Anwesende (BA)",
"created": "2019-08-22T10:21:39.062066+02:00",
"modified": "2019-08-22T10:21:39.062138+02:00",
"is_active": true,
"tarif_code": "BA",
"alias": "Beruflich Anwesende",
"allow_beherberger": true,
"print_kurkarte": true,
"default_selected": false,
"gemeinde": 1
},
{
"id": 1,
"full_alias": "Erwachsener (EW)",
"created": "2019-08-21T15:43:26.469087+02:00",
"modified": "2019-09-05T14:54:45.644304+02:00",
"is_active": true,
"tarif_code": "EW",
"alias": "Erwachsener",
"allow_beherberger": true,
"print_kurkarte": true,
"default_selected": true,
"gemeinde": 1
},
{
"id": 5,
"full_alias": "Gruppen ab 25 Personen (GG)",
"created": "2019-08-22T10:17:47.179287+02:00",
"modified": "2019-08-22T10:17:47.179348+02:00",
"is_active": true,
"tarif_code": "GG",
"alias": "Gruppen ab 25 Personen",
"allow_beherberger": true,
"print_kurkarte": true,
"default_selected": false,
"gemeinde": 1
},
{
"id": 4,
"full_alias": "Gruppen unter 25 Personen (GK)",
"created": "2019-08-22T10:17:30.252887+02:00",
"modified": "2019-08-22T10:17:30.252952+02:00",
"is_active": true,
"tarif_code": "GK",
"alias": "Gruppen unter 25 Personen",
"allow_beherberger": true,
"print_kurkarte": true,
"default_selected": false,
"gemeinde": 1
},
{
"id": 8,
"full_alias": "keine Kategorie (kK)",
"created": "2019-08-22T10:22:02.186252+02:00",
"modified": "2019-08-22T10:22:02.186552+02:00",
"is_active": true,
"tarif_code": "kK",
"alias": "keine Kategorie",
"allow_beherberger": true,
"print_kurkarte": true,
"default_selected": false,
"gemeinde": 1
},
{
"id": 6,
"full_alias": "Kinder (Kind)",
"created": "2019-08-22T10:20:33.649448+02:00",
"modified": "2019-08-22T10:20:33.649504+02:00",
"is_active": true,
"tarif_code": "Kind",
"alias": "Kinder",
"allow_beherberger": true,
"print_kurkarte": true,
"default_selected": false,
"gemeinde": 1
}
],
"meldeschein_fields": [
{
"id": 2,
"created": "2019-08-21T15:46:11.393579+02:00",
"modified": "2019-09-05T14:56:24.456160+02:00",
"alias": "Nachname",
"column_name": "Gast_Name",
"data_type": "text",
"size": 6,
"transferable": false,
"list_visible": true,
"required": true,
"priority": "high",
"view_order": 1,
"gemeinde": 1
},
{
"id": 1,
"created": "2019-08-21T15:45:57.452169+02:00",
"modified": "2019-09-05T14:56:20.478747+02:00",
"alias": "Vorname",
"column_name": "Gast_Vorname",
"data_type": "text",
"size": 6,
"transferable": false,
"list_visible": true,
"required": false,
"priority": "high",
"view_order": 2,
"gemeinde": 1
},
{
"id": 3,
"created": "2019-08-22T10:26:05.736723+02:00",
"modified": "2019-08-22T10:26:05.736825+02:00",
"alias": "Strasse",
"column_name": "Gast_Strasse",
"data_type": "text",
"size": 12,
"transferable": false,
"list_visible": false,
"required": false,
"priority": "low",
"view_order": 3,
"gemeinde": 1
},
{
"id": 4,
"created": "2019-08-22T10:26:29.499058+02:00",
"modified": "2019-08-22T10:26:29.499139+02:00",
"alias": "PLZ",
"column_name": "Gast_Postleitzahl",
"data_type": "text",
"size": 4,
"transferable": false,
"list_visible": false,
"required": false,
"priority": "low",
"view_order": 4,
"gemeinde": 1
},
{
"id": 5,
"created": "2019-08-22T10:26:42.577394+02:00",
"modified": "2019-08-22T10:27:14.479290+02:00",
"alias": "Ort",
"column_name": "Gast_Wohnort",
"data_type": "text",
"size": 8,
"transferable": false,
"list_visible": true,
"required": false,
"priority": "low",
"view_order": 5,
"gemeinde": 1
},
{
"id": 6,
"created": "2019-08-26T13:50:23.435905+02:00",
"modified": "2019-09-05T15:02:12.258999+02:00",
"alias": "Geburtsdatum",
"column_name": "Gast_Geburtstag",
"data_type": "date",
"size": 4,
"transferable": false,
"list_visible": false,
"required": false,
"priority": "low",
"view_order": 6,
"gemeinde": 1
}
],
"created": "2019-08-21T15:00:59.512049+02:00",
"modified": "2019-08-21T15:36:50.593090+02:00",
"alias": "Fehmarn",
"using_paper": true,
"using_ems": true,
"datatable_name": "dat_99999"
}
],
"created": "2019-09-04T09:52:03.825645+02:00",
"modified": "2019-09-04T09:52:03.825762+02:00",
"permissions": [
"authentication.add_vermieteraccount",
"authentication.change_vermieteraccount",
"authentication.delete_vermieteraccount",
"authentication.view_vermieteraccount",
"common.view_beherberger",
"common.view_objekt"
]
}
No Comments