Přístup k položkám objednávky

K položkám objednávky se můžete dostat přes endpoint pod záznamem objednávky, což umožňuje získat položky, které jsou připojeny k dané objednávce.

Např.: /api/buscases/241/buscaseitems zpřístupňuje položky připojené k objednávce s kódem 241.

GET /api/buscases/{id}/buscaseitems

Získání položek objednávky z databáze.

Požadavek

Příklad: /api/buscases/{id}/buscaseitems?orderBy=modified&desc=true
Získá naposledy změněné položky.

Odpověď (application/json)

200 OK

Stránka se záznamy typu buscaseitems.

{
  "items": [
    {
      "id": 370,
      "enteredBy": "gregor",
      "title": "Dodávka margarínu",
      "locked": true,
      /* ... */
    }
    /* ... */
  ]
}

POST /api/buscases/{id}/buscaseitems

Vytvoření nové položky dané objednávky.

Požadavek (application/json)

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

Odpověď (application/json)

201 OK CREATED

Tělo odpovědi bude tatáž položka, 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í položky 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/buscases/{buscaseId}/buscaseitems/{id}

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

GET api/buscases/147/buscaseitems/2015

získáte položku s kódem 2015 (pokud taková existuje u objednávky s kódem 147).

Odpověď (application/json)

200 OK

Tělo odpovědi bude položka objednávky s požadovaným ID.

404 NOT FOUND

Požadovaná položka v databázi neexistuje.

PUT /api/buscases/{buscaseId}/buscaseitems/{id}

Aktualizace položky. Existující položka 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í položku.

Odpověď (application/json)

200 OK

Tělo odpovědi bude nová verze položky, 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á položka v databázi neexistuje.

PATCH /api/buscases/{buscaseId}/buscaseitems/{id}

Aktualizace položky objednávky. 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/buscases/147/buscaseitems/2015

    { "title": "Toto je nový název položky" }

U položky s kódem 2015 dojde ke změně textu.

Odpověď (application/json)

200 OK

Tělo odpovědi bude nová verze položky, 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á položka v adresáři neexistuje.