HTTP status code 200

Headers

• X-Count: required(string)

  Gesamtzahl der Treffer.

Body

Media type: application/json

Type: array of serviceProviderBase

Items: serviceProvider

Secured by oauth_2_0

Headers

• Authorization: required(string)

  Authentifizierung erfolgt über Bearer-Token im HTTP-Header.

  Example:

  Authorization: Bearer eyJ0eXAiOiJKV1QiLCJh...

Query Parameters

• access_token: required(string)

  Alternative Methode, um ein JWT-Token zu übergeben. Nicht zusammen mit dem "Authorization"-Header verwenden!

HTTP status code 401

Token fehlt, ist abgelaufen oder nicht valide. Oder: Keine Berechtigung (s. Fehlermeldung im Response).

Body

Media type: application/json

Type: any

Example:

{
  "error": "token_missing"
}

HTTP status code 200

Body

Media type: application/json

Type: object

• title: (string)

  Betriebsname

• sort_title: (string)

  Sortiertitel

• sp_type: (string)

  Typ des Service Provider/Leistungsträgers

• status: (string - default: none)

  Aktueller Status des Gastgebers (rot, gelb, grün)

• address: required(object)

  Adressdaten

  • street: (string)
  • zip: (string)
  • city: (string)
  • phone: (string)
  • fax: (string)
  • email: (string)
  • web: (string)
  • contact_person: (string)
• payment: required(object)

  Rechnungsanschrift (falls abweichend)

  • title: (string)
  • salutation: (string)
  • first_name: (string)
  • last_name: (string)
  • street: (string)
  • zip: (string)
  • city: (string)
• data: (object)

  Beliebige Daten als Schlüssel-Wert-Paare oder Unterdokumente erstellt (auch Arrays, u.ä. möglich).

  Example:

  {
    "baskets": 1,
    "features": [ "XP1", "AXZ", "991" ],
    "sub_title": "Das Beste am Robbenstrand"
  }
  

• features: (array of string)

  Liste von Feature-Ids, welche für diesen Mandanten zutreffen.

• is_test_user: (boolean - default: false)

  True, falls Testbenutzer

• contact_declined: (boolean - default: false)

  True, falls kein weiterer Kontakt wegen Anzeigen gewünscht ist.

• principal_id: required(string)

  Mandanten-Id

  Example:

  960c927b-5582-4af0-a771-6f7cbf79ad23

• _id: required(string)

  UUID (v4)

  Example:

  960c927b-5582-4af0-a771-6f7cbf79ad23

• title_ascii: (string)

  ASCII-Repräsentation des Titels (zum Sortieren nach Wörterbuch)

• sort_title_ascii: (string)

  ASCII-Sortiertitel (zum Sortieren nach Wörterbuch)

• tomas_id: required(string)

  TOMAS ID

  Example:

  AUT00020100012345678

• login: required(string)
• created: required(datetime)

  Datumsformat (RFC3339)

  Example:

  2016-02-28T16:41:41.090Z

• changed: required(datetime)

  Datumsformat (RFC3339)

  Example:

  2016-02-28T16:41:41.090Z

• last_login: (datetime)

  Letzter Login

  Example:

  2016-02-28T16:41:41.090Z

• last_action: (datetime)

  Letzte Aktion des Benutzers (mit der API)

  Example:

  2016-02-28T16:41:41.090Z

Example:

{
  "principal_id": "b60b707c-1ce5-4b5d-95ac-6b5199e10b7b",
  "_id": "960c927b-5582-4af0-a771-6f7cbf79ad23",
  "title": "Alpenchalet Gutewiese",
  "tomas_id": "AUT00020100012345678",
  "login": "office@alpenchalet-gutewiese.at",
  "address": {
    "street": "Gutweg 1",
    "zip": "4356",
    "city": "Gutwiesenberg",
    "phone": "+39-1234-456788",
    "fax": "+39-1234-456799",
    "email": "office@alpenchalet-gutewiese.at",
    "web": "http://www.alpenchalet-gutewiese.at",
    "contact_person": "Herr Müller"
  },
  "payment": {
    "title": "Alpenchalet Gutewiese GmbH",
    "salutation": "Herr",
    "first_name": "Alfons",
    "last_name": "Müller",
    "street": "Gutweg 1",
    "zip": "4356",
    "city": "Gutwiesenberg"
  },
  "features": [
    "online_bookable",
    "123545",
    "xyz"
  ],
  "is_test_user": false,
  "contact_declined": false,
  "created": "2016-02-28T16:41:41.090Z",
  "changed": "2016-02-28T16:41:41.090Z",
  "last_login": null,
  "last_action": null
}

HTTP status code 405

Fehlende oder fehlerhaft formatierte Daten übergeben.

Body

Media type: application/json

Type: any

Example:

{
  "error": "missing_or_malformed_data"
}

Secured by oauth_2_0

Headers

• Authorization: required(string)

  Authentifizierung erfolgt über Bearer-Token im HTTP-Header.

  Example:

  Authorization: Bearer eyJ0eXAiOiJKV1QiLCJh...

Query Parameters

• access_token: required(string)

  Alternative Methode, um ein JWT-Token zu übergeben. Nicht zusammen mit dem "Authorization"-Header verwenden!

HTTP status code 401

Token fehlt, ist abgelaufen oder nicht valide. Oder: Keine Berechtigung (s. Fehlermeldung im Response).

Body

Media type: application/json

Type: any

Example:

{
  "error": "token_missing"
}

HTTP status code 200

Body

Media type: application/json

Type: object

• title: (string)

  Betriebsname

• sort_title: (string)

  Sortiertitel

• sp_type: (string)

  Typ des Service Provider/Leistungsträgers

• status: (string - default: none)

  Aktueller Status des Gastgebers (rot, gelb, grün)

• address: required(object)

  Adressdaten

  • street: (string)
  • zip: (string)
  • city: (string)
  • phone: (string)
  • fax: (string)
  • email: (string)
  • web: (string)
  • contact_person: (string)
• payment: required(object)

  Rechnungsanschrift (falls abweichend)

  • title: (string)
  • salutation: (string)
  • first_name: (string)
  • last_name: (string)
  • street: (string)
  • zip: (string)
  • city: (string)
• data: (object)

  Beliebige Daten als Schlüssel-Wert-Paare oder Unterdokumente erstellt (auch Arrays, u.ä. möglich).

  Example:

  {
    "baskets": 1,
    "features": [ "XP1", "AXZ", "991" ],
    "sub_title": "Das Beste am Robbenstrand"
  }
  

• features: (array of string)

  Liste von Feature-Ids, welche für diesen Mandanten zutreffen.

• is_test_user: (boolean - default: false)

  True, falls Testbenutzer

• contact_declined: (boolean - default: false)

  True, falls kein weiterer Kontakt wegen Anzeigen gewünscht ist.

• principal_id: required(string)

  Mandanten-Id

  Example:

  960c927b-5582-4af0-a771-6f7cbf79ad23

• _id: required(string)

  UUID (v4)

  Example:

  960c927b-5582-4af0-a771-6f7cbf79ad23

• title_ascii: (string)

  ASCII-Repräsentation des Titels (zum Sortieren nach Wörterbuch)

• sort_title_ascii: (string)

  ASCII-Sortiertitel (zum Sortieren nach Wörterbuch)

• tomas_id: required(string)

  TOMAS ID

  Example:

  AUT00020100012345678

• login: required(string)
• created: required(datetime)

  Datumsformat (RFC3339)

  Example:

  2016-02-28T16:41:41.090Z

• changed: required(datetime)

  Datumsformat (RFC3339)

  Example:

  2016-02-28T16:41:41.090Z

• last_login: (datetime)

  Letzter Login

  Example:

  2016-02-28T16:41:41.090Z

• last_action: (datetime)

  Letzte Aktion des Benutzers (mit der API)

  Example:

  2016-02-28T16:41:41.090Z

Example:

{
  "principal_id": "b60b707c-1ce5-4b5d-95ac-6b5199e10b7b",
  "_id": "960c927b-5582-4af0-a771-6f7cbf79ad23",
  "title": "Alpenchalet Gutewiese",
  "tomas_id": "AUT00020100012345678",
  "login": "office@alpenchalet-gutewiese.at",
  "address": {
    "street": "Gutweg 1",
    "zip": "4356",
    "city": "Gutwiesenberg",
    "phone": "+39-1234-456788",
    "fax": "+39-1234-456799",
    "email": "office@alpenchalet-gutewiese.at",
    "web": "http://www.alpenchalet-gutewiese.at",
    "contact_person": "Herr Müller"
  },
  "payment": {
    "title": "Alpenchalet Gutewiese GmbH",
    "salutation": "Herr",
    "first_name": "Alfons",
    "last_name": "Müller",
    "street": "Gutweg 1",
    "zip": "4356",
    "city": "Gutwiesenberg"
  },
  "features": [
    "online_bookable",
    "123545",
    "xyz"
  ],
  "is_test_user": false,
  "contact_declined": false,
  "created": "2016-02-28T16:41:41.090Z",
  "changed": "2016-02-28T16:41:41.090Z",
  "last_login": null,
  "last_action": null
}

HTTP status code 404

Resource nicht gefunden

Body

Media type: application/json

Type: any

Example:

{
  "error": "not_found"
}

HTTP status code 405

Fehlende oder fehlerhaft formatierte Daten übergeben.

Body

Media type: application/json

Type: any

Example:

{
  "error": "missing_or_malformed_data"
}

Secured by oauth_2_0

Headers

• Authorization: required(string)

  Authentifizierung erfolgt über Bearer-Token im HTTP-Header.

  Example:

  Authorization: Bearer eyJ0eXAiOiJKV1QiLCJh...

Query Parameters

• access_token: required(string)

  Alternative Methode, um ein JWT-Token zu übergeben. Nicht zusammen mit dem "Authorization"-Header verwenden!

HTTP status code 401

Token fehlt, ist abgelaufen oder nicht valide. Oder: Keine Berechtigung (s. Fehlermeldung im Response).

Body

Media type: application/json

Type: any

Example:

{
  "error": "token_missing"
}

HTTP status code 200

Body

Media type: application/json

Type: object

• title: (string)

  Betriebsname

• sort_title: (string)

  Sortiertitel

• sp_type: (string)

  Typ des Service Provider/Leistungsträgers

• status: (string - default: none)

  Aktueller Status des Gastgebers (rot, gelb, grün)

• address: required(object)

  Adressdaten

  • street: (string)
  • zip: (string)
  • city: (string)
  • phone: (string)
  • fax: (string)
  • email: (string)
  • web: (string)
  • contact_person: (string)
• payment: required(object)

  Rechnungsanschrift (falls abweichend)

  • title: (string)
  • salutation: (string)
  • first_name: (string)
  • last_name: (string)
  • street: (string)
  • zip: (string)
  • city: (string)
• data: (object)

  Beliebige Daten als Schlüssel-Wert-Paare oder Unterdokumente erstellt (auch Arrays, u.ä. möglich).

  Example:

  {
    "baskets": 1,
    "features": [ "XP1", "AXZ", "991" ],
    "sub_title": "Das Beste am Robbenstrand"
  }
  

• features: (array of string)

  Liste von Feature-Ids, welche für diesen Mandanten zutreffen.

• is_test_user: (boolean - default: false)

  True, falls Testbenutzer

• contact_declined: (boolean - default: false)

  True, falls kein weiterer Kontakt wegen Anzeigen gewünscht ist.

• principal_id: required(string)

  Mandanten-Id

  Example:

  960c927b-5582-4af0-a771-6f7cbf79ad23

• _id: required(string)

  UUID (v4)

  Example:

  960c927b-5582-4af0-a771-6f7cbf79ad23

• title_ascii: (string)

  ASCII-Repräsentation des Titels (zum Sortieren nach Wörterbuch)

• sort_title_ascii: (string)

  ASCII-Sortiertitel (zum Sortieren nach Wörterbuch)

• tomas_id: required(string)

  TOMAS ID

  Example:

  AUT00020100012345678

• login: required(string)
• created: required(datetime)

  Datumsformat (RFC3339)

  Example:

  2016-02-28T16:41:41.090Z

• changed: required(datetime)

  Datumsformat (RFC3339)

  Example:

  2016-02-28T16:41:41.090Z

• last_login: (datetime)

  Letzter Login

  Example:

  2016-02-28T16:41:41.090Z

• last_action: (datetime)

  Letzte Aktion des Benutzers (mit der API)

  Example:

  2016-02-28T16:41:41.090Z

Example:

{
  "principal_id": "b60b707c-1ce5-4b5d-95ac-6b5199e10b7b",
  "_id": "960c927b-5582-4af0-a771-6f7cbf79ad23",
  "title": "Alpenchalet Gutewiese",
  "tomas_id": "AUT00020100012345678",
  "login": "office@alpenchalet-gutewiese.at",
  "address": {
    "street": "Gutweg 1",
    "zip": "4356",
    "city": "Gutwiesenberg",
    "phone": "+39-1234-456788",
    "fax": "+39-1234-456799",
    "email": "office@alpenchalet-gutewiese.at",
    "web": "http://www.alpenchalet-gutewiese.at",
    "contact_person": "Herr Müller"
  },
  "payment": {
    "title": "Alpenchalet Gutewiese GmbH",
    "salutation": "Herr",
    "first_name": "Alfons",
    "last_name": "Müller",
    "street": "Gutweg 1",
    "zip": "4356",
    "city": "Gutwiesenberg"
  },
  "features": [
    "online_bookable",
    "123545",
    "xyz"
  ],
  "is_test_user": false,
  "contact_declined": false,
  "created": "2016-02-28T16:41:41.090Z",
  "changed": "2016-02-28T16:41:41.090Z",
  "last_login": null,
  "last_action": null
}

HTTP status code 404

Resource nicht gefunden

Body

Media type: application/json

Type: any

Example:

{
  "error": "not_found"
}

HTTP status code 405

Fehlende oder fehlerhaft formatierte Daten übergeben.

Body

Media type: application/json

Type: any

Example:

{
  "error": "missing_or_malformed_data"
}

Secured by oauth_2_0

Headers

• Authorization: required(string)

  Authentifizierung erfolgt über Bearer-Token im HTTP-Header.

  Example:

  Authorization: Bearer eyJ0eXAiOiJKV1QiLCJh...

Query Parameters

• access_token: required(string)

  Alternative Methode, um ein JWT-Token zu übergeben. Nicht zusammen mit dem "Authorization"-Header verwenden!

HTTP status code 401

Token fehlt, ist abgelaufen oder nicht valide. Oder: Keine Berechtigung (s. Fehlermeldung im Response).

Body

Media type: application/json

Type: any

Example:

{
  "error": "token_missing"
}

HTTP status code 200

Gibt das gelöschte Objekt zurück.

Body

Media type: application/json

Type: object

• title: (string)

  Betriebsname

• sort_title: (string)

  Sortiertitel

• sp_type: (string)

  Typ des Service Provider/Leistungsträgers

• status: (string - default: none)

  Aktueller Status des Gastgebers (rot, gelb, grün)

• address: required(object)

  Adressdaten

  • street: (string)
  • zip: (string)
  • city: (string)
  • phone: (string)
  • fax: (string)
  • email: (string)
  • web: (string)
  • contact_person: (string)
• payment: required(object)

  Rechnungsanschrift (falls abweichend)

  • title: (string)
  • salutation: (string)
  • first_name: (string)
  • last_name: (string)
  • street: (string)
  • zip: (string)
  • city: (string)
• data: (object)

  Beliebige Daten als Schlüssel-Wert-Paare oder Unterdokumente erstellt (auch Arrays, u.ä. möglich).

  Example:

  {
    "baskets": 1,
    "features": [ "XP1", "AXZ", "991" ],
    "sub_title": "Das Beste am Robbenstrand"
  }
  

• features: (array of string)

  Liste von Feature-Ids, welche für diesen Mandanten zutreffen.

• is_test_user: (boolean - default: false)

  True, falls Testbenutzer

• contact_declined: (boolean - default: false)

  True, falls kein weiterer Kontakt wegen Anzeigen gewünscht ist.

• principal_id: required(string)

  Mandanten-Id

  Example:

  960c927b-5582-4af0-a771-6f7cbf79ad23

• _id: required(string)

  UUID (v4)

  Example:

  960c927b-5582-4af0-a771-6f7cbf79ad23

• title_ascii: (string)

  ASCII-Repräsentation des Titels (zum Sortieren nach Wörterbuch)

• sort_title_ascii: (string)

  ASCII-Sortiertitel (zum Sortieren nach Wörterbuch)

• tomas_id: required(string)

  TOMAS ID

  Example:

  AUT00020100012345678

• login: required(string)
• created: required(datetime)

  Datumsformat (RFC3339)

  Example:

  2016-02-28T16:41:41.090Z

• changed: required(datetime)

  Datumsformat (RFC3339)

  Example:

  2016-02-28T16:41:41.090Z

• last_login: (datetime)

  Letzter Login

  Example:

  2016-02-28T16:41:41.090Z

• last_action: (datetime)

  Letzte Aktion des Benutzers (mit der API)

  Example:

  2016-02-28T16:41:41.090Z

Example:

{
  "principal_id": "b60b707c-1ce5-4b5d-95ac-6b5199e10b7b",
  "_id": "960c927b-5582-4af0-a771-6f7cbf79ad23",
  "title": "Alpenchalet Gutewiese",
  "tomas_id": "AUT00020100012345678",
  "login": "office@alpenchalet-gutewiese.at",
  "address": {
    "street": "Gutweg 1",
    "zip": "4356",
    "city": "Gutwiesenberg",
    "phone": "+39-1234-456788",
    "fax": "+39-1234-456799",
    "email": "office@alpenchalet-gutewiese.at",
    "web": "http://www.alpenchalet-gutewiese.at",
    "contact_person": "Herr Müller"
  },
  "payment": {
    "title": "Alpenchalet Gutewiese GmbH",
    "salutation": "Herr",
    "first_name": "Alfons",
    "last_name": "Müller",
    "street": "Gutweg 1",
    "zip": "4356",
    "city": "Gutwiesenberg"
  },
  "features": [
    "online_bookable",
    "123545",
    "xyz"
  ],
  "is_test_user": false,
  "contact_declined": false,
  "created": "2016-02-28T16:41:41.090Z",
  "changed": "2016-02-28T16:41:41.090Z",
  "last_login": null,
  "last_action": null
}

HTTP status code 404

Resource nicht gefunden

Body

Media type: application/json

Type: any

Example:

{
  "error": "not_found"
}

HTTP status code 405

Fehlende oder fehlerhaft formatierte Daten übergeben.

Body

Media type: application/json

Type: any

Example:

{
  "error": "missing_or_malformed_data"
}

Secured by oauth_2_0

Headers

• Authorization: required(string)

  Authentifizierung erfolgt über Bearer-Token im HTTP-Header.

  Example:

  Authorization: Bearer eyJ0eXAiOiJKV1QiLCJh...

Query Parameters

• access_token: required(string)

  Alternative Methode, um ein JWT-Token zu übergeben. Nicht zusammen mit dem "Authorization"-Header verwenden!

HTTP status code 401

Token fehlt, ist abgelaufen oder nicht valide. Oder: Keine Berechtigung (s. Fehlermeldung im Response).

Body

Media type: application/json

Type: any

Example:

{
  "error": "token_missing"
}

Secured by oauth_2_0

Headers

• Authorization: required(string)

  Authentifizierung erfolgt über Bearer-Token im HTTP-Header.

  Example:

  Authorization: Bearer eyJ0eXAiOiJKV1QiLCJh...

Query Parameters

• access_token: required(string)

  Alternative Methode, um ein JWT-Token zu übergeben. Nicht zusammen mit dem "Authorization"-Header verwenden!

HTTP status code 401

Token fehlt, ist abgelaufen oder nicht valide. Oder: Keine Berechtigung (s. Fehlermeldung im Response).

Body

Media type: application/json

Type: any

Example:

{
  "error": "token_missing"
}

HTTP status code 200

Login war erfolgreich - JWT-Token wurde erstellt.

Body

Media type: application/json

Type: object

• jwt: required(string)

  JWT Token for this session.

  Example:

  eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c

• serviceProvider: required(object)

  Service Provider/Leistungsträger importiert aus TOMAS

  • title: (string)

    Betriebsname

  • sort_title: (string)

    Sortiertitel

  • sp_type: (string)

    Typ des Service Provider/Leistungsträgers

  • status: (string - default: none)

    Aktueller Status des Gastgebers (rot, gelb, grün)

  • address: required(object)

    Adressdaten

    • street: (string)
    • zip: (string)
    • city: (string)
    • phone: (string)
    • fax: (string)
    • email: (string)
    • web: (string)
    • contact_person: (string)
  • payment: required(object)

    Rechnungsanschrift (falls abweichend)

    • title: (string)
    • salutation: (string)
    • first_name: (string)
    • last_name: (string)
    • street: (string)
    • zip: (string)
    • city: (string)
  • data: (object)

    Beliebige Daten als Schlüssel-Wert-Paare oder Unterdokumente erstellt (auch Arrays, u.ä. möglich).

    Example:

    {
      "baskets": 1,
      "features": [ "XP1", "AXZ", "991" ],
      "sub_title": "Das Beste am Robbenstrand"
    }
    

  • features: (array of string)

    Liste von Feature-Ids, welche für diesen Mandanten zutreffen.

  • is_test_user: (boolean - default: false)

    True, falls Testbenutzer

  • contact_declined: (boolean - default: false)

    True, falls kein weiterer Kontakt wegen Anzeigen gewünscht ist.

  • principal_id: required(string)

    Mandanten-Id

    Example:

    960c927b-5582-4af0-a771-6f7cbf79ad23

  • _id: required(string)

    UUID (v4)

    Example:

    960c927b-5582-4af0-a771-6f7cbf79ad23

  • title_ascii: (string)

    ASCII-Repräsentation des Titels (zum Sortieren nach Wörterbuch)

  • sort_title_ascii: (string)

    ASCII-Sortiertitel (zum Sortieren nach Wörterbuch)

  • tomas_id: required(string)

    TOMAS ID

    Example:

    AUT00020100012345678

  • login: required(string)
  • created: required(datetime)

    Datumsformat (RFC3339)

    Example:

    2016-02-28T16:41:41.090Z

  • changed: required(datetime)

    Datumsformat (RFC3339)

    Example:

    2016-02-28T16:41:41.090Z

  • last_login: (datetime)

    Letzter Login

    Example:

    2016-02-28T16:41:41.090Z

  • last_action: (datetime)

    Letzte Aktion des Benutzers (mit der API)

    Example:

    2016-02-28T16:41:41.090Z

  Example:

  {
    "principal_id": "b60b707c-1ce5-4b5d-95ac-6b5199e10b7b",
    "_id": "960c927b-5582-4af0-a771-6f7cbf79ad23",
    "title": "Alpenchalet Gutewiese",
    "tomas_id": "AUT00020100012345678",
    "login": "office@alpenchalet-gutewiese.at",
    "address": {
      "street": "Gutweg 1",
      "zip": "4356",
      "city": "Gutwiesenberg",
      "phone": "+39-1234-456788",
      "fax": "+39-1234-456799",
      "email": "office@alpenchalet-gutewiese.at",
      "web": "http://www.alpenchalet-gutewiese.at",
      "contact_person": "Herr Müller"
    },
    "payment": {
      "title": "Alpenchalet Gutewiese GmbH",
      "salutation": "Herr",
      "first_name": "Alfons",
      "last_name": "Müller",
      "street": "Gutweg 1",
      "zip": "4356",
      "city": "Gutwiesenberg"
    },
    "features": [
      "online_bookable",
      "123545",
      "xyz"
    ],
    "is_test_user": false,
    "contact_declined": false,
    "created": "2016-02-28T16:41:41.090Z",
    "changed": "2016-02-28T16:41:41.090Z",
    "last_login": null,
    "last_action": null
  }

HTTP status code 401

Login fehlerhaft.

Body

Media type: application/json

Type: any

Example:

{
  "error": "token_missing"
}

HTTP status code 200

Ausloggen war erfolgreich, JWT-Token invalidiert.

Body

Media type: application/json

Type: any

Example:

{
  "status": "OK",
  "version": 1,
  "message": "ok"
}

HTTP status code 401

Ausloggen war nicht erfolgreich, Token war nicht valide oder bereits ausgeloggt.

Body

Media type: application/json

Type: any

Example:

{
  "error": "token_missing"
}

Secured by oauth_2_0

Headers

• Authorization: required(string)

  Authentifizierung erfolgt über Bearer-Token im HTTP-Header.

  Example:

  Authorization: Bearer eyJ0eXAiOiJKV1QiLCJh...

Query Parameters

• access_token: required(string)

  Alternative Methode, um ein JWT-Token zu übergeben. Nicht zusammen mit dem "Authorization"-Header verwenden!

HTTP status code 401

Token fehlt, ist abgelaufen oder nicht valide. Oder: Keine Berechtigung (s. Fehlermeldung im Response).

Body

Media type: application/json

Type: any

Example:

{
  "error": "token_missing"
}

HTTP status code 200

Headers

• X-Count: required(string)

  Gesamtzahl der Treffer.

Body

Media type: application/json

Type: array of advertisementBase

Items: advertisement

Secured by oauth_2_0

Headers

• Authorization: required(string)

  Authentifizierung erfolgt über Bearer-Token im HTTP-Header.

  Example:

  Authorization: Bearer eyJ0eXAiOiJKV1QiLCJh...

Query Parameters

• access_token: required(string)

  Alternative Methode, um ein JWT-Token zu übergeben. Nicht zusammen mit dem "Authorization"-Header verwenden!

HTTP status code 401

Token fehlt, ist abgelaufen oder nicht valide. Oder: Keine Berechtigung (s. Fehlermeldung im Response).

Body

Media type: application/json

Type: any

Example:

{
  "error": "token_missing"
}

HTTP status code 200

Body

Media type: application/json

Type: object

• title: (string)

  Titel der Anzeige

• sort_title: (string)

  Sortiertitel

• sp_type: (string)

  Typ des Service Provider/Leistungsträgers

• sp_type_text: (string)

  Typ des Service Provider/Leistungsträgers (Text für Dashboard)

• format: (string)

  Format der Anzeige (Text)

• status: (string - default: none)

  Aktueller Status des Gastgebers (rot, gelb, grün)

• price: (number)

  Preis

• pdf_file: (string)

  Referenz auf generierte PDF-Datei (MongoId)

• internal_status: (one of 00_unchecked, 10_in_consultation, 20_approved)

  Interner Status für Dokumente, die eine Druckfreigabe bekommen haben.

• data: (object)

  Beliebige Daten als Schlüssel-Wert-Paare oder Unterdokumente erstellt (auch Arrays, u.ä. möglich).

  Example:

  {
    "baskets": 1,
    "features": [ "XP1", "AXZ", "991" ],
    "sub_title": "Das Beste am Robbenstrand"
  }
  

• address: (object)

  Adressdaten - Kopie vom Gastgeber beim erstellen

  • street: (string)
  • zip: (string)
  • city: (string)
  • phone: (string)
  • fax: (string)
  • email: (string)
  • web: (string)
  • contact_person: (string)
• payment: (object)

  Rechnungsanschrift - Kopie vom Gastgeber beim erstellen

  • title: (string)
  • salutation: (string)
  • first_name: (string)
  • last_name: (string)
  • street: (string)
  • zip: (string)
  • city: (string)
• _id: required(string)

  UUID (v4)

  Example:

  960c927b-5582-4af0-a771-6f7cbf79ad23

• principal_id: required(string)

  Mandanten-Id

  Example:

  960c927b-5582-4af0-a771-6f7cbf79ad23

• service_provider_id: required(string)

  Gastgeber-Id

  Example:

  960c927b-5582-4af0-a771-6f7cbf79ad23

• season_id: required(string)

  Saison-Referenz

  Example:

  960c927b-5582-4af0-a771-6f7cbf79ad23

• title_ascii: (string)

  ASCII-Repräsentation des Titels (zum Sortieren nach Wörterbuch)

• sort_title_ascii: (string)

  ASCII-Sortiertitel (zum Sortieren nach Wörterbuch)

• current_step: required(number)

  Aktueller Schritt

• print_approval: required(boolean)

  Druckfreigabe erteilt?

• created: required(datetime)

  Datumsformat (RFC3339)

  Example:

  2016-02-28T16:41:41.090Z

• changed: required(datetime)

  Datumsformat (RFC3339)

  Example:

  2016-02-28T16:41:41.090Z

Example:

{
  "_id": "78bab0ca-7233-43da-b4f8-d4c120547101",
  "principal_id": "b60b707c-1ce5-4b5d-95ac-6b5199e10b7b",
  "service_provider_id": "960c927b-5582-4af0-a771-6f7cbf79ad23",
  "season_id": "3543ee4f-8c0e-40d9-ace8-6f25cd6b3c9c",
  "sp_type": "0",
  "sp_type_string": "Pension",
  "format": "1/2 Seite, 3 Bilder",
  "price": 1099.99,
  "current_step": 3,
  "print_approval": true,
  "pdf_file": "5b85ff54102000d00005ab12",
  "address": {
    "street": "Gutweg 1",
    "zip": "4356",
    "city": "Gutwiesenberg",
    "phone": "+39-1234-456788",
    "fax": "+39-1234-456799",
    "email": "office@alpenchalet-gutewiese.at",
    "web": "http://www.alpenchalet-gutewiese.at",
    "contact_person": "Herr Müller"
  },
  "payment": {
    "title": "Unsere kleine Pension",
    "salutation": "Herr",
    "first_name": "Alfons",
    "last_name": "Müller",
    "street": "Gutweg 1",
    "zip": "4356",
    "city": "Gutwiesenberg"
  },
  "data": {
    "baskets": 1,
    "features": [ "XP1", "AXZ", "991" ],
    "sub_title": "Das Beste am Robbenstrand"
  }
}

HTTP status code 405

Fehlende oder fehlerhaft formatierte Daten übergeben.

Body

Media type: application/json

Type: any

Example:

{
  "error": "missing_or_malformed_data"
}

Secured by oauth_2_0

Headers

• Authorization: required(string)

  Authentifizierung erfolgt über Bearer-Token im HTTP-Header.

  Example:

  Authorization: Bearer eyJ0eXAiOiJKV1QiLCJh...

Query Parameters

• access_token: required(string)

  Alternative Methode, um ein JWT-Token zu übergeben. Nicht zusammen mit dem "Authorization"-Header verwenden!

HTTP status code 401

Token fehlt, ist abgelaufen oder nicht valide. Oder: Keine Berechtigung (s. Fehlermeldung im Response).

Body

Media type: application/json

Type: any

Example:

{
  "error": "token_missing"
}

HTTP status code 200

Body

Media type: application/json

Type: object

• title: (string)

  Titel der Anzeige

• sort_title: (string)

  Sortiertitel

• sp_type: (string)

  Typ des Service Provider/Leistungsträgers

• sp_type_text: (string)

  Typ des Service Provider/Leistungsträgers (Text für Dashboard)

• format: (string)

  Format der Anzeige (Text)

• status: (string - default: none)

  Aktueller Status des Gastgebers (rot, gelb, grün)

• price: (number)

  Preis

• pdf_file: (string)

  Referenz auf generierte PDF-Datei (MongoId)

• internal_status: (one of 00_unchecked, 10_in_consultation, 20_approved)

  Interner Status für Dokumente, die eine Druckfreigabe bekommen haben.

• data: (object)

  Beliebige Daten als Schlüssel-Wert-Paare oder Unterdokumente erstellt (auch Arrays, u.ä. möglich).

  Example:

  {
    "baskets": 1,
    "features": [ "XP1", "AXZ", "991" ],
    "sub_title": "Das Beste am Robbenstrand"
  }
  

• address: (object)

  Adressdaten - Kopie vom Gastgeber beim erstellen

  • street: (string)
  • zip: (string)
  • city: (string)
  • phone: (string)
  • fax: (string)
  • email: (string)
  • web: (string)
  • contact_person: (string)
• payment: (object)

  Rechnungsanschrift - Kopie vom Gastgeber beim erstellen

  • title: (string)
  • salutation: (string)
  • first_name: (string)
  • last_name: (string)
  • street: (string)
  • zip: (string)
  • city: (string)
• _id: required(string)

  UUID (v4)

  Example:

  960c927b-5582-4af0-a771-6f7cbf79ad23

• principal_id: required(string)

  Mandanten-Id

  Example:

  960c927b-5582-4af0-a771-6f7cbf79ad23

• service_provider_id: required(string)

  Gastgeber-Id

  Example:

  960c927b-5582-4af0-a771-6f7cbf79ad23

• season_id: required(string)

  Saison-Referenz

  Example:

  960c927b-5582-4af0-a771-6f7cbf79ad23

• title_ascii: (string)

  ASCII-Repräsentation des Titels (zum Sortieren nach Wörterbuch)

• sort_title_ascii: (string)

  ASCII-Sortiertitel (zum Sortieren nach Wörterbuch)

• current_step: required(number)

  Aktueller Schritt

• print_approval: required(boolean)

  Druckfreigabe erteilt?

• created: required(datetime)

  Datumsformat (RFC3339)

  Example:

  2016-02-28T16:41:41.090Z

• changed: required(datetime)

  Datumsformat (RFC3339)

  Example:

  2016-02-28T16:41:41.090Z

Example:

{
  "_id": "78bab0ca-7233-43da-b4f8-d4c120547101",
  "principal_id": "b60b707c-1ce5-4b5d-95ac-6b5199e10b7b",
  "service_provider_id": "960c927b-5582-4af0-a771-6f7cbf79ad23",
  "season_id": "3543ee4f-8c0e-40d9-ace8-6f25cd6b3c9c",
  "sp_type": "0",
  "sp_type_string": "Pension",
  "format": "1/2 Seite, 3 Bilder",
  "price": 1099.99,
  "current_step": 3,
  "print_approval": true,
  "pdf_file": "5b85ff54102000d00005ab12",
  "address": {
    "street": "Gutweg 1",
    "zip": "4356",
    "city": "Gutwiesenberg",
    "phone": "+39-1234-456788",
    "fax": "+39-1234-456799",
    "email": "office@alpenchalet-gutewiese.at",
    "web": "http://www.alpenchalet-gutewiese.at",
    "contact_person": "Herr Müller"
  },
  "payment": {
    "title": "Unsere kleine Pension",
    "salutation": "Herr",
    "first_name": "Alfons",
    "last_name": "Müller",
    "street": "Gutweg 1",
    "zip": "4356",
    "city": "Gutwiesenberg"
  },
  "data": {
    "baskets": 1,
    "features": [ "XP1", "AXZ", "991" ],
    "sub_title": "Das Beste am Robbenstrand"
  }
}

HTTP status code 404

Resource nicht gefunden

Body

Media type: application/json

Type: any

Example:

{
  "error": "not_found"
}

HTTP status code 405

Fehlende oder fehlerhaft formatierte Daten übergeben.

Body

Media type: application/json

Type: any

Example:

{
  "error": "missing_or_malformed_data"
}

Secured by oauth_2_0

Headers

• Authorization: required(string)

  Authentifizierung erfolgt über Bearer-Token im HTTP-Header.

  Example:

  Authorization: Bearer eyJ0eXAiOiJKV1QiLCJh...

Query Parameters

• access_token: required(string)

  Alternative Methode, um ein JWT-Token zu übergeben. Nicht zusammen mit dem "Authorization"-Header verwenden!

HTTP status code 401

Token fehlt, ist abgelaufen oder nicht valide. Oder: Keine Berechtigung (s. Fehlermeldung im Response).

Body

Media type: application/json

Type: any

Example:

{
  "error": "token_missing"
}

HTTP status code 200

Body

Media type: application/json

Type: object

• title: (string)

  Titel der Anzeige

• sort_title: (string)

  Sortiertitel

• sp_type: (string)

  Typ des Service Provider/Leistungsträgers

• sp_type_text: (string)

  Typ des Service Provider/Leistungsträgers (Text für Dashboard)

• format: (string)

  Format der Anzeige (Text)

• status: (string - default: none)

  Aktueller Status des Gastgebers (rot, gelb, grün)

• price: (number)

  Preis

• pdf_file: (string)

  Referenz auf generierte PDF-Datei (MongoId)

• internal_status: (one of 00_unchecked, 10_in_consultation, 20_approved)

  Interner Status für Dokumente, die eine Druckfreigabe bekommen haben.

• data: (object)

  Beliebige Daten als Schlüssel-Wert-Paare oder Unterdokumente erstellt (auch Arrays, u.ä. möglich).

  Example:

  {
    "baskets": 1,
    "features": [ "XP1", "AXZ", "991" ],
    "sub_title": "Das Beste am Robbenstrand"
  }
  

• address: (object)

  Adressdaten - Kopie vom Gastgeber beim erstellen

  • street: (string)
  • zip: (string)
  • city: (string)
  • phone: (string)
  • fax: (string)
  • email: (string)
  • web: (string)
  • contact_person: (string)
• payment: (object)

  Rechnungsanschrift - Kopie vom Gastgeber beim erstellen

  • title: (string)
  • salutation: (string)
  • first_name: (string)
  • last_name: (string)
  • street: (string)
  • zip: (string)
  • city: (string)
• _id: required(string)

  UUID (v4)

  Example:

  960c927b-5582-4af0-a771-6f7cbf79ad23

• principal_id: required(string)

  Mandanten-Id

  Example:

  960c927b-5582-4af0-a771-6f7cbf79ad23

• service_provider_id: required(string)

  Gastgeber-Id

  Example:

  960c927b-5582-4af0-a771-6f7cbf79ad23

• season_id: required(string)

  Saison-Referenz

  Example:

  960c927b-5582-4af0-a771-6f7cbf79ad23

• title_ascii: (string)

  ASCII-Repräsentation des Titels (zum Sortieren nach Wörterbuch)

• sort_title_ascii: (string)

  ASCII-Sortiertitel (zum Sortieren nach Wörterbuch)

• current_step: required(number)

  Aktueller Schritt

• print_approval: required(boolean)

  Druckfreigabe erteilt?

• created: required(datetime)

  Datumsformat (RFC3339)

  Example:

  2016-02-28T16:41:41.090Z

• changed: required(datetime)

  Datumsformat (RFC3339)

  Example:

  2016-02-28T16:41:41.090Z

Example:

{
  "_id": "78bab0ca-7233-43da-b4f8-d4c120547101",
  "principal_id": "b60b707c-1ce5-4b5d-95ac-6b5199e10b7b",
  "service_provider_id": "960c927b-5582-4af0-a771-6f7cbf79ad23",
  "season_id": "3543ee4f-8c0e-40d9-ace8-6f25cd6b3c9c",
  "sp_type": "0",
  "sp_type_string": "Pension",
  "format": "1/2 Seite, 3 Bilder",
  "price": 1099.99,
  "current_step": 3,
  "print_approval": true,
  "pdf_file": "5b85ff54102000d00005ab12",
  "address": {
    "street": "Gutweg 1",
    "zip": "4356",
    "city": "Gutwiesenberg",
    "phone": "+39-1234-456788",
    "fax": "+39-1234-456799",
    "email": "office@alpenchalet-gutewiese.at",
    "web": "http://www.alpenchalet-gutewiese.at",
    "contact_person": "Herr Müller"
  },
  "payment": {
    "title": "Unsere kleine Pension",
    "salutation": "Herr",
    "first_name": "Alfons",
    "last_name": "Müller",
    "street": "Gutweg 1",
    "zip": "4356",
    "city": "Gutwiesenberg"
  },
  "data": {
    "baskets": 1,
    "features": [ "XP1", "AXZ", "991" ],
    "sub_title": "Das Beste am Robbenstrand"
  }
}

HTTP status code 404

Resource nicht gefunden

Body

Media type: application/json

Type: any

Example:

{
  "error": "not_found"
}

HTTP status code 405

Fehlende oder fehlerhaft formatierte Daten übergeben.

Body

Media type: application/json

Type: any

Example:

{
  "error": "missing_or_malformed_data"
}

Secured by oauth_2_0

Headers

• Authorization: required(string)

  Authentifizierung erfolgt über Bearer-Token im HTTP-Header.

  Example:

  Authorization: Bearer eyJ0eXAiOiJKV1QiLCJh...

Query Parameters

• access_token: required(string)

  Alternative Methode, um ein JWT-Token zu übergeben. Nicht zusammen mit dem "Authorization"-Header verwenden!

HTTP status code 401

Token fehlt, ist abgelaufen oder nicht valide. Oder: Keine Berechtigung (s. Fehlermeldung im Response).

Body

Media type: application/json

Type: any

Example:

{
  "error": "token_missing"
}

HTTP status code 200

Gibt das gelöschte Objekt zurück.

Body

Media type: application/json

Type: object

• title: (string)

  Titel der Anzeige

• sort_title: (string)

  Sortiertitel

• sp_type: (string)

  Typ des Service Provider/Leistungsträgers

• sp_type_text: (string)

  Typ des Service Provider/Leistungsträgers (Text für Dashboard)

• format: (string)

  Format der Anzeige (Text)

• status: (string - default: none)

  Aktueller Status des Gastgebers (rot, gelb, grün)

• price: (number)

  Preis

• pdf_file: (string)

  Referenz auf generierte PDF-Datei (MongoId)

• internal_status: (one of 00_unchecked, 10_in_consultation, 20_approved)

  Interner Status für Dokumente, die eine Druckfreigabe bekommen haben.

• data: (object)

  Beliebige Daten als Schlüssel-Wert-Paare oder Unterdokumente erstellt (auch Arrays, u.ä. möglich).

  Example:

  {
    "baskets": 1,
    "features": [ "XP1", "AXZ", "991" ],
    "sub_title": "Das Beste am Robbenstrand"
  }
  

• address: (object)

  Adressdaten - Kopie vom Gastgeber beim erstellen

  • street: (string)
  • zip: (string)
  • city: (string)
  • phone: (string)
  • fax: (string)
  • email: (string)
  • web: (string)
  • contact_person: (string)
• payment: (object)

  Rechnungsanschrift - Kopie vom Gastgeber beim erstellen

  • title: (string)
  • salutation: (string)
  • first_name: (string)
  • last_name: (string)
  • street: (string)
  • zip: (string)
  • city: (string)
• _id: required(string)

  UUID (v4)

  Example:

  960c927b-5582-4af0-a771-6f7cbf79ad23

• principal_id: required(string)

  Mandanten-Id

  Example:

  960c927b-5582-4af0-a771-6f7cbf79ad23

• service_provider_id: required(string)

  Gastgeber-Id

  Example:

  960c927b-5582-4af0-a771-6f7cbf79ad23

• season_id: required(string)

  Saison-Referenz

  Example:

  960c927b-5582-4af0-a771-6f7cbf79ad23

• title_ascii: (string)

  ASCII-Repräsentation des Titels (zum Sortieren nach Wörterbuch)

• sort_title_ascii: (string)

  ASCII-Sortiertitel (zum Sortieren nach Wörterbuch)

• current_step: required(number)

  Aktueller Schritt

• print_approval: required(boolean)

  Druckfreigabe erteilt?

• created: required(datetime)

  Datumsformat (RFC3339)

  Example:

  2016-02-28T16:41:41.090Z

• changed: required(datetime)

  Datumsformat (RFC3339)

  Example:

  2016-02-28T16:41:41.090Z

Example:

{
  "_id": "78bab0ca-7233-43da-b4f8-d4c120547101",
  "principal_id": "b60b707c-1ce5-4b5d-95ac-6b5199e10b7b",
  "service_provider_id": "960c927b-5582-4af0-a771-6f7cbf79ad23",
  "season_id": "3543ee4f-8c0e-40d9-ace8-6f25cd6b3c9c",
  "sp_type": "0",
  "sp_type_string": "Pension",
  "format": "1/2 Seite, 3 Bilder",
  "price": 1099.99,
  "current_step": 3,
  "print_approval": true,
  "pdf_file": "5b85ff54102000d00005ab12",
  "address": {
    "street": "Gutweg 1",
    "zip": "4356",
    "city": "Gutwiesenberg",
    "phone": "+39-1234-456788",
    "fax": "+39-1234-456799",
    "email": "office@alpenchalet-gutewiese.at",
    "web": "http://www.alpenchalet-gutewiese.at",
    "contact_person": "Herr Müller"
  },
  "payment": {
    "title": "Unsere kleine Pension",
    "salutation": "Herr",
    "first_name": "Alfons",
    "last_name": "Müller",
    "street": "Gutweg 1",
    "zip": "4356",
    "city": "Gutwiesenberg"
  },
  "data": {
    "baskets": 1,
    "features": [ "XP1", "AXZ", "991" ],
    "sub_title": "Das Beste am Robbenstrand"
  }
}

HTTP status code 404

Resource nicht gefunden

Body

Media type: application/json

Type: any

Example:

{
  "error": "not_found"
}

HTTP status code 405

Fehlende oder fehlerhaft formatierte Daten übergeben.

Body

Media type: application/json

Type: any

Example:

{
  "error": "missing_or_malformed_data"
}

Secured by oauth_2_0

Headers

• Authorization: required(string)

  Authentifizierung erfolgt über Bearer-Token im HTTP-Header.

  Example:

  Authorization: Bearer eyJ0eXAiOiJKV1QiLCJh...

Query Parameters

• access_token: required(string)

  Alternative Methode, um ein JWT-Token zu übergeben. Nicht zusammen mit dem "Authorization"-Header verwenden!

HTTP status code 401

Token fehlt, ist abgelaufen oder nicht valide. Oder: Keine Berechtigung (s. Fehlermeldung im Response).

Body

Media type: application/json

Type: any

Example:

{
  "error": "token_missing"
}

HTTP status code 200

Ok.

Body

Media type: application/json

Type: any

Example:

{
  "message": "ok"
}

Secured by oauth_2_0

Headers

• Authorization: required(string)

  Authentifizierung erfolgt über Bearer-Token im HTTP-Header.

  Example:

  Authorization: Bearer eyJ0eXAiOiJKV1QiLCJh...

Query Parameters

• access_token: required(string)

  Alternative Methode, um ein JWT-Token zu übergeben. Nicht zusammen mit dem "Authorization"-Header verwenden!

HTTP status code 401

Token fehlt, ist abgelaufen oder nicht valide. Oder: Keine Berechtigung (s. Fehlermeldung im Response).

Body

Media type: application/json

Type: any

Example:

{
  "error": "token_missing"
}

HTTP status code 200

Ok.

Body

Media type: application/json

Type: any

Example:

{
  "message": "ok"
}

Secured by oauth_2_0

Headers

• Authorization: required(string)

  Authentifizierung erfolgt über Bearer-Token im HTTP-Header.

  Example:

  Authorization: Bearer eyJ0eXAiOiJKV1QiLCJh...

Query Parameters

• access_token: required(string)

  Alternative Methode, um ein JWT-Token zu übergeben. Nicht zusammen mit dem "Authorization"-Header verwenden!

HTTP status code 401

Token fehlt, ist abgelaufen oder nicht valide. Oder: Keine Berechtigung (s. Fehlermeldung im Response).

Body

Media type: application/json

Type: any

Example:

{
  "error": "token_missing"
}

Secured by oauth_2_0

Headers

• Authorization: required(string)

  Authentifizierung erfolgt über Bearer-Token im HTTP-Header.

  Example:

  Authorization: Bearer eyJ0eXAiOiJKV1QiLCJh...

Query Parameters

• access_token: required(string)

  Alternative Methode, um ein JWT-Token zu übergeben. Nicht zusammen mit dem "Authorization"-Header verwenden!

HTTP status code 401

Token fehlt, ist abgelaufen oder nicht valide. Oder: Keine Berechtigung (s. Fehlermeldung im Response).

Body

Media type: application/json

Type: any

Example:

{
  "error": "token_missing"
}

Secured by oauth_2_0

Headers

• Authorization: required(string)

  Authentifizierung erfolgt über Bearer-Token im HTTP-Header.

  Example:

  Authorization: Bearer eyJ0eXAiOiJKV1QiLCJh...

Query Parameters

• access_token: required(string)

  Alternative Methode, um ein JWT-Token zu übergeben. Nicht zusammen mit dem "Authorization"-Header verwenden!

HTTP status code 401

Token fehlt, ist abgelaufen oder nicht valide. Oder: Keine Berechtigung (s. Fehlermeldung im Response).

Body

Media type: application/json

Type: any

Example:

{
  "error": "token_missing"
}

Secured by oauth_2_0

Headers

• Authorization: required(string)

  Authentifizierung erfolgt über Bearer-Token im HTTP-Header.

  Example:

  Authorization: Bearer eyJ0eXAiOiJKV1QiLCJh...

Query Parameters

• access_token: required(string)

  Alternative Methode, um ein JWT-Token zu übergeben. Nicht zusammen mit dem "Authorization"-Header verwenden!

HTTP status code 401

Token fehlt, ist abgelaufen oder nicht valide. Oder: Keine Berechtigung (s. Fehlermeldung im Response).

Body

Media type: application/json

Type: any

Example:

{
  "error": "token_missing"
}

HTTP status code 200

Body

Media type: application/json

Type: object

• _id: required(string)

  Mandanten-Id

  Example:

  960c927b-5582-4af0-a771-6f7cbf79ad23

• url: required(string)

  URL zum Anzeigenassistenten (vollständig!)

  Example:

  https://bremerhaven.eberl-online.de/

• sp_features: required(array of any)

  Beschreibung der Leistungsträger-Merkmale als JSON-Array

  Example:

  [
    {
      "type": "single",
      "option": "online_bookable",
      "label": "Online buchbar?"
    },
    {
      "type": "select",
      "label": "Sterne",
      "options": [
        { "option": "12345", "label": "P*" },
        { "option": "12346", "label": "P**" }
      ]
    },
    {
      "type": "checkboxes",
      "label": "Merkmale allgemein",
      "options": [
        { "option": "DCUSE", "label": "Haustiere willkommen" },
        { "option": "DJSDE", "label": "am Strand" }
      ]
    }
  ]
  

• sp_data_fields: required(object)

  Beschreibung der Felder für Leistungsträger

  Example:

  {
    "description": {
      "label": "Beschreibung",
      "form": "textarea",
      "required": false
    },
    "pics": {
      "label": "Bilder",
      "form": "images",
      "required": false
    }
  }
  

• sp_types: required(object)

  Touristic Types, Arten von Leistungsträgern

  Example:

  {
    "WBX00020010000100227": "Bauernhof/ Ferienhof",
    "WBX00020010000100220": "Ferienwohnung/ Ferienhaus"
  }
  

• export_config: required(array of any)

  Export-Konfiguration

  Example:

  [
    { "type": "filter", "selector": "feature", "query": "feature1",
      "subqueries": [
        { "type": "sorter", "sortfield": "address.zip", "direction": "asc" },
        { "type": "sorter", "sortfield": "title_ascii", "direction": "asc" }
      ]},
    { "type": "filter", "selector": "feature", "query": [ "feature2", "feature3" ],
      "subqueries": [
        { "type": "sorter", "sortfield": "address.zip", "direction": "asc" },
        { "type": "sorter", "sortfield": "title_ascii", "direction": "asc" }
      ]}
  ]
  

Example:

{
  "_id": "b60b707c-1ce5-4b5d-95ac-6b5199e10b7b",
  "url": "https://bremerhaven.eberl-online.de/",
  "sp_features": [
    {
      "type": "single",
      "option": "online_bookable",
      "label": "Online buchbar?"
    },
    {
      "type": "select",
      "label": "Sterne",
      "options": [
        {
          "option": "12345",
          "label": "P*"
        },
        {
          "option": "12346",
          "label": "P**"
        }
      ]
    },
    {
      "type": "checkboxes",
      "label": "Merkmale allgemein",
      "options": [
        {
          "option": "DCUSE",
          "label": "Haustiere willkommen"
        },
        {
          "option": "DJSDE",
          "label": "am Strand"
        }
      ]
    }
  ],
  "sp_data_fields": {
    "description": {
      "label": "Beschreibung",
      "form": "textarea",
      "required": false
    },
    "pics": {
      "label": "Bilder",
      "form": "images",
      "required": false
    }
  },
  "export_config": {
    "filename": "bremerhaven.zip",
    "pdf_file_parts": [
      "title_ascii"
    ],
    "pdf_file_parts_join": "-",
    "queries": [
      {
        "type": "definition",
        "name": "final_sort",
        "description": "Finale Sortierung der GG",
        "define": [
          {
            "type": "sorter",
            "selectors": [
              {
                "address+zip": "asc",
                "address+street": "asc"
              }
            ]
          }
        ]
      },
      {
        "type": "definition",
        "name": "main_sort",
        "description": "Hauptsortierung nach Hoteltyp",
        "define": [
          {
            "type": "filter",
            "selector": "sp_type",
            "query": "xHotel",
            "subqueries": "final_sort"
          },
          {
            "type": "filter",
            "selector": "sp_type",
            "query": "xJugendherberge",
            "subqueries": "final_sort"
          },
          {
            "type": "filter",
            "selector": "sp_type",
            "query": "xPension",
            "subqueries": "final_sort"
          },
          {
            "type": "filter",
            "selector": "sp_type",
            "query": "xFerienzimmer",
            "subqueries": "final_sort"
          },
          {
            "type": "filter",
            "selector": "sp_type",
            "query": "xFerienhaus",
            "subqueries": "final_sort"
          },
          {
            "type": "filter",
            "selector": "sp_type",
            "query": "xFewo",
            "subqueries": "final_sort"
          }
        ]
      },
      {
        "type": "filter",
        "selector": "address.city",
        "query": "^Bremerhaven",
        "regex": true,
        "subqueries": "main_sort"
      },
      {
        "type": "filter",
        "selector": "address.city",
        "query": "^((?!Bremerhaven).)",
        "regex": true,
        "subqueries": "main_sort"
      }
    ],
    "annotate_pdfs": {
      "embedFonts": [
        "Economica-Bold",
        "Economica-Regular"
      ],
      "texts": [
        {
          "type": "centeredFromTop",
          "text": "_I_",
          "top": 20.43,
          "left": 8.79,
          "leftMax": 28.63,
          "fontSize": 12.6,
          "font": "Economica-Bold",
          "colorRGB": [1, 1, 1]
        },
        {
          "type": "leftFromBottom",
          "text": "www.awc.de/_0I_",
          "left": 17.42995,
          "bottom": 20.4,
          "fontSize": 7,
          "font": "Economica-Regular",
          "colorRGB": [0.96, 0.51, 0.13]
        }
      ]
    }
  },
  "sp_types": {
    "WBX00020010000100227": "Bauernhof/ Ferienhof",
    "WBX00020010000100220": "Ferienwohnung/ Ferienhaus"
  }
}

HTTP status code 405

Fehlende oder fehlerhaft formatierte Daten übergeben.

Body

Media type: application/json

Type: any

Example:

{
  "error": "missing_or_malformed_data"
}

Secured by oauth_2_0

Headers

• Authorization: required(string)

  Authentifizierung erfolgt über Bearer-Token im HTTP-Header.

  Example:

  Authorization: Bearer eyJ0eXAiOiJKV1QiLCJh...

Query Parameters

• access_token: required(string)

  Alternative Methode, um ein JWT-Token zu übergeben. Nicht zusammen mit dem "Authorization"-Header verwenden!

HTTP status code 401

Token fehlt, ist abgelaufen oder nicht valide. Oder: Keine Berechtigung (s. Fehlermeldung im Response).

Body

Media type: application/json

Type: any

Example:

{
  "error": "token_missing"
}

HTTP status code 200

Body

Media type: application/json

Type: object

• _id: required(string)

  Mandanten-Id

  Example:

  960c927b-5582-4af0-a771-6f7cbf79ad23

• url: required(string)

  URL zum Anzeigenassistenten (vollständig!)

  Example:

  https://bremerhaven.eberl-online.de/

• sp_features: required(array of any)

  Beschreibung der Leistungsträger-Merkmale als JSON-Array

  Example:

  [
    {
      "type": "single",
      "option": "online_bookable",
      "label": "Online buchbar?"
    },
    {
      "type": "select",
      "label": "Sterne",
      "options": [
        { "option": "12345", "label": "P*" },
        { "option": "12346", "label": "P**" }
      ]
    },
    {
      "type": "checkboxes",
      "label": "Merkmale allgemein",
      "options": [
        { "option": "DCUSE", "label": "Haustiere willkommen" },
        { "option": "DJSDE", "label": "am Strand" }
      ]
    }
  ]
  

• sp_data_fields: required(object)

  Beschreibung der Felder für Leistungsträger

  Example:

  {
    "description": {
      "label": "Beschreibung",
      "form": "textarea",
      "required": false
    },
    "pics": {
      "label": "Bilder",
      "form": "images",
      "required": false
    }
  }
  

• sp_types: required(object)

  Touristic Types, Arten von Leistungsträgern

  Example:

  {
    "WBX00020010000100227": "Bauernhof/ Ferienhof",
    "WBX00020010000100220": "Ferienwohnung/ Ferienhaus"
  }
  

• export_config: required(array of any)

  Export-Konfiguration

  Example:

  [
    { "type": "filter", "selector": "feature", "query": "feature1",
      "subqueries": [
        { "type": "sorter", "sortfield": "address.zip", "direction": "asc" },
        { "type": "sorter", "sortfield": "title_ascii", "direction": "asc" }
      ]},
    { "type": "filter", "selector": "feature", "query": [ "feature2", "feature3" ],
      "subqueries": [
        { "type": "sorter", "sortfield": "address.zip", "direction": "asc" },
        { "type": "sorter", "sortfield": "title_ascii", "direction": "asc" }
      ]}
  ]
  

Example:

{
  "_id": "b60b707c-1ce5-4b5d-95ac-6b5199e10b7b",
  "url": "https://bremerhaven.eberl-online.de/",
  "sp_features": [
    {
      "type": "single",
      "option": "online_bookable",
      "label": "Online buchbar?"
    },
    {
      "type": "select",
      "label": "Sterne",
      "options": [
        {
          "option": "12345",
          "label": "P*"
        },
        {
          "option": "12346",
          "label": "P**"
        }
      ]
    },
    {
      "type": "checkboxes",
      "label": "Merkmale allgemein",
      "options": [
        {
          "option": "DCUSE",
          "label": "Haustiere willkommen"
        },
        {
          "option": "DJSDE",
          "label": "am Strand"
        }
      ]
    }
  ],
  "sp_data_fields": {
    "description": {
      "label": "Beschreibung",
      "form": "textarea",
      "required": false
    },
    "pics": {
      "label": "Bilder",
      "form": "images",
      "required": false
    }
  },
  "export_config": {
    "filename": "bremerhaven.zip",
    "pdf_file_parts": [
      "title_ascii"
    ],
    "pdf_file_parts_join": "-",
    "queries": [
      {
        "type": "definition",
        "name": "final_sort",
        "description": "Finale Sortierung der GG",
        "define": [
          {
            "type": "sorter",
            "selectors": [
              {
                "address+zip": "asc",
                "address+street": "asc"
              }
            ]
          }
        ]
      },
      {
        "type": "definition",
        "name": "main_sort",
        "description": "Hauptsortierung nach Hoteltyp",
        "define": [
          {
            "type": "filter",
            "selector": "sp_type",
            "query": "xHotel",
            "subqueries": "final_sort"
          },
          {
            "type": "filter",
            "selector": "sp_type",
            "query": "xJugendherberge",
            "subqueries": "final_sort"
          },
          {
            "type": "filter",
            "selector": "sp_type",
            "query": "xPension",
            "subqueries": "final_sort"
          },
          {
            "type": "filter",
            "selector": "sp_type",
            "query": "xFerienzimmer",
            "subqueries": "final_sort"
          },
          {
            "type": "filter",
            "selector": "sp_type",
            "query": "xFerienhaus",
            "subqueries": "final_sort"
          },
          {
            "type": "filter",
            "selector": "sp_type",
            "query": "xFewo",
            "subqueries": "final_sort"
          }
        ]
      },
      {
        "type": "filter",
        "selector": "address.city",
        "query": "^Bremerhaven",
        "regex": true,
        "subqueries": "main_sort"
      },
      {
        "type": "filter",
        "selector": "address.city",
        "query": "^((?!Bremerhaven).)",
        "regex": true,
        "subqueries": "main_sort"
      }
    ],
    "annotate_pdfs": {
      "embedFonts": [
        "Economica-Bold",
        "Economica-Regular"
      ],
      "texts": [
        {
          "type": "centeredFromTop",
          "text": "_I_",
          "top": 20.43,
          "left": 8.79,
          "leftMax": 28.63,
          "fontSize": 12.6,
          "font": "Economica-Bold",
          "colorRGB": [1, 1, 1]
        },
        {
          "type": "leftFromBottom",
          "text": "www.awc.de/_0I_",
          "left": 17.42995,
          "bottom": 20.4,
          "fontSize": 7,
          "font": "Economica-Regular",
          "colorRGB": [0.96, 0.51, 0.13]
        }
      ]
    }
  },
  "sp_types": {
    "WBX00020010000100227": "Bauernhof/ Ferienhof",
    "WBX00020010000100220": "Ferienwohnung/ Ferienhaus"
  }
}

HTTP status code 404

Resource nicht gefunden

Body

Media type: application/json

Type: any

Example:

{
  "error": "not_found"
}

HTTP status code 405

Fehlende oder fehlerhaft formatierte Daten übergeben.

Body

Media type: application/json

Type: any

Example:

{
  "error": "missing_or_malformed_data"
}

Secured by oauth_2_0

Headers

• Authorization: required(string)

  Authentifizierung erfolgt über Bearer-Token im HTTP-Header.

  Example:

  Authorization: Bearer eyJ0eXAiOiJKV1QiLCJh...

Query Parameters

• access_token: required(string)

  Alternative Methode, um ein JWT-Token zu übergeben. Nicht zusammen mit dem "Authorization"-Header verwenden!

HTTP status code 401

Token fehlt, ist abgelaufen oder nicht valide. Oder: Keine Berechtigung (s. Fehlermeldung im Response).

Body

Media type: application/json

Type: any

Example:

{
  "error": "token_missing"
}

HTTP status code 200

Body

Media type: application/json

Type: object

• _id: required(string)

  Mandanten-Id

  Example:

  960c927b-5582-4af0-a771-6f7cbf79ad23

• url: required(string)

  URL zum Anzeigenassistenten (vollständig!)

  Example:

  https://bremerhaven.eberl-online.de/

• sp_features: required(array of any)

  Beschreibung der Leistungsträger-Merkmale als JSON-Array

  Example:

  [
    {
      "type": "single",
      "option": "online_bookable",
      "label": "Online buchbar?"
    },
    {
      "type": "select",
      "label": "Sterne",
      "options": [
        { "option": "12345", "label": "P*" },
        { "option": "12346", "label": "P**" }
      ]
    },
    {
      "type": "checkboxes",
      "label": "Merkmale allgemein",
      "options": [
        { "option": "DCUSE", "label": "Haustiere willkommen" },
        { "option": "DJSDE", "label": "am Strand" }
      ]
    }
  ]
  

• sp_data_fields: required(object)

  Beschreibung der Felder für Leistungsträger

  Example:

  {
    "description": {
      "label": "Beschreibung",
      "form": "textarea",
      "required": false
    },
    "pics": {
      "label": "Bilder",
      "form": "images",
      "required": false
    }
  }
  

• sp_types: required(object)

  Touristic Types, Arten von Leistungsträgern

  Example:

  {
    "WBX00020010000100227": "Bauernhof/ Ferienhof",
    "WBX00020010000100220": "Ferienwohnung/ Ferienhaus"
  }
  

• export_config: required(array of any)

  Export-Konfiguration

  Example:

  [
    { "type": "filter", "selector": "feature", "query": "feature1",
      "subqueries": [
        { "type": "sorter", "sortfield": "address.zip", "direction": "asc" },
        { "type": "sorter", "sortfield": "title_ascii", "direction": "asc" }
      ]},
    { "type": "filter", "selector": "feature", "query": [ "feature2", "feature3" ],
      "subqueries": [
        { "type": "sorter", "sortfield": "address.zip", "direction": "asc" },
        { "type": "sorter", "sortfield": "title_ascii", "direction": "asc" }
      ]}
  ]
  

Example:

{
  "_id": "b60b707c-1ce5-4b5d-95ac-6b5199e10b7b",
  "url": "https://bremerhaven.eberl-online.de/",
  "sp_features": [
    {
      "type": "single",
      "option": "online_bookable",
      "label": "Online buchbar?"
    },
    {
      "type": "select",
      "label": "Sterne",
      "options": [
        {
          "option": "12345",
          "label": "P*"
        },
        {
          "option": "12346",
          "label": "P**"
        }
      ]
    },
    {
      "type": "checkboxes",
      "label": "Merkmale allgemein",
      "options": [
        {
          "option": "DCUSE",
          "label": "Haustiere willkommen"
        },
        {
          "option": "DJSDE",
          "label": "am Strand"
        }
      ]
    }
  ],
  "sp_data_fields": {
    "description": {
      "label": "Beschreibung",
      "form": "textarea",
      "required": false
    },
    "pics": {
      "label": "Bilder",
      "form": "images",
      "required": false
    }
  },
  "export_config": {
    "filename": "bremerhaven.zip",
    "pdf_file_parts": [
      "title_ascii"
    ],
    "pdf_file_parts_join": "-",
    "queries": [
      {
        "type": "definition",
        "name": "final_sort",
        "description": "Finale Sortierung der GG",
        "define": [
          {
            "type": "sorter",
            "selectors": [
              {
                "address+zip": "asc",
                "address+street": "asc"
              }
            ]
          }
        ]
      },
      {
        "type": "definition",
        "name": "main_sort",
        "description": "Hauptsortierung nach Hoteltyp",
        "define": [
          {
            "type": "filter",
            "selector": "sp_type",
            "query": "xHotel",
            "subqueries": "final_sort"
          },
          {
            "type": "filter",
            "selector": "sp_type",
            "query": "xJugendherberge",
            "subqueries": "final_sort"
          },
          {
            "type": "filter",
            "selector": "sp_type",
            "query": "xPension",
            "subqueries": "final_sort"
          },
          {
            "type": "filter",
            "selector": "sp_type",
            "query": "xFerienzimmer",
            "subqueries": "final_sort"
          },
          {
            "type": "filter",
            "selector": "sp_type",
            "query": "xFerienhaus",
            "subqueries": "final_sort"
          },
          {
            "type": "filter",
            "selector": "sp_type",
            "query": "xFewo",
            "subqueries": "final_sort"
          }
        ]
      },
      {
        "type": "filter",
        "selector": "address.city",
        "query": "^Bremerhaven",
        "regex": true,
        "subqueries": "main_sort"
      },
      {
        "type": "filter",
        "selector": "address.city",
        "query": "^((?!Bremerhaven).)",
        "regex": true,
        "subqueries": "main_sort"
      }
    ],
    "annotate_pdfs": {
      "embedFonts": [
        "Economica-Bold",
        "Economica-Regular"
      ],
      "texts": [
        {
          "type": "centeredFromTop",
          "text": "_I_",
          "top": 20.43,
          "left": 8.79,
          "leftMax": 28.63,
          "fontSize": 12.6,
          "font": "Economica-Bold",
          "colorRGB": [1, 1, 1]
        },
        {
          "type": "leftFromBottom",
          "text": "www.awc.de/_0I_",
          "left": 17.42995,
          "bottom": 20.4,
          "fontSize": 7,
          "font": "Economica-Regular",
          "colorRGB": [0.96, 0.51, 0.13]
        }
      ]
    }
  },
  "sp_types": {
    "WBX00020010000100227": "Bauernhof/ Ferienhof",
    "WBX00020010000100220": "Ferienwohnung/ Ferienhaus"
  }
}

HTTP status code 404

Resource nicht gefunden

Body

Media type: application/json

Type: any

Example:

{
  "error": "not_found"
}

HTTP status code 405

Fehlende oder fehlerhaft formatierte Daten übergeben.

Body

Media type: application/json

Type: any

Example:

{
  "error": "missing_or_malformed_data"
}

Secured by oauth_2_0

Headers

• Authorization: required(string)

  Authentifizierung erfolgt über Bearer-Token im HTTP-Header.

  Example:

  Authorization: Bearer eyJ0eXAiOiJKV1QiLCJh...

Query Parameters

• access_token: required(string)

  Alternative Methode, um ein JWT-Token zu übergeben. Nicht zusammen mit dem "Authorization"-Header verwenden!

HTTP status code 401

Token fehlt, ist abgelaufen oder nicht valide. Oder: Keine Berechtigung (s. Fehlermeldung im Response).

Body

Media type: application/json

Type: any

Example:

{
  "error": "token_missing"
}

HTTP status code 200

Gibt das gelöschte Objekt zurück.

Body

Media type: application/json

Type: object

• _id: required(string)

  Mandanten-Id

  Example:

  960c927b-5582-4af0-a771-6f7cbf79ad23

• url: required(string)

  URL zum Anzeigenassistenten (vollständig!)

  Example:

  https://bremerhaven.eberl-online.de/

• sp_features: required(array of any)

  Beschreibung der Leistungsträger-Merkmale als JSON-Array

  Example:

  [
    {
      "type": "single",
      "option": "online_bookable",
      "label": "Online buchbar?"
    },
    {
      "type": "select",
      "label": "Sterne",
      "options": [
        { "option": "12345", "label": "P*" },
        { "option": "12346", "label": "P**" }
      ]
    },
    {
      "type": "checkboxes",
      "label": "Merkmale allgemein",
      "options": [
        { "option": "DCUSE", "label": "Haustiere willkommen" },
        { "option": "DJSDE", "label": "am Strand" }
      ]
    }
  ]
  

• sp_data_fields: required(object)

  Beschreibung der Felder für Leistungsträger

  Example:

  {
    "description": {
      "label": "Beschreibung",
      "form": "textarea",
      "required": false
    },
    "pics": {
      "label": "Bilder",
      "form": "images",
      "required": false
    }
  }
  

• sp_types: required(object)

  Touristic Types, Arten von Leistungsträgern

  Example:

  {
    "WBX00020010000100227": "Bauernhof/ Ferienhof",
    "WBX00020010000100220": "Ferienwohnung/ Ferienhaus"
  }
  

• export_config: required(array of any)

  Export-Konfiguration

  Example:

  [
    { "type": "filter", "selector": "feature", "query": "feature1",
      "subqueries": [
        { "type": "sorter", "sortfield": "address.zip", "direction": "asc" },
        { "type": "sorter", "sortfield": "title_ascii", "direction": "asc" }
      ]},
    { "type": "filter", "selector": "feature", "query": [ "feature2", "feature3" ],
      "subqueries": [
        { "type": "sorter", "sortfield": "address.zip", "direction": "asc" },
        { "type": "sorter", "sortfield": "title_ascii", "direction": "asc" }
      ]}
  ]
  

Example:

{
  "_id": "b60b707c-1ce5-4b5d-95ac-6b5199e10b7b",
  "url": "https://bremerhaven.eberl-online.de/",
  "sp_features": [
    {
      "type": "single",
      "option": "online_bookable",
      "label": "Online buchbar?"
    },
    {
      "type": "select",
      "label": "Sterne",
      "options": [
        {
          "option": "12345",
          "label": "P*"
        },
        {
          "option": "12346",
          "label": "P**"
        }
      ]
    },
    {
      "type": "checkboxes",
      "label": "Merkmale allgemein",
      "options": [
        {
          "option": "DCUSE",
          "label": "Haustiere willkommen"
        },
        {
          "option": "DJSDE",
          "label": "am Strand"
        }
      ]
    }
  ],
  "sp_data_fields": {
    "description": {
      "label": "Beschreibung",
      "form": "textarea",
      "required": false
    },
    "pics": {
      "label": "Bilder",
      "form": "images",
      "required": false
    }
  },
  "export_config": {
    "filename": "bremerhaven.zip",
    "pdf_file_parts": [
      "title_ascii"
    ],
    "pdf_file_parts_join": "-",
    "queries": [
      {
        "type": "definition",
        "name": "final_sort",
        "description": "Finale Sortierung der GG",
        "define": [
          {
            "type": "sorter",
            "selectors": [
              {
                "address+zip": "asc",
                "address+street": "asc"
              }
            ]
          }
        ]
      },
      {
        "type": "definition",
        "name": "main_sort",
        "description": "Hauptsortierung nach Hoteltyp",
        "define": [
          {
            "type": "filter",
            "selector": "sp_type",
            "query": "xHotel",
            "subqueries": "final_sort"
          },
          {
            "type": "filter",
            "selector": "sp_type",
            "query": "xJugendherberge",
            "subqueries": "final_sort"
          },
          {
            "type": "filter",
            "selector": "sp_type",
            "query": "xPension",
            "subqueries": "final_sort"
          },
          {
            "type": "filter",
            "selector": "sp_type",
            "query": "xFerienzimmer",
            "subqueries": "final_sort"
          },
          {
            "type": "filter",
            "selector": "sp_type",
            "query": "xFerienhaus",
            "subqueries": "final_sort"
          },
          {
            "type": "filter",
            "selector": "sp_type",
            "query": "xFewo",
            "subqueries": "final_sort"
          }
        ]
      },
      {
        "type": "filter",
        "selector": "address.city",
        "query": "^Bremerhaven",
        "regex": true,
        "subqueries": "main_sort"
      },
      {
        "type": "filter",
        "selector": "address.city",
        "query": "^((?!Bremerhaven).)",
        "regex": true,
        "subqueries": "main_sort"
      }
    ],
    "annotate_pdfs": {
      "embedFonts": [
        "Economica-Bold",
        "Economica-Regular"
      ],
      "texts": [
        {
          "type": "centeredFromTop",
          "text": "_I_",
          "top": 20.43,
          "left": 8.79,
          "leftMax": 28.63,
          "fontSize": 12.6,
          "font": "Economica-Bold",
          "colorRGB": [1, 1, 1]
        },
        {
          "type": "leftFromBottom",
          "text": "www.awc.de/_0I_",
          "left": 17.42995,
          "bottom": 20.4,
          "fontSize": 7,
          "font": "Economica-Regular",
          "colorRGB": [0.96, 0.51, 0.13]
        }
      ]
    }
  },
  "sp_types": {
    "WBX00020010000100227": "Bauernhof/ Ferienhof",
    "WBX00020010000100220": "Ferienwohnung/ Ferienhaus"
  }
}

HTTP status code 404

Resource nicht gefunden

Body

Media type: application/json

Type: any

Example:

{
  "error": "not_found"
}

HTTP status code 405

Fehlende oder fehlerhaft formatierte Daten übergeben.

Body

Media type: application/json

Type: any

Example:

{
  "error": "missing_or_malformed_data"
}

Secured by oauth_2_0

Headers

• Authorization: required(string)

  Authentifizierung erfolgt über Bearer-Token im HTTP-Header.

  Example:

  Authorization: Bearer eyJ0eXAiOiJKV1QiLCJh...

Query Parameters

• access_token: required(string)

  Alternative Methode, um ein JWT-Token zu übergeben. Nicht zusammen mit dem "Authorization"-Header verwenden!

HTTP status code 401

Token fehlt, ist abgelaufen oder nicht valide. Oder: Keine Berechtigung (s. Fehlermeldung im Response).

Body

Media type: application/json

Type: any

Example:

{
  "error": "token_missing"
}

HTTP status code 200

Body

Media type: application/json

Type: array of seasonBase

Items: season

Secured by oauth_2_0

Headers

• Authorization: required(string)

  Authentifizierung erfolgt über Bearer-Token im HTTP-Header.

  Example:

  Authorization: Bearer eyJ0eXAiOiJKV1QiLCJh...

Query Parameters

• access_token: required(string)

  Alternative Methode, um ein JWT-Token zu übergeben. Nicht zusammen mit dem "Authorization"-Header verwenden!

HTTP status code 401

Token fehlt, ist abgelaufen oder nicht valide. Oder: Keine Berechtigung (s. Fehlermeldung im Response).

Body

Media type: application/json

Type: any

Example:

{
  "error": "token_missing"
}

HTTP status code 200

Body

Media type: application/json

Type: object

• title: (string)
• is_current: (boolean - default: false)

  True, falls dieser Datensatz das aktuelle Jahr ist.

• is_last: (boolean - default: false)

  True, falls dieser Datensatz die letzte Saison ist (kann mehrfach gesetzt werden, z.B. letzte Sommersaison u.ä.).

• type: (string)

  Falls relevant, Typ der Saison (kann summer oder winter sein)

• principal_id: required(string)

  Mandanten-Id

  Example:

  960c927b-5582-4af0-a771-6f7cbf79ad23

• _id: required(string)

  UUID (v4)

  Example:

  960c927b-5582-4af0-a771-6f7cbf79ad23

• created: required(datetime)

  Datumsformat (RFC3339)

  Example:

  2016-02-28T16:41:41.090Z

• changed: required(datetime)

  Datumsformat (RFC3339)

  Example:

  2016-02-28T16:41:41.090Z

Example:

{
  "principal_id": "b60b707c-1ce5-4b5d-95ac-6b5199e10b7b",
  "_id": "3543ee4f-8c0e-40d9-ace8-6f25cd6b3c9c",
  "title": "Sommer/Winter 2018",
  "is_current": true,
  "type": "summer",
  "created": "2016-02-28T16:41:41.090Z",
  "changed": "2016-02-28T16:41:41.090Z"
}

HTTP status code 405

Fehlende oder fehlerhaft formatierte Daten übergeben.

Body

Media type: application/json

Type: any

Example:

{
  "error": "missing_or_malformed_data"
}

Secured by oauth_2_0

Headers

• Authorization: required(string)

  Authentifizierung erfolgt über Bearer-Token im HTTP-Header.

  Example:

  Authorization: Bearer eyJ0eXAiOiJKV1QiLCJh...

Query Parameters

• access_token: required(string)

  Alternative Methode, um ein JWT-Token zu übergeben. Nicht zusammen mit dem "Authorization"-Header verwenden!

HTTP status code 401

Token fehlt, ist abgelaufen oder nicht valide. Oder: Keine Berechtigung (s. Fehlermeldung im Response).

Body

Media type: application/json

Type: any

Example:

{
  "error": "token_missing"
}

HTTP status code 200

Body

Media type: application/json

Type: object

• title: (string)
• is_current: (boolean - default: false)

  True, falls dieser Datensatz das aktuelle Jahr ist.

• is_last: (boolean - default: false)

  True, falls dieser Datensatz die letzte Saison ist (kann mehrfach gesetzt werden, z.B. letzte Sommersaison u.ä.).

• type: (string)

  Falls relevant, Typ der Saison (kann summer oder winter sein)

• principal_id: required(string)

  Mandanten-Id

  Example:

  960c927b-5582-4af0-a771-6f7cbf79ad23

• _id: required(string)

  UUID (v4)

  Example:

  960c927b-5582-4af0-a771-6f7cbf79ad23

• created: required(datetime)

  Datumsformat (RFC3339)

  Example:

  2016-02-28T16:41:41.090Z

• changed: required(datetime)

  Datumsformat (RFC3339)

  Example:

  2016-02-28T16:41:41.090Z

Example:

{
  "principal_id": "b60b707c-1ce5-4b5d-95ac-6b5199e10b7b",
  "_id": "3543ee4f-8c0e-40d9-ace8-6f25cd6b3c9c",
  "title": "Sommer/Winter 2018",
  "is_current": true,
  "type": "summer",
  "created": "2016-02-28T16:41:41.090Z",
  "changed": "2016-02-28T16:41:41.090Z"
}

HTTP status code 404

Resource nicht gefunden

Body

Media type: application/json

Type: any

Example:

{
  "error": "not_found"
}

HTTP status code 405

Fehlende oder fehlerhaft formatierte Daten übergeben.

Body

Media type: application/json

Type: any

Example:

{
  "error": "missing_or_malformed_data"
}

Secured by oauth_2_0

Headers

• Authorization: required(string)

  Authentifizierung erfolgt über Bearer-Token im HTTP-Header.

  Example:

  Authorization: Bearer eyJ0eXAiOiJKV1QiLCJh...

Query Parameters

• access_token: required(string)

  Alternative Methode, um ein JWT-Token zu übergeben. Nicht zusammen mit dem "Authorization"-Header verwenden!

HTTP status code 401

Token fehlt, ist abgelaufen oder nicht valide. Oder: Keine Berechtigung (s. Fehlermeldung im Response).

Body

Media type: application/json

Type: any

Example:

{
  "error": "token_missing"
}

HTTP status code 200

Body

Media type: application/json

Type: object

• title: (string)
• is_current: (boolean - default: false)

  True, falls dieser Datensatz das aktuelle Jahr ist.

• is_last: (boolean - default: false)

  True, falls dieser Datensatz die letzte Saison ist (kann mehrfach gesetzt werden, z.B. letzte Sommersaison u.ä.).

• type: (string)

  Falls relevant, Typ der Saison (kann summer oder winter sein)

• principal_id: required(string)

  Mandanten-Id

  Example:

  960c927b-5582-4af0-a771-6f7cbf79ad23

• _id: required(string)

  UUID (v4)

  Example:

  960c927b-5582-4af0-a771-6f7cbf79ad23

• created: required(datetime)

  Datumsformat (RFC3339)

  Example:

  2016-02-28T16:41:41.090Z

• changed: required(datetime)

  Datumsformat (RFC3339)

  Example:

  2016-02-28T16:41:41.090Z

Example:

{
  "principal_id": "b60b707c-1ce5-4b5d-95ac-6b5199e10b7b",
  "_id": "3543ee4f-8c0e-40d9-ace8-6f25cd6b3c9c",
  "title": "Sommer/Winter 2018",
  "is_current": true,
  "type": "summer",
  "created": "2016-02-28T16:41:41.090Z",
  "changed": "2016-02-28T16:41:41.090Z"
}

HTTP status code 404

Resource nicht gefunden

Body

Media type: application/json

Type: any

Example:

{
  "error": "not_found"
}

HTTP status code 405

Fehlende oder fehlerhaft formatierte Daten übergeben.

Body

Media type: application/json

Type: any

Example:

{
  "error": "missing_or_malformed_data"
}

Secured by oauth_2_0

Headers

• Authorization: required(string)

  Authentifizierung erfolgt über Bearer-Token im HTTP-Header.

  Example:

  Authorization: Bearer eyJ0eXAiOiJKV1QiLCJh...

Query Parameters

• access_token: required(string)

  Alternative Methode, um ein JWT-Token zu übergeben. Nicht zusammen mit dem "Authorization"-Header verwenden!

HTTP status code 401

Token fehlt, ist abgelaufen oder nicht valide. Oder: Keine Berechtigung (s. Fehlermeldung im Response).

Body

Media type: application/json

Type: any

Example:

{
  "error": "token_missing"
}

HTTP status code 200

Gibt das gelöschte Objekt zurück.

Body

Media type: application/json

Type: object

• title: (string)
• is_current: (boolean - default: false)

  True, falls dieser Datensatz das aktuelle Jahr ist.

• is_last: (boolean - default: false)

  True, falls dieser Datensatz die letzte Saison ist (kann mehrfach gesetzt werden, z.B. letzte Sommersaison u.ä.).

• type: (string)

  Falls relevant, Typ der Saison (kann summer oder winter sein)

• principal_id: required(string)

  Mandanten-Id

  Example:

  960c927b-5582-4af0-a771-6f7cbf79ad23

• _id: required(string)

  UUID (v4)

  Example:

  960c927b-5582-4af0-a771-6f7cbf79ad23

• created: required(datetime)

  Datumsformat (RFC3339)

  Example:

  2016-02-28T16:41:41.090Z

• changed: required(datetime)

  Datumsformat (RFC3339)

  Example:

  2016-02-28T16:41:41.090Z

Example:

{
  "principal_id": "b60b707c-1ce5-4b5d-95ac-6b5199e10b7b",
  "_id": "3543ee4f-8c0e-40d9-ace8-6f25cd6b3c9c",
  "title": "Sommer/Winter 2018",
  "is_current": true,
  "type": "summer",
  "created": "2016-02-28T16:41:41.090Z",
  "changed": "2016-02-28T16:41:41.090Z"
}

HTTP status code 404

Resource nicht gefunden

Body

Media type: application/json

Type: any

Example:

{
  "error": "not_found"
}

HTTP status code 405

Fehlende oder fehlerhaft formatierte Daten übergeben.

Body

Media type: application/json

Type: any

Example:

{
  "error": "missing_or_malformed_data"
}

Secured by oauth_2_0

Headers

• Authorization: required(string)

  Authentifizierung erfolgt über Bearer-Token im HTTP-Header.

  Example:

  Authorization: Bearer eyJ0eXAiOiJKV1QiLCJh...

Query Parameters

• access_token: required(string)

  Alternative Methode, um ein JWT-Token zu übergeben. Nicht zusammen mit dem "Authorization"-Header verwenden!

HTTP status code 401

Token fehlt, ist abgelaufen oder nicht valide. Oder: Keine Berechtigung (s. Fehlermeldung im Response).

Body

Media type: application/json

Type: any

Example:

{
  "error": "token_missing"
}

HTTP status code 200

Body

Media type: application/json

Type: object

• title: (string)
• is_current: (boolean - default: false)

  True, falls dieser Datensatz das aktuelle Jahr ist.

• is_last: (boolean - default: false)

  True, falls dieser Datensatz die letzte Saison ist (kann mehrfach gesetzt werden, z.B. letzte Sommersaison u.ä.).

• type: (string)

  Falls relevant, Typ der Saison (kann summer oder winter sein)

• principal_id: required(string)

  Mandanten-Id

  Example:

  960c927b-5582-4af0-a771-6f7cbf79ad23

• _id: required(string)

  UUID (v4)

  Example:

  960c927b-5582-4af0-a771-6f7cbf79ad23

• created: required(datetime)

  Datumsformat (RFC3339)

  Example:

  2016-02-28T16:41:41.090Z

• changed: required(datetime)

  Datumsformat (RFC3339)

  Example:

  2016-02-28T16:41:41.090Z

Example:

{
  "principal_id": "b60b707c-1ce5-4b5d-95ac-6b5199e10b7b",
  "_id": "3543ee4f-8c0e-40d9-ace8-6f25cd6b3c9c",
  "title": "Sommer/Winter 2018",
  "is_current": true,
  "type": "summer",
  "created": "2016-02-28T16:41:41.090Z",
  "changed": "2016-02-28T16:41:41.090Z"
}

HTTP status code 404

Resource nicht gefunden

Body

Media type: application/json

Type: any

Example:

{
  "error": "not_found"
}

HTTP status code 405

Fehlende oder fehlerhaft formatierte Daten übergeben.

Body

Media type: application/json

Type: any

Example:

{
  "error": "missing_or_malformed_data"
}

Secured by oauth_2_0

Headers

• Authorization: required(string)

  Authentifizierung erfolgt über Bearer-Token im HTTP-Header.

  Example:

  Authorization: Bearer eyJ0eXAiOiJKV1QiLCJh...

Query Parameters

• access_token: required(string)

  Alternative Methode, um ein JWT-Token zu übergeben. Nicht zusammen mit dem "Authorization"-Header verwenden!

HTTP status code 401

Token fehlt, ist abgelaufen oder nicht valide. Oder: Keine Berechtigung (s. Fehlermeldung im Response).

Body

Media type: application/json

Type: any

Example:

{
  "error": "token_missing"
}

HTTP status code 200

Body

Media type: application/json

Type: array of metadataGroupBase

Items: metadataGroup

Secured by oauth_2_0

Headers

• Authorization: required(string)

  Authentifizierung erfolgt über Bearer-Token im HTTP-Header.

  Example:

  Authorization: Bearer eyJ0eXAiOiJKV1QiLCJh...

Query Parameters

• access_token: required(string)

  Alternative Methode, um ein JWT-Token zu übergeben. Nicht zusammen mit dem "Authorization"-Header verwenden!

HTTP status code 401

Token fehlt, ist abgelaufen oder nicht valide. Oder: Keine Berechtigung (s. Fehlermeldung im Response).

Body

Media type: application/json

Type: any

Example:

{
  "error": "token_missing"
}

HTTP status code 200

Body

Media type: application/json

Type: object

• principal_id: required(string)

  Mandanten-Id

  Example:

  960c927b-5582-4af0-a771-6f7cbf79ad23

• title: required(string)
• key: required(string)

  Für diesen Mandanten eindeutiger Schlüssel für diese Metadatengruppe. Damit kann der Assisten eindeutig die Daten einer Gruppe bestimmen und abfragen.

• fields: required(object)

  Schema-Definition, welches Schlüssel-Werte definiert (s. auch Beispiel). Die Definition ist nur für das Dashboard relevant weil hier die Werte interpretiert und als Formularelemente erstellt werden müssen.

  Mögliche Werte für Key/Values + Optionen (erste Ebene = form):

  • input einzeiliger Text
  • type HTML5-Eingabeformat, z.B. number
  • textarea mehrzeiliger Text

  Allgemeine Optionen:

  • label Label/Titel im Formular
  • required Eingabe erforderlich?

  Example:

  {
    "title": {
      "label": "Titel",
      "form": "input",
      "required": true
    },
    "description": {
      "label": "Beschreibung",
      "form": "textarea",
      "required": false
    },
    "discount": {
      "label": "Rabatt",
      "form": "input",
      "required": true,
      "type": "number"
    }
  }
  

• sort_key: required(integer)

  Sortierschlüssel (kleiner kommt weiter oben)

• created: required(datetime)

  Datumsformat (RFC3339)

  Example:

  2016-02-28T16:41:41.090Z

• changed: required(datetime)

  Datumsformat (RFC3339)

  Example:

  2016-02-28T16:41:41.090Z

Example:

{
  "_id": "5b8d333567d038142f48998c",
  "key": "discounts",
  "principal_id": "b60b707c-1ce5-4b5d-95ac-6b5199e10b7b",
  "title": "Rabatte",
  "sort_key": 128,
  "fields": {
    "title": {
      "label": "Titel",
      "form": "input",
      "required": true
    },
    "description": {
      "label": "Beschreibung",
      "form": "textarea",
      "required": false
    },
    "discount": {
      "label": "Rabatt",
      "form": "input",
      "required": true,
      "type": "number"
    }
  },
  "created": "2016-02-28T16:41:41.090Z",
  "changed": "2016-02-28T16:41:41.090Z"
}

HTTP status code 405

Fehlende oder fehlerhaft formatierte Daten übergeben.

Body

Media type: application/json

Type: any

Example:

{
  "error": "missing_or_malformed_data"
}

HTTP status code 409

Rückgabe, falls ein Datensatz mit identischer principal_id + key-Kombination schon existiert (Duplikat).

Secured by oauth_2_0

Headers

• Authorization: required(string)

  Authentifizierung erfolgt über Bearer-Token im HTTP-Header.

  Example:

  Authorization: Bearer eyJ0eXAiOiJKV1QiLCJh...

Query Parameters

• access_token: required(string)

  Alternative Methode, um ein JWT-Token zu übergeben. Nicht zusammen mit dem "Authorization"-Header verwenden!

HTTP status code 401

Token fehlt, ist abgelaufen oder nicht valide. Oder: Keine Berechtigung (s. Fehlermeldung im Response).

Body

Media type: application/json

Type: any

Example:

{
  "error": "token_missing"
}

HTTP status code 200

Body

Media type: application/json

Type: object

• principal_id: required(string)

  Mandanten-Id

  Example:

  960c927b-5582-4af0-a771-6f7cbf79ad23

• title: required(string)
• key: required(string)

  Für diesen Mandanten eindeutiger Schlüssel für diese Metadatengruppe. Damit kann der Assisten eindeutig die Daten einer Gruppe bestimmen und abfragen.

• fields: required(object)

  Schema-Definition, welches Schlüssel-Werte definiert (s. auch Beispiel). Die Definition ist nur für das Dashboard relevant weil hier die Werte interpretiert und als Formularelemente erstellt werden müssen.

  Mögliche Werte für Key/Values + Optionen (erste Ebene = form):

  • input einzeiliger Text
  • type HTML5-Eingabeformat, z.B. number
  • textarea mehrzeiliger Text

  Allgemeine Optionen:

  • label Label/Titel im Formular
  • required Eingabe erforderlich?

  Example:

  {
    "title": {
      "label": "Titel",
      "form": "input",
      "required": true
    },
    "description": {
      "label": "Beschreibung",
      "form": "textarea",
      "required": false
    },
    "discount": {
      "label": "Rabatt",
      "form": "input",
      "required": true,
      "type": "number"
    }
  }
  

• sort_key: required(integer)

  Sortierschlüssel (kleiner kommt weiter oben)

• created: required(datetime)

  Datumsformat (RFC3339)

  Example:

  2016-02-28T16:41:41.090Z

• changed: required(datetime)

  Datumsformat (RFC3339)

  Example:

  2016-02-28T16:41:41.090Z

Example:

{
  "_id": "5b8d333567d038142f48998c",
  "key": "discounts",
  "principal_id": "b60b707c-1ce5-4b5d-95ac-6b5199e10b7b",
  "title": "Rabatte",
  "sort_key": 128,
  "fields": {
    "title": {
      "label": "Titel",
      "form": "input",
      "required": true
    },
    "description": {
      "label": "Beschreibung",
      "form": "textarea",
      "required": false
    },
    "discount": {
      "label": "Rabatt",
      "form": "input",
      "required": true,
      "type": "number"
    }
  },
  "created": "2016-02-28T16:41:41.090Z",
  "changed": "2016-02-28T16:41:41.090Z"
}

HTTP status code 404

Resource nicht gefunden

Body

Media type: application/json

Type: any

Example:

{
  "error": "not_found"
}

HTTP status code 405

Fehlende oder fehlerhaft formatierte Daten übergeben.

Body

Media type: application/json

Type: any

Example:

{
  "error": "missing_or_malformed_data"
}

Secured by oauth_2_0

Headers

• Authorization: required(string)

  Authentifizierung erfolgt über Bearer-Token im HTTP-Header.

  Example:

  Authorization: Bearer eyJ0eXAiOiJKV1QiLCJh...

Query Parameters

• access_token: required(string)

  Alternative Methode, um ein JWT-Token zu übergeben. Nicht zusammen mit dem "Authorization"-Header verwenden!

HTTP status code 401

Token fehlt, ist abgelaufen oder nicht valide. Oder: Keine Berechtigung (s. Fehlermeldung im Response).

Body

Media type: application/json

Type: any

Example:

{
  "error": "token_missing"
}

HTTP status code 200

Body

Media type: application/json

Type: object

• principal_id: required(string)

  Mandanten-Id

  Example:

  960c927b-5582-4af0-a771-6f7cbf79ad23

• title: required(string)
• key: required(string)

  Für diesen Mandanten eindeutiger Schlüssel für diese Metadatengruppe. Damit kann der Assisten eindeutig die Daten einer Gruppe bestimmen und abfragen.

• fields: required(object)

  Schema-Definition, welches Schlüssel-Werte definiert (s. auch Beispiel). Die Definition ist nur für das Dashboard relevant weil hier die Werte interpretiert und als Formularelemente erstellt werden müssen.

  Mögliche Werte für Key/Values + Optionen (erste Ebene = form):

  • input einzeiliger Text
  • type HTML5-Eingabeformat, z.B. number
  • textarea mehrzeiliger Text

  Allgemeine Optionen:

  • label Label/Titel im Formular
  • required Eingabe erforderlich?

  Example:

  {
    "title": {
      "label": "Titel",
      "form": "input",
      "required": true
    },
    "description": {
      "label": "Beschreibung",
      "form": "textarea",
      "required": false
    },
    "discount": {
      "label": "Rabatt",
      "form": "input",
      "required": true,
      "type": "number"
    }
  }
  

• sort_key: required(integer)

  Sortierschlüssel (kleiner kommt weiter oben)

• created: required(datetime)

  Datumsformat (RFC3339)

  Example:

  2016-02-28T16:41:41.090Z

• changed: required(datetime)

  Datumsformat (RFC3339)

  Example:

  2016-02-28T16:41:41.090Z

Example:

{
  "_id": "5b8d333567d038142f48998c",
  "key": "discounts",
  "principal_id": "b60b707c-1ce5-4b5d-95ac-6b5199e10b7b",
  "title": "Rabatte",
  "sort_key": 128,
  "fields": {
    "title": {
      "label": "Titel",
      "form": "input",
      "required": true
    },
    "description": {
      "label": "Beschreibung",
      "form": "textarea",
      "required": false
    },
    "discount": {
      "label": "Rabatt",
      "form": "input",
      "required": true,
      "type": "number"
    }
  },
  "created": "2016-02-28T16:41:41.090Z",
  "changed": "2016-02-28T16:41:41.090Z"
}

HTTP status code 404

Resource nicht gefunden

Body

Media type: application/json

Type: any

Example:

{
  "error": "not_found"
}

HTTP status code 405

Fehlende oder fehlerhaft formatierte Daten übergeben.

Body

Media type: application/json

Type: any

Example:

{
  "error": "missing_or_malformed_data"
}

Secured by oauth_2_0

Headers

• Authorization: required(string)

  Authentifizierung erfolgt über Bearer-Token im HTTP-Header.

  Example:

  Authorization: Bearer eyJ0eXAiOiJKV1QiLCJh...

Query Parameters

• access_token: required(string)

  Alternative Methode, um ein JWT-Token zu übergeben. Nicht zusammen mit dem "Authorization"-Header verwenden!

HTTP status code 401

Token fehlt, ist abgelaufen oder nicht valide. Oder: Keine Berechtigung (s. Fehlermeldung im Response).

Body

Media type: application/json

Type: any

Example:

{
  "error": "token_missing"
}

HTTP status code 200

Gibt das gelöschte Objekt zurück.

Body

Media type: application/json

Type: object

• principal_id: required(string)

  Mandanten-Id

  Example:

  960c927b-5582-4af0-a771-6f7cbf79ad23

• title: required(string)
• key: required(string)

  Für diesen Mandanten eindeutiger Schlüssel für diese Metadatengruppe. Damit kann der Assisten eindeutig die Daten einer Gruppe bestimmen und abfragen.

• fields: required(object)

  Schema-Definition, welches Schlüssel-Werte definiert (s. auch Beispiel). Die Definition ist nur für das Dashboard relevant weil hier die Werte interpretiert und als Formularelemente erstellt werden müssen.

  Mögliche Werte für Key/Values + Optionen (erste Ebene = form):

  • input einzeiliger Text
  • type HTML5-Eingabeformat, z.B. number
  • textarea mehrzeiliger Text

  Allgemeine Optionen:

  • label Label/Titel im Formular
  • required Eingabe erforderlich?

  Example:

  {
    "title": {
      "label": "Titel",
      "form": "input",
      "required": true
    },
    "description": {
      "label": "Beschreibung",
      "form": "textarea",
      "required": false
    },
    "discount": {
      "label": "Rabatt",
      "form": "input",
      "required": true,
      "type": "number"
    }
  }
  

• sort_key: required(integer)

  Sortierschlüssel (kleiner kommt weiter oben)

• created: required(datetime)

  Datumsformat (RFC3339)

  Example:

  2016-02-28T16:41:41.090Z

• changed: required(datetime)

  Datumsformat (RFC3339)

  Example:

  2016-02-28T16:41:41.090Z

Example:

{
  "_id": "5b8d333567d038142f48998c",
  "key": "discounts",
  "principal_id": "b60b707c-1ce5-4b5d-95ac-6b5199e10b7b",
  "title": "Rabatte",
  "sort_key": 128,
  "fields": {
    "title": {
      "label": "Titel",
      "form": "input",
      "required": true
    },
    "description": {
      "label": "Beschreibung",
      "form": "textarea",
      "required": false
    },
    "discount": {
      "label": "Rabatt",
      "form": "input",
      "required": true,
      "type": "number"
    }
  },
  "created": "2016-02-28T16:41:41.090Z",
  "changed": "2016-02-28T16:41:41.090Z"
}

HTTP status code 404

Resource nicht gefunden

Body

Media type: application/json

Type: any

Example:

{
  "error": "not_found"
}

HTTP status code 405

Fehlende oder fehlerhaft formatierte Daten übergeben.

Body

Media type: application/json

Type: any

Example:

{
  "error": "missing_or_malformed_data"
}

Secured by oauth_2_0

Headers

• Authorization: required(string)

  Authentifizierung erfolgt über Bearer-Token im HTTP-Header.

  Example:

  Authorization: Bearer eyJ0eXAiOiJKV1QiLCJh...

Query Parameters

• access_token: required(string)

  Alternative Methode, um ein JWT-Token zu übergeben. Nicht zusammen mit dem "Authorization"-Header verwenden!

HTTP status code 401

Token fehlt, ist abgelaufen oder nicht valide. Oder: Keine Berechtigung (s. Fehlermeldung im Response).

Body

Media type: application/json

Type: any

Example:

{
  "error": "token_missing"
}