Avalda või peida piirkond

POST/api/crm/v2/districts.toggle_publish_statusv2

operationId: districts.togglePublishStatus

Avaldab või peidab piirkonna. See on sama lipp, mis silmaikoon piirkondade loendis ja menüüpunkt „Peida” piirkonna menüüs. Peidetud piirkond kaob kaardilt ja legendist, kuid jääb loendisse ja rippmenüüdesse.

Autoriseerimine

api-token + language + role

Päringu parameetrid

branch_idintegerkohustuslik

Näide: 1

Päringu keha `application/json`

object

idintegerkohustuslik

Näide: 1

activebooleankohustuslik

Näide: true

Vastused

object (Response)

statusstringkohustuslik

Väärtused:successerror

Näide: success

Üks variantidest

object

Teave vea kohta

errorobjectkohustuslik

codeintegerkohustuslik

Veakood

variablesobject

descriptionstringkohustuslik

Veakirjeldus

object

Andmete massiiv (struktuur sõltub toimingust, vt näiteid)

dataobjectkohustuslik

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: et' \
  -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' => 'et',
        '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": "et",
        "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": "et",
        "role": "partner",
    },
    json={
        "id": 1,
        "active": True,
    },
)
data = response.json()

Vastus 200

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

Päringud saadetakse aadressile foodsoul.pro — see on selle portaali host, teist valida ei saa.

Avalda või peida piirkond

Autoriseerimine

Päringu parameetrid

Päringu keha application/json

Vastused

Päringu keha `application/json`