Ukázka dotazů

Nejlépe je si ukázat princip fungování zaslaných dotazů na příkladech

Číselníky

curl -X 'GET' \
  'https://clouderis.cz/api/workitems/statuses' \
  -H 'accept: application/json' \
  -H 'Api-Key: <YourKey>'
  
curl -X 'GET' \
  'https://clouderis.cz/api/workitems/statuses' \
  -H 'accept: application/json' \
  -H 'Api-Key: <YourKey>'
  
curl -X 'GET' \
  'https://clouderis.cz/api/offices' \
  -H 'accept: application/json' \
  -H 'Api-Key: <YourKey>'

Číselníky jsou dostupné pouze pro čtení a zatím pouze ty nejdůležitejší.

Nová zakázka se zakázníkem

curl -X 'POST' \
  'https://clouderis.cz/api/workitems' \
  -H 'accept: text/plain' \
  -H 'Api-Key: <YourKey>' \
  -H 'Content-Type: application/json-patch+json' \
  -d '{
  "customer": {
    "name": "Adam Novák",
    "ic": "2422552",
    "street": "Neexistujici 2434",
    "city": "Praha",
    "zipCode": 57012,
    "contacts": [
      {
        "firstName": "Adam",
        "lastName": "Novák",
        "email": "[e-mail]",
        "phone1": "420605123456"
      }
    ]
  },
  "office": {
    "name": "Elektrotechnika U Vlka"
  },
  "workItemStatus": {
    "caption": "Oprava - přijatá"
  },
  "workItemTypeId": "7",
  "customProperties": [
    {
      "name": "Motohodiny",
      "value": "34.5"
    }
  ],
  "dateOfEvidence": "2023-09-03T13:31:32.582Z",
  "dateOfReceipt": "2023-09-03T13:31:32.582Z",
  "acceptedPrice": 1500,
  "deadline": "2023-09-03T13:31:32.582Z",
  "title": "Zkusebni zakazka",
  "description": "Neco se mi porouchalo",
  "productDescription": "Popis produktu"
}'

Párování existujícíh číselníků (stavy, typy, zákazníci)

V příkladu můžete vidět, že nové zákazníka lze vytvořit poskytunutím objektu customer se všemi potřebnými údaji včetně kontaktu. Nicméně, pokud namísto objektu customer poskytnete identifikátor customerId (z dříve vytvořeného zákazníka) bude to fungovat také.

Zákazník, i když je specifikovaný skrze customer objekt se nejprve snaží napárovat na existujícího zákazníka v databázi, když se to nepovede, založí se nový. Párování zákazníka probíhá skrze IČO (existuje-li), pokud ne, pokusí se spárovat skrze kombinaci jména a ulice.

Další číselníky jako "office", "workItemStatus", "workItemType" se pak párují buď přes poskytunutá identifikátor (s "Id" příponou) nebo skrze "name" / "caption", které je poskytnuté v daném objektu. V příkladu je vidět použití obou způsobů.

Vlastní pole se pak mapují čistě skrze jejich jména.

Formátovací požadavky

Identifikátory

Většina používaných identifkátorů končí příponout "Id", momentálně jsou to číselné hodnoty, ale vždy odesílány jako text.

Není potřeba zasílat identifikátor a samotný objekt (např. customerId a customer) spolu, protože customerId bude mít vždy prioritu a objekt nebude brán v potaz.

Telefon

Telefon se odesílá jako textový řetězec o 12 číslech, kde první tři jsou rezervovány k předvolbě