Kategorie

Struktura danych JSON

Obiekt Category

  • id(readonly) ID w bazie danych
  • name – nazwa kategorii
  • number – numer kategorii (max 15 znaków)
  • parentId – ID rodzica kategorii, lub NULL gdy kategoria główna
  • fullName(readonly) pełna nazwa (ścieżka) oddzielona znakami ’->’
  • fullNumber – (readonly) pełny numer (ścieżka) oddzielona znakami ’-’

Pobieranie wszystkich kategorii

GET

/categories

Odpowiedź JSON - zawiera tablicę obiektów Category
{
    "categories": [
        ...
    ]
}

Pobieranie kategorii

GET

/categories

Parametry w ścieżce zapytania
  • id – ID kategorii
/categories?id=10
Odpowiedź JSON
{
    "id": 10,
    "name": "Nazwa kategorii",
    "number": "20"
    "parentId": 5,
    "fullName": "Kategoria glowna->Nazwa kategorii",
    "fullNumber": "2-20"
}

Dodawanie kategorii

POST

/categories

Dane JSON w zapytaniu (body)

Należy przekazać obiekt Category. Pola readonly są pomijane, nie trzeba ich przekazywać.

Dane odpowiedzi JSON

W odpowiedzi zwrócony zostanie nowo utworzony obiekt Category zawierający ID.

Edycja kategorii

PUT

/categories

Dane JSON w zapytaniu (body)

Należy przekazać pełny obiekt Category do edycji. Pole ID należy przekazać, reszta parametrów readonly jest ignorowana.

Dane odpowiedzi JSON

W odpowiedzi zwrócony zostanie obiekt Category.

Usuwanie kategorii

DELETE

/categories

Parametry w ścieżce zapytania
  • id – ID kategorii do usunięcia
/categories?id=1
Odpowiedź - 204 No Content