Abrufen von Nachschlagewerken für das Operator-Formular

GET/api/crm/v2/operators.fieldsv2

operationId: operators.fields

Gibt Nachschlagewerte für das Operator-Formular zurück: Account-Benutzer zur Verknüpfung (firm_user_id), Berechtigungsstufen (permission), Zeitzonen (timezone) und den ISO-Code der Standardsprache des aktuellen Landes (default_language).

Autorisierung

api-token + language + role

Abfrageparameter

branch_idintegererforderlich

Beispiel: 8778

Antworten

object

statusstringerforderlich

Werte:successerror

Beispiel: success

dataobject

permissionobject (FilterEnum) erforderlich

Filter-Enum — flache Liste von Enumerationswerten

valuestring

Beispiel: example

typestringerforderlich

Beispiel: select

optionarray of string

modestring (FilterMode)

Wie das Interface den Filter verarbeitet; ein gewöhnlicher Filter hat kein mode.
force_shown — immer angezeigt, kann nicht ausgeblendet werden.
value_required — Einstiegspunkt in den Bereich: immer angezeigt, hat keinen leeren Wert (solange kein Wert ausgewählt ist, bleibt die Liste leer; es gibt keine „Alle“-Option), ein globales Zurücksetzen löscht ihn nicht.

Werte:force_shownvalue_required

Beispiel: value_required

account_idinteger

ID des Kontos der ausgewählten Filiale

Beispiel: 3922

firm_user_idobject

Benutzer des Kontos mit Flags zur Verknüpfung mit den Einstellungen des Operators und Kuriers

typestring

Beispiel: select

optionarray of object

valueinteger

Beispiel: 825

namestring

Beispiel: user@fs.pro

has_operator_settingsboolean

Beispiel: false

has_courier_settingsboolean

Beispiel: false

timezoneobject (FilterSelect)

valuestring

Beispiel: example

typestringerforderlich

Beispiel: select

optionarray of object

valuestringerforderlich

Beispiel: example

namestringerforderlich

Beispiel: All

modestring (FilterMode)

Werte:force_shownvalue_required

Beispiel: value_required

default_languagestring

Beispiel: ru

<?php $client = new \GuzzleHttp\Client(); $response = $client->request('GET', 'https://foodsoul.pro/api/crm/v2/operators.fields?branch_id=8778', [ 'headers' => [ 'Authorization' => 'Bearer fs_api_YOUR_TOKEN', 'language' => 'de', 'role' => 'partner', ], ]); $data = json_decode((string) $response->getBody(), true);

const response = await fetch("https://foodsoul.pro/api/crm/v2/operators.fields?branch_id=8778", { method: "GET", headers: { "Authorization": "Bearer fs_api_YOUR_TOKEN", "language": "de", "role": "partner" }, }) const data = await response.json()

import requests response = requests.request( "GET", "https://foodsoul.pro/api/crm/v2/operators.fields?branch_id=8778", headers={ "Authorization": "Bearer fs_api_YOUR_TOKEN", "language": "de", "role": "partner", }, ) data = response.json()

{ "status": "success", "data": { "permission": { "value": "example", "type": "select", "option": [ "string" ], "mode": "value_required" }, "account_id": 3922, "firm_user_id": { "type": "select", "option": [ { "value": 825, "name": "user@fs.pro", "has_operator_settings": false, "has_courier_settings": false } ] }, "timezone": { "value": "example", "type": "select", "option": [ { "value": "example", "name": "All" } ], "mode": "value_required" }, "default_language": "ru" } }