Práce s Avatarem
Avataru je logo nebo fotografie kontaktu. Lze k němu přistoupit přes endpoint kontaktu.
Např.: /api/parties/241/avatar zpřístupní avatara připojeného ke kontaktu s kódem 241. V dalším textu budeme používat URL <record_endpoint>/avatar pro přístup k avataru kontaktu.
Parametry objektu avatar
| Název | Typ | Popis |
|---|---|---|
party | int | Kód kontaktu ke kterému je avatar připojen |
contentType | string(80) | MIME typ dat (content type, např. text/plain) |
data | string | Obsah souboru v BASE64 kódování |
size | int | Velikost souboru - parametr pouze ke čtení |
GET <record_endpoint>/avatar
Získání obrázku.
| Query parametr | Typ | Popis | Výchozí |
|---|---|---|---|
json | boolean | příznak, jestli má API vrátit obrázek ve formátu JSON | false |
Odpověď (application/json)
200 OK
V těle odpovědi bude obsah souboru.
V případě parametru json bude obsahem JSON formát a obsah souboru v base64 kódováním.
{
"party": 370,
"url": "api/parties/370/avatar",
"data": *BASE64*,
"size": 57850,
"contentType": "image/png"
}
404 NOT FOUND
Daný kontak avatara nemá.
403 FORBIDDEN
Autentizovaný uživatel nemá dostatek práv, aby mohl číst daný kontakt.
PUT <record_endpoint>/avatar
Připojení nového obrázku nebo aktualizace stávajícího obrázku.
Požadavek (application/json)
Tělo požadavku musí být JSON objekt, reprezentující nového avatara.
Odpověď (application/json)
201 OK CREATED
Tělo odpovědi bude tentýž avatar zapsáný do databáze jen bez obsahu.
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.
DELETE <record_endpoint>/avatar
Smazání avatara
Odpověď (application/json)
200 OK
Avatar smazán z CRM
403 FORBIDDEN
Uživatel nemá práva zápisu k danému kontaktu
POST <record_endpoint>/avatar/upload?contentType=xxx
Připojení nového souboru k záznamu. Posílájí se přímo binární data
Parametr contentType určuje content type zasílaných dat
Povoleny jsou pouze soubory typu obrázek (contentType = image/*) a do maximální velikosti 512kB.