Glasses color

list

request
GET /api/v2/glasses/colors/list HTTP/1.1
Parameter Description

name

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

pageable

Pageable description
response
{
  "content" : [ {
    "name" : "001",
    "deleted" : false
  }, {
    "name" : "002",
    "deleted" : false
  }, {
    "name" : "003",
    "deleted" : false
  }, {
    "name" : "004",
    "deleted" : false
  }, {
    "name" : "005",
    "deleted" : false
  }, {
    "name" : "006",
    "deleted" : false
  }, {
    "name" : "007",
    "deleted" : false
  }, {
    "name" : "008",
    "deleted" : false
  }, {
    "name" : "009",
    "deleted" : false
  }, {
    "name" : "010",
    "deleted" : false
  }, {
    "name" : "011",
    "deleted" : false
  }, {
    "name" : "012",
    "deleted" : false
  }, {
    "name" : "07",
    "deleted" : false
  }, {
    "name" : "07P",
    "deleted" : false
  }, {
    "name" : "08",
    "deleted" : false
  }, {
    "name" : "08P",
    "deleted" : false
  }, {
    "name" : "09Pk",
    "deleted" : false
  }, {
    "name" : "13P",
    "deleted" : false
  }, {
    "name" : "17",
    "deleted" : false
  }, {
    "name" : "17P",
    "deleted" : false
  } ],
  "pageable" : {
    "pageNumber" : 0,
    "pageSize" : 20,
    "sort" : {
      "empty" : true,
      "sorted" : false,
      "unsorted" : true
    },
    "offset" : 0,
    "paged" : true,
    "unpaged" : false
  },
  "last" : false,
  "totalElements" : 160,
  "totalPages" : 8,
  "first" : true,
  "size" : 20,
  "number" : 0,
  "sort" : {
    "empty" : true,
    "sorted" : false,
    "unsorted" : true
  },
  "numberOfElements" : 20,
  "empty" : false
}
Table 654. response description
Path Type Description

name

String

glasses color name

deleted

Boolean

is glasses color deleted?

create

request
POST /api/v2/glasses/colors HTTP/1.1

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

name

String

glasses color name

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

deleted

Boolean

is glasses color deleted?

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

name

String

glasses color name

deleted

Boolean

is glasses color deleted?

get

request
GET /api/v2/glasses/colors?name=Test HTTP/1.1
Table 657. request description
Parameter Description

name

glasses color name
response
{
  "name" : "Test",
  "deleted" : false
}
Table 658. response description
Path Type Description

name

String

glasses color name

deleted

Boolean

is glasses color deleted?

update

request
PUT /api/v2/glasses/colors?name=Test HTTP/1.1

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

name

String

glasses color name

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

deleted

Boolean

is glasses color deleted?

Must not be null
Parameter Description

name

glasses color name
response
HTTP/1.1 200 OK

delete

request
DELETE /api/v2/glasses/colors?name=Test HTTP/1.1
Table 660. request description
Parameter Description

name

glasses color name
response
HTTP/1.1 200 OK

← Previous: Glasses brand | ↑ Up: Optima2 API v.2 REST | Next: Glasses design →