6.5

Přístup k objednávkám

GET /api/buscases

Získání objednávek 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
caseTypeintBez zvoleného typu se zobrazí objednávky všech typů, ale pouze se základním výčtem atributů, které jsou obedné a součástí všech typů objednávek.
Pokud zvolíte konkrétní typ, zobrazený seznam bude obsahovat pouze objednávky daného typu ale výčet atributů bude kompletní.0

Příklad: /api/buscases?orderBy=modified&desc=true
Získá naposledy změněné objednávky všech typů.

Odpověď (application/json)

200 OK

Stránka se záznamy typu buscases.

{
  "items": [
    {
      "id": 370,
      "customer": 2168,
      "name": "Objednávka na výdejníky kávy",
      "totalPrice": 10500.00,
      /* ... */
    }
    /* ... */
  ]
}

POST /api/buscases

Vytvoření nové objednávky.

Požadavek (application/json)

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

Odpověď (application/json)

201 OK CREATED

Tělo odpovědi bude tatáž objednávka, 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/buscases/{id}

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

GET /api/buscases/247

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

Odpověď (application/json)

200 OK

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

404 NOT FOUND

Požadovaná objednávka v databázi neexistuje.

PUT /api/buscases/{id}

Aktualizace objednávky. Existující objednávka 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 objednávku.

Odpověď (application/json)

200 OK

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

PATCH /api/buscases/{id}

Aktualizace objednávky. Existující objednávka 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 objednávkou, ale stačí poslat jen ty údaje, které chcete změnit.

Příklad:

    PATCH /api/buscases/1210

    { "totalPrice": "15800" }

U objednávky s kódem 1210 dojde ke změně ceny bez DPH na 15 800,-

Odpověď (application/json)

200 OK

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

Práce se soubory /api/buscases/{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/buscases/{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).

Práce s položkami objednávky /api/buscases/{id}/buscaseitems

Popis volání API položky objednávky