Přístup ke skladům

GET /api/stores

Získání skladů z databáze.

Požadavek

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

Odpověď (application/json)

200 OK

Stránka se záznamy typu store.

{
  "items": [
    {
      "id": 2,
      "subject": "Výdejní sklad Praha",
      "street": "Pražská 8",
      /* ... */
    }
    /* ... */
  ]
}

POST /api/stores

Vytvoření nového skladu.

Požadavek (application/json)

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

Odpověď (application/json)

201 OK CREATED

Tělo odpovědi bude tentýž sklad, ale už v podobě, jak byl zapsán do databáze a s přiděleným kódem.

V http hlavičce Location bude URL k získání skladu 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/stores/{id}

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

GET /api/stores/15

získáte sklad s kódem 15 (pokud taková existuje).

Odpověď (application/json)

200 OK

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

404 NOT FOUND

Požadovaný sklad v databázi neexistuje.

PUT /api/stores/{id}

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

Požadavek (application/json)

Tělo požadavku musí být JSON objekt, reprezentující nový sklad.

Odpověď (application/json)

200 OK

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

PATCH /api/stores/{id}

Aktualizace skladu. Existující sklad s ID id bude aktualizován 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/stores/15

    { "responsible": "omacka" }

U skladu s kódem 15 dojde ke změně vyřizujícího na "Františka Omáčky" (kód omacka v seznamu uživatelů).

Odpověď (application/json)

200 OK

Tělo odpovědi bude nová verze skladu, 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.