Accessory dictionary category

list

request
GET /api/v2/dictionary-accessories/categories/list HTTP/1.1
Parameter Description

name

String to search by name. EX: ?name=test

pageable

Pageable description
response
{
  "content" : [ {
    "name" : "Double  spaces test",
    "deleted" : false
  }, {
    "name" : "Брелок",
    "deleted" : false
  }, {
    "name" : "Готовые очки",
    "deleted" : false
  }, {
    "name" : "Диагностические полоски",
    "deleted" : false
  }, {
    "name" : "Диспенсер",
    "deleted" : false
  }, {
    "name" : "Дорожный набор",
    "deleted" : false
  }, {
    "name" : "Дорожный набор для МКЛ",
    "deleted" : false
  }, {
    "name" : "Емкость для промывки МКЛ",
    "deleted" : false
  }, {
    "name" : "Капли",
    "deleted" : false
  }, {
    "name" : "Клипса",
    "deleted" : false
  }, {
    "name" : "Контейнер",
    "deleted" : false
  }, {
    "name" : "Контейнер для МКЛ",
    "deleted" : false
  }, {
    "name" : "Лупа",
    "deleted" : false
  }, {
    "name" : "Набор",
    "deleted" : false
  }, {
    "name" : "Набор для МКЛ",
    "deleted" : false
  }, {
    "name" : "Набор отверток",
    "deleted" : false
  }, {
    "name" : "Окклюдер",
    "deleted" : false
  }, {
    "name" : "Очиститель энз",
    "deleted" : false
  }, {
    "name" : "Пинцет",
    "deleted" : false
  }, {
    "name" : "Пинцет-ножницы",
    "deleted" : false
  } ],
  "pageable" : {
    "pageNumber" : 0,
    "pageSize" : 20,
    "sort" : {
      "empty" : true,
      "sorted" : false,
      "unsorted" : true
    },
    "offset" : 0,
    "paged" : true,
    "unpaged" : false
  },
  "last" : false,
  "totalElements" : 35,
  "totalPages" : 2,
  "first" : true,
  "size" : 20,
  "number" : 0,
  "sort" : {
    "empty" : true,
    "sorted" : false,
    "unsorted" : true
  },
  "numberOfElements" : 20,
  "empty" : false
}
Table 408. response description
Path Type Description

name

String

accessory category name

deleted

Boolean

is accessory category deleted?

create

request
POST /api/v2/dictionary-accessories/categories HTTP/1.1

{
  "name" : "Test",
  "deleted" : false
}
Table 409. request description
Path Type Description Constraints

name

String

accessory category name

Must not be blank.
Size must be between 0 and 50 inclusive

deleted

Boolean

is accessory category deleted?

Must not be null
response
{
  "name" : "Test",
  "deleted" : false
}
Table 410. response description
Path Type Description

name

String

accessory category name

deleted

Boolean

is accessory category deleted?

get

request
GET /api/v2/dictionary-accessories/categories?name=Test HTTP/1.1
Table 411. request description
Parameter Description

name

accessory category name
response
{
  "name" : "Test",
  "deleted" : false
}
Table 412. response description
Path Type Description

name

String

accessory category name

deleted

Boolean

is accessory category deleted?

update

request
PUT /api/v2/dictionary-accessories/categories?name=Test HTTP/1.1

{
  "name" : "Test",
  "deleted" : false
}
Table 413. request description
Path Type Description Constraints

name

String

accessory category name

Must not be blank.
Size must be between 0 and 50 inclusive

deleted

Boolean

is accessory category deleted?

Must not be null
Parameter Description

name

accessory category name
response
HTTP/1.1 200 OK

delete

request
DELETE /api/v2/dictionary-accessories/categories?name=Test HTTP/1.1
Table 414. request description
Parameter Description

name

accessory category name
response
HTTP/1.1 200 OK

← Previous: Contact lenses nomenclature | ↑ Up: Optima2 API v.2 REST | Next: Accessory model →