Veröffentlichen oder Ausblenden eines Bezirks

POST/api/crm/v2/districts.toggle_publish_statusv2

operationId: districts.togglePublishStatus

Veröffentlicht oder verbirgt einen Bezirk. Dies ist dasselbe Flag wie das Augensymbol in der Bezirksliste und der Menüpunkt „Ausblenden“ im Bezirksmenü. Ein ausgeblendeter Bezirk verschwindet von der Karte und aus der Legende, bleibt jedoch in der Liste und in Dropdown-Menüs sichtbar.

Autorisierung

api-token + language + role

Abfrageparameter

branch_idintegererforderlich

Beispiel: 1

Anfragetext `application/json`

object

idintegererforderlich

Beispiel: 1

activebooleanerforderlich

Beispiel: true

Antworten

object (Response)

statusstringerforderlich

Werte:successerror

Beispiel: success

Eine der Optionen

object

Fehlerinformationen

errorobjecterforderlich

codeintegererforderlich

Fehlercode

variablesobject

descriptionstringerforderlich

Fehlerbeschreibung

object

Datenarray (Struktur abhängig von der Aktion, siehe Beispiele)

dataobjecterforderlich

curl -X POST 'https://foodsoul.pro/api/crm/v2/districts.toggle_publish_status?branch_id=1' \
  -H 'Authorization: Bearer fs_api_YOUR_TOKEN' \
  -H 'language: de' \
  -H 'role: partner' \
  -H 'Content-Type: application/json' \
  -d '{"id":1,"active":true}'

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://foodsoul.pro/api/crm/v2/districts.toggle_publish_status?branch_id=1', [
    'headers' => [
        'Authorization' => 'Bearer fs_api_YOUR_TOKEN',
        'language' => 'de',
        'role' => 'partner',
    ],
    'json' => [
        'id' => 1,
        'active' => true,
    ],
]);

$data = json_decode((string) $response->getBody(), true);

const response = await fetch("https://foodsoul.pro/api/crm/v2/districts.toggle_publish_status?branch_id=1", {
    method: "POST",
    headers: {
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "de",
        "role": "partner",
        "Content-Type": "application/json"
    },
    body: JSON.stringify({
        "id": 1,
        "active": true
    }),
})
const data = await response.json()

import requests

response = requests.request(
    "POST",
    "https://foodsoul.pro/api/crm/v2/districts.toggle_publish_status?branch_id=1",
    headers={
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "de",
        "role": "partner",
    },
    json={
        "id": 1,
        "active": True,
    },
)
data = response.json()

Antwort 200

{
  "error": {
    "code": 0,
    "variables": {},
    "description": "string"
  }
}

Anfragen werden an foodsoul.pro gesendet – dies ist der Host dieses Portals, ein anderer kann nicht ausgewählt werden.

Veröffentlichen oder Ausblenden eines Bezirks

Autorisierung

Abfrageparameter

Anfragetext application/json

Antworten

Anfragetext `application/json`