7.1

Přístup ke komunikacím

GET /api/comm

Získání Komunikací z databáze.

Požadavek

Query parametrTypPopisVýchozí
positionintindex prvního záznamu, který má být vrácen (0 - první záznam)0
sizeintpočet záznamů (stránky), povolené maximum 100020
orderBystringúdaj, podle kterého mají být záznamy řazené-
descbooleanřazení je sestupné (descending)false

Příklad: /api/comm?orderBy=modified&desc=true
Získá naposledy změněné komunikace.

Odpověď (application/json)

200 OK

Stránka se záznamy typu comm.

{
  "items": [
    {
      "id": 370,
      "customer": 2168,
      "name": "Zavolat",
      "planContact": "2024-12-24"
      /* ... */
    }
    /* ... */
  ]
}

POST /api/comm

Vytvoření nové objednávky.

Požadavek (application/json)

Tělo požadavku musí být JSON objekt, reprezentující novou komunikaci. Neměl by obsahovat parametr id. ID bude nové komunikaci přiděleno při úspěšném zápisu.

Odpověď (application/json)

201 OK CREATED

Tělo odpovědi bude tatáž komunikace, ale už v podobě, jak byla zapsána do databáze a s přiděleným kódem.

V http hlavičce Location bude URL k získání komunikace v pozdějších dotazech.

400 BAD REQUEST

Zaslaný objekt neprošel validací a nemůže být zapsán do databáze. Tělo obsahuje standardní chybový JSON s popisem nalezených chyb.

GET /api/comm/{id}

Získání jednoho záznamu Komunikace s konkrétním ID. ID je v InTouch CRM celé číslo, takže požadavkem:

GET /api/comm/247

získáte komunikaci s kódem 247 (pokud taková existuje).

Odpověď (application/json)

200 OK

Tělo odpovědi bude komunikace s požadovaným ID.

404 NOT FOUND

Požadovaná komunikace v databázi neexistuje.

PUT /api/comm/{id}

Aktualizace komunikace. Existující komunikace s ID id bude přepsána daty v těle požadavku.

Požadavek (application/json)

Tělo požadavku musí být JSON objekt, reprezentující celý záznam komunikace s novými údaji komunikace.

Odpověď (application/json)

200 OK

Tělo odpovědi bude nová verze komunikace, jak ji systém zapsal do databáze.

400 BAD REQUEST

Zaslaný objekt neprošel validací a nemůže být zapsán do databáze. Tělo obsahuje standardní chybový JSON s popisem nalezených chyb.

404 NOT FOUND

Aktualizovaná komunikace v databázi neexistuje.

PATCH /api/comm/{id}

Aktualizace komunikace. Existující komunikace s ID id bude aktualizována pomocí dat v těle požadavku. Na rozdíl od předchozího volání metodou PUT nemusíte u metody PATCH zasílat kompletní JSON s komunikací, ale stačí poslat jen ty údaje, které chcete změnit.

Příklad:

    PATCH /api/comm/1210

    { "planContact": "2024-12-31" }

U komunikace s kódem 1210 dojde ke změně Plánování na 31.12.2024

Odpověď (application/json)

200 OK

Tělo odpovědi bude nová verze komunikace, jak ji systém zapsal do databáze.

400 BAD REQUEST

Zaslaný objekt neprošel validací a nemůže být zapsán do databáze. Tělo obsahuje standardní chybový JSON s popisem nalezených chyb.

404 NOT FOUND

Aktualizovaná komunikace v adresáři neexistuje.

Práce se soubory /api/comm/{id}/files

Popis volání API je shodný s používáním připojených souborů ke kontaktům (/api/parties/{id}/files).

Práce s poznámkami /api/comm/{id}/comments

Popis volání API je shodný s používáním připojených poznámek ke kontaktům (/api/parties/{id}/comments).