get configuration
id: get_config
title: Calling up Configuration
sidebar_label: Calling up Configuration
1 | GET get-config/ |
This call asks for all information about the current user and associated municipalities and accommodation providers.
At the time of the call, all current information about the municipality is retrieved.
This makes it possible to input any tariffs in the registration form fields defined in the third-party software with the most current values.
Parameters
No parameters necessary
Structure of Response
General
| Field | Data type | Explanation |
|---|---|---|
| user.* | object | Information about the currently logged in user (via token) |
| beherberger | array | Landlord assigned to the account |
| beherberger[].* | object | All information about the landlord |
| beherberger[].objekte | object | All of the landlord's properties assigned to the account |
| Municipalities | array | All municipalities assigned to the account (usually one) |
| gemeinden[].ortsteile | array | All defined districts of the municipality |
| gemeinden[].tarifzonen | array | All defined tariff zones of the municipality |
| gemeinden[].saisonzeiten | array | All defined seasonal periods of the municipality |
| gemeinden[].meldeschein_fields | array | All defined fields of the electronic registration form |
Registration Form Fields
The defined guest/registration form fields can be found under the following path:
gemeinden[GEMEINDE_ID].meldeschein_fields, where GEMEINDE_ID corresponds to the respective municipality
Relevant fields:
| Field | Data type | Explanation |
|---|---|---|
| alias | string | Plain text designation |
| column_name | string | The value of the database column, this value is required for the transfer in /buchen |
| data_type | string | Data type of the field |
| required | boolean | Is the value required when posting a registration form? |
!!! info "Info" All fields with required = true must be transferred when posting a registration form
Defined Tariffs, Seasonal Periods, Tariff Zones
The defined tariffs, seasonal periods and tariff zones follow the same structure
Tariffs: gemeinden[GEMEINDE_ID].tarife, where GEMEINDE_ID corresponds to the respective municipality Seasonal periods: gemeinden[GEMEINDE_ID].saisonzeiten, where GEMEINDE_ID corresponds to the respective municipality Tariff zones: gemeinden[GEMEINDE_ID].tarifzonen, where GEMEINDE_ID corresponds to the respective municipality
Examples
The following example calls up the entire configuration for a demo client.
Response:
1 | { "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" ] } |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 | <?xml version="1.0" encoding="UTF-8"?> <root> <beherberger> <list-element> <alias>DEMO</alias> <allow_logins>true</allow_logins> <anrede>Mr.</anrede> <comment /> <create_invoices>true</create_invoices> <created>2019-09-04T09:49:52.052348+02:00</created> <custom_1 null="true" /> <custom_2 null="true" /> <custom_3 null="true" /> <custom_4 null="true" /> <debitor_nr null="true" /> <email>demo@demo.de</email> <firma>DEMO</firma> <gemeinde>1</gemeinde> <id>9</id> <is_active>true</is_active> <modified>2019-09-04T09:56:22.192552+02:00</modified> <nachname>DEMO</nachname> <objekte> <list-element> <alias>API-property</alias> <anzahl_betten>1</anzahl_betten> <beherberger> <alias>DEMO</alias> <comment /> <debitor_nr null="true" /> <firma>DEMO</firma> <nachname>Max</nachname> <vorname>Mustermann</vorname> </beherberger> <beherberger_id>9</beherberger_id> <created>2019-09-04T09:51:53.201523+02:00</created> <id>9</id> <modified>2019-09-04T09:51:53.201585+02:00</modified> <ort>Westendorf</ort> <ortsteil> <alias>Fehmarn</alias> <created>2019-08-21T15:42:02.596680+02:00</created> <gemeinde>1</gemeinde> <id>1</id> <modified>2019-08-21T15:42:02.596757+02:00</modified> </ortsteil> <ortsteil_id>1</ortsteil_id> <plz>86707</plz> <strasse>API-street</strasse> <tarifzone> <alias>Main zone</alias> <created>2019-08-21T15:41:56.239951+02:00</created> <gemeinde>1</gemeinde> <id>1</id> <modified>2019-08-21T15:41:56.240018+02:00</modified> </tarifzone> <tarifzone_id>1</tarifzone_id> </list-element> </objekte> <ort>DEMO</ort> <plz>123456</plz> <strasse>DEMO</strasse> <telefon>12345</telefon> <vermieter_nr>API-TEST</vermieter_nr> <vorname>DEMO</vorname> </list-element> </beherberger> <created>2019-09-04T09:52:03.825645+02:00</created> <gemeinden> <list-element> <alias>Fehmarn</alias> <created>2019-08-21T15:00:59.512049+02:00</created> <datatable_name>dat_99999</datatable_name> <id>1</id> <meldeschein_fields> <list-element> <alias>Surname</alias> <column_name>Guest_surname</column_name> <created>2019-08-21T15:46:11.393579+02:00</created> <data_type>text</data_type> <gemeinde>1</gemeinde> <id>2</id> <list_visible>true</list_visible> <modified>2019-09-05T14:56:24.456160+02:00</modified> <priority>high</priority> <required>true</required> <size>6</size> <transferable>false</transferable> <view_order>1</view_order> </list-element> <list-element> <alias>First name</alias> <column_name>Guest_firstname</column_name> <created>2019-08-21T15:45:57.452169+02:00</created> <data_type>text</data_type> <gemeinde>1</gemeinde> <id>1</id> <list_visible>true</list_visible> <modified>2019-09-05T14:56:20.478747+02:00</modified> <priority>high</priority> <required>false</required> <size>6</size> <transferable>false</transferable> <view_order>2</view_order> </list-element> <list-element> <alias>Street</alias> <column_name>Guest_street</column_name> <created>2019-08-22T10:26:05.736723+02:00</created> <data_type>text</data_type> <gemeinde>1</gemeinde> <id>3</id> <list_visible>false</list_visible> <modified>2019-08-22T10:26:05.736825+02:00</modified> <priority>low</priority> <required>false</required> <size>12</size> <transferable>false</transferable> <view_order>3</view_order> </list-element> <list-element> <alias>POSTAL CODE</alias> <column_name>Guest_postalcode</column_name> <created>2019-08-22T10:26:29.499058+02:00</created> <data_type>text</data_type> <gemeinde>1</gemeinde> <id>4</id> <list_visible>false</list_visible> <modified>2019-08-22T10:26:29.499139+02:00</modified> <priority>low</priority> <required>false</required> <size>4</size> <transferable>false</transferable> <view_order>4</view_order> </list-element> <list-element> <alias>City</alias> <column_name>Guest_city</column_name> <created>2019-08-22T10:26:42.577394+02:00</created> <data_type>text</data_type> <gemeinde>1</gemeinde> <id>5</id> <list_visible>true</list_visible> <modified>2019-08-22T10:27:14.479290+02:00</modified> <priority>low</priority> <required>false</required> <size>8</size> <transferable>false</transferable> <view_order>5</view_order> </list-element> <list-element> <alias>Date of birth</alias> <column_name>Guest_dateofbirth</column_name> <created>2019-08-26T13:50:23.435905+02:00</created> <data_type>date</data_type> <gemeinde>1</gemeinde> <id>6</id> <list_visible>false</list_visible> <modified>2019-09-05T15:02:12.258999+02:00</modified> <priority>low</priority> <required>false</required> <size>4</size> <transferable>false</transferable> <view_order>6</view_order> </list-element> </meldeschein_fields> <modified>2019-08-21T15:36:50.593090+02:00</modified> <ortsteile> <list-element> <alias>Main area</alias> <created>2019-08-21T15:42:02.596680+02:00</created> <gemeinde>1</gemeinde> <id>1</id> <modified>2019-08-21T15:42:02.596757+02:00</modified> </list-element> </ortsteile> <saisonzeiten> <list-element> <alias>High season 2019</alias> <created>2019-08-21T15:44:42.087596+02:00</created> <gemeinde>1</gemeinde> <id>1</id> <modified>2019-08-21T15:44:42.087663+02:00</modified> <valid_from>2019-05-15</valid_from> <valid_until>2019-09-14</valid_until> </list-element> <list-element> <alias>Low season 1</alias> <created>2019-08-22T10:11:18.114641+02:00</created> <gemeinde>1</gemeinde> <id>2</id> <modified>2019-08-22T10:11:18.114702+02:00</modified> <valid_from>2019-01-01</valid_from> <valid_until>14/05/2019</valid_until> </list-element> <list-element> <alias>Low season 2</alias> <created>2019-08-22T10:12:05.322441+02:00</created> <gemeinde>1</gemeinde> <id>3</id> <modified>2019-08-22T10:12:05.322534+02:00</modified> <valid_from>15/09/2019</valid_from> <valid_until>31/12/2019</valid_until> </list-element> </saisonzeiten> <tarife> <list-element> <alias>Disability 80%</alias> <allow_beherberger>true</allow_beherberger> <created>2019-08-22T10:16:22.572120+02:00</created> <default_selected>false</default_selected> <full_alias>Disability 80% (D 80%)</full_alias> <gemeinde>1</gemeinde> <id>2</id> <is_active>true</is_active> <modified>2019-08-22T10:16:22.572201+02:00</modified> <print_kurkarte>true</print_kurkarte> <tarif_code>D 80%</tarif_code> </list-element> <list-element> <alias>Disability Support</alias> <allow_beherberger>true</allow_beherberger> <created>2019-08-22T10:16:58.052509+02:00</created> <default_selected>false</default_selected> <full_alias>Disability support (DS 80%)</full_alias> <gemeinde>1</gemeinde> <id>3</id> <is_active>true</is_active> <modified>2019-08-22T10:16:58.052578+02:00</modified> <print_kurkarte>true</print_kurkarte> <tarif_code>DS 80%</tarif_code> </list-element> <list-element> <alias>Occupationally present</alias> <allow_beherberger>true</allow_beherberger> <created>2019-08-22T10:21:39.062066+02:00</created> <default_selected>false</default_selected> <full_alias>Occupationally present (OP)</full_alias> <gemeinde>1</gemeinde> <id>7</id> <is_active>true</is_active> <modified>2019-08-22T10:21:39.062138+02:00</modified> <print_kurkarte>true</print_kurkarte> <tarif_code>OP</tarif_code> </list-element> <list-element> <alias>Adult</alias> <allow_beherberger>true</allow_beherberger> <created>2019-08-21T15:43:26.469087+02:00</created> <default_selected>true</default_selected> <full_alias>Adult (A)</full_alias> <gemeinde>1</gemeinde> <id>1</id> <is_active>true</is_active> <modified>2019-09-05T14:54:45.644304+02:00</modified> <print_kurkarte>true</print_kurkarte> <tarif_code>A</tarif_code> </list-element> <list-element> <alias>Groups of 25 people or more</alias> <allow_beherberger>true</allow_beherberger> <created>2019-08-22T10:17:47.179287+02:00</created> <default_selected>false</default_selected> <full_alias>Groups of 25 people or more (GG)</full_alias> <gemeinde>1</gemeinde> <id>5</id> <is_active>true</is_active> <modified>2019-08-22T10:17:47.179348+02:00</modified> <print_kurkarte>true</print_kurkarte> <tarif_code>GG</tarif_code> </list-element> <list-element> <alias>Groups of less than 25 people</alias> <allow_beherberger>true</allow_beherberger> <created>2019-08-22T10:17:30.252887+02:00</created> <default_selected>false</default_selected> <full_alias>Groups of less than 25 people (GK)</full_alias> <gemeinde>1</gemeinde> <id>4</id> <is_active>true</is_active> <modified>2019-08-22T10:17:30.252952+02:00</modified> <print_kurkarte>true</print_kurkarte> <tarif_code>GK</tarif_code> </list-element> <list-element> <alias>No category</alias> <allow_beherberger>true</allow_beherberger> <created>2019-08-22T10:22:02.186252+02:00</created> <default_selected>false</default_selected> <full_alias>No category (NC)</full_alias> <gemeinde>1</gemeinde> <id>8</id> <is_active>true</is_active> <modified>2019-08-22T10:22:02.186552+02:00</modified> <print_kurkarte>true</print_kurkarte> <tarif_code>NC</tarif_code> </list-element> <list-element> <alias>Children</alias> <allow_beherberger>true</allow_beherberger> <created>2019-08-22T10:20:33.649448+02:00</created> <default_selected>false</default_selected> <full_alias>Children (Child)</full_alias> <gemeinde>1</gemeinde> <id>6</id> <is_active>true</is_active> <modified>2019-08-22T10:20:33.649504+02:00</modified> <print_kurkarte>true</print_kurkarte> <tarif_code>Child</tarif_code> </list-element> </tarife> <tarifzonen> <list-element> <alias>Main zone</alias> <created>2019-08-21T15:41:56.239951+02:00</created> <gemeinde>1</gemeinde> <id>1</id> <modified>2019-08-21T15:41:56.240018+02:00</modified> </list-element> </tarifzonen> <using_ems>true</using_ems> <using_paper>true</using_paper> </list-element> </gemeinden> <modified>2019-09-04T09:52:03.825762+02:00</modified> <permissions> <list-element>authentication.add_vermieteraccount</list-element> <list-element>authentication.change_vermieteraccount</list-element> <list-element>authentication.delete_vermieteraccount</list-element> <list-element>authentication.view_vermieteraccount</list-element> <list-element>common.view_beherberger</list-element> <list-element>common.view_objekt</list-element> </permissions> <user> <alias>API Demo</alias> <email>api_demo@apidemo.de</email> <first_name>API</first_name> <id>14</id> <is_active>true</is_active> <last_login>2019-10-24T11:35:18.015947+02:00</last_login> <last_name>Demo</last_name> <user_type>Accommodation provider</user_type> <username>api_demo</username> </user> </root> |