Přístup k poznámkám

K poznámkám uloženým v CRM se můžete dostat dvěma způsoby. Prvním je přístup přes globální koncový bod /api/comments, který umožňuje přistupovat k poznámkám nezávisle na tom, ke kterému záznamu jsou připojeny. Druhý způsob je přes endpoint pod jiným záznamem (příležitost, kontakt, apod.), což umožňuje získat poznámky, které jsou připojeny k nějakému záznamu v CRM.

Např.: /api/parties/241/comments zpřístupňuje poznámky připojené ke kontaktu s kódem 241. Obdobně /api/opportunities/1602/comments zpřísupňuje poznámky připojené k příležitosti s kódem 1602, atd. V dalším textu budeme používat URL <record_endpoint>/comments pro přístup k poznámkám, připojeným k záznamu adresovanému koncovým bodem <record_endpoint>.

Pokud za <record_endpoint> dosadíte koncový bod /api, budete přistupovat k poznámkám globálně.

GET <record_endpoint>/comments

Získání poznámek z databáze.

Požadavek

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

Odpověď (application/json)

200 OK

Stránka se záznamy typu comment.

{
  "items": [
    {
      "id": 370,
      "enteredBy": "gregor",
      "comment": "Je to totální <b>borec</b>. To se musí nechat.",
      "html": true,
      /* ... */
    }
    /* ... */
  ]
}

POST <record_endpoint>/comments

Vytvoření nové poznámky.

Požadavek (application/json)

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

Odpověď (application/json)

201 OK CREATED

Tělo odpovědi bude tatáž poznámka, 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í poznámky 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 <record_endpoint>/comments/{id}

Získání jedné poznámky s konkrétním ID. ID je v InTouch CRM celé číslo, takže požadavkem:

GET /api/comments/247

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

Odpověď (application/json)

200 OK

Tělo odpovědi bude poznámka s požadovaným ID.

404 NOT FOUND

Požadovaná poznámka v databázi neexistuje.

PUT <record_endpoint>/comments/{id}

Aktualizace poznámky. Existující poznámka 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í verzi poznámky.

Odpověď (application/json)

200 OK

Tělo odpovědi bude nová verze poznámky, 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á poznámka v databázi neexistuje.

PATCH <record_endpoint>/comments/{id}

Aktualizace poznámky. Existující poznámka 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 poznámkou, ale stačí poslat jen ty údaje, které chcete změnit.

Příklad:

    PATCH /api/comments/1144

    { "comment": "Toto je nový text poznámky" }

U poznámky s kódem 1144 dojde ke změně textu.

Odpověď (application/json)

200 OK

Tělo odpovědi bude nová verze poznámky, 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á poznámka v adresáři neexistuje.