Prostory

Poznámky
Pro experty
Klíč API by měl být odeslán jako token Bearer v hlavičce Authorization požadavku. Získejte klíč API.
Seznam

Koncový bod API:

GET 
https://sqzr.cz/api/v1/spaces

Příklad žádosti: 

curl --location --request GET 'https://sqzr.cz/api/v1/spaces' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Parametr
Typ
Popis
search
volitelné string
Vyhledávací dotaz.
search_by
volitelné string
Hledat dle. Možné hodnoty jsou: name pro Název / Jméno. Výchozí hodnota: name.
sort_by
volitelné string
Řadit dle. Možné hodnoty jsou: id pro Vytvořeno, name pro Název / Jméno. Výchozí hodnota: id.
sort
volitelné string
Třídit. Možné hodnoty jsou: desc pro Sestupně, asc pro Vzestupně. Výchozí hodnota: desc.
per_page
volitelné integer
Výsledků na stránku. Možné hodnoty jsou: 10, 25, 50, 100. Výchozí hodnota: 50.
Zobrazit

Koncový bod API:

GET 
https://sqzr.cz/api/v1/spaces/{id}

Příklad žádosti: 

curl --location --request GET 'https://sqzr.cz/api/v1/spaces/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Ukládat

Koncový bod API:

POST 
https://sqzr.cz/api/v1/spaces

Příklad žádosti: 

curl --location --request POST 'https://sqzr.cz/api/v1/spaces' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'name={name}'
Parametr
Typ
Popis
name
vyžadováno string
Název prostoru.
color
volitelné integer
Kód barvy. Možné hodnoty jsou: 1, 2, 3, 4, 5, 6. Výchozí hodnota: 1.
Aktualizovat

Koncový bod API:

PUT PATCH 
https://sqzr.cz/api/v1/spaces/{id}

Příklad žádosti: 

curl --location --request PUT 'https://sqzr.cz/api/v1/spaces/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}'
Parametr
Typ
Popis
name
volitelné string
Název prostoru.
color
volitelné integer
Kód barvy. Možné hodnoty jsou: 1, 2, 3, 4, 5, 6.
Odstranit

Koncový bod API:

DELETE 
https://sqzr.cz/api/v1/spaces/{id}

Příklad žádosti: 

curl --location --request DELETE 'https://sqzr.cz/api/v1/spaces/{id}' \
--header 'Authorization: Bearer {api_key}'