Miejsca w magazynie

Struktura danych JSON

Obiekt Place

  • id – (readonly) ID w bazie danych
  • name – nazwa miejsca
  • number – numer miejsca (max 15 znaków)
  • parentId – ID rodzica miejsca w magazynie, lub NULL gdy miejsce nadrzędne
  • fullName – (readonly) pełna nazwa (ścieżka) oddzielona znakami ’->’
  • fullNumber – (readonly) pełny numer (ścieżka) oddzielona znakami ’-’

Pobieranie wszystkich miejsc w magazynie

GET

/places

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

Pobieranie miejsca w magazynie

GET

/places

Parametry w ścieżce zapytania
  • id – ID miejsca
/places?id=10
Odpowiedź JSON
{
	"id": 10,
	"name": "Nazwa miejsca",
	"number": "2"
	"parentId": 5,
	"fullName": "Garaż->Nazwa miejsca",
	"fullNumber": "A-2"
}

Dodawanie miejsca w magazynie

POST

/places

Dane JSON w zapytaniu (body)

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

Dane odpowiedzi JSON

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

Edycja miejsca w magazynie

PUT

/places

Dane JSON w zapytaniu (body)

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

Dane odpowiedzi JSON

W odpowiedzi zwrócony zostanie obiekt Place.

Usuwanie miejsca w magazynie

DELETE

/places

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