6.2

Přístup k příležitostem

GET /api/opportunities

Získání příležitostí 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/opportunities?orderBy=modified&desc=true
Získá naposledy změněné příležitosti.

Odpověď (application/json)

200 OK

Stránka se záznamy typu opportunity.

{
  "items": [
    {
      "id": 370,
      "customer": 2168,
      "name": "Výběrové řízení na výdejníky kávy",
      "stage": "apro",
      /* ... */
    }
    /* ... */
  ]
}

POST /api/opportunities

Vytvoření nové příležitosti.

Požadavek (application/json)

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

Odpověď (application/json)

201 OK CREATED

Tělo odpovědi bude tatáž příležitost, 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í příležitosti 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/opportunities/{id}

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

GET /api/opportunities/247

získáte příležitost s kódem 247 (pokud taková existuje).

Odpověď (application/json)

200 OK

Tělo odpovědi bude příležitost s požadovaným ID.

404 NOT FOUND

Požadovaná příležitost v databázi neexistuje.

PUT /api/opportunities/{id}

Aktualizace příležitosti. Existující příležitost 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í novou příležitost.

Odpověď (application/json)

200 OK

Tělo odpovědi bude nová verze příležitosti, 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á příležitost v adresáři neexistuje.

PATCH /api/opportunities/{id}

Aktualizace příležitosti. Existující příležitost 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 příležitostí, ale stačí poslat jen ty údaje, které chcete změnit.

Příklad:

    PATCH /api/opportunities/1210

    { "stage": "xxxf" }

U příležitosti s kódem 1210 dojde ke změně fáze na "Zmrazeno" (kód xxxf v číselníku).

Odpověď (application/json)

200 OK

Tělo odpovědi bude nová verze příležitosti, 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á příležitost v adresáři neexistuje.

Práce se soubory /api/opportunities/{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 s poznámkami /api/opportunities/{id}/notes

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