Optima2 API v.2 REST

Contact lenses color

list

request

GET /api/v2/contact-lenses/colors/list HTTP/1.1

Parameter Description

Parameter	Description
`name`	String to search by name. EX: ?name=test
`pageable`	Pageable description

name

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

pageable

Pageable description

response

{
  "content" : [ {
    "name" : "Amethyst",
    "deleted" : false
  }, {
    "name" : "Aqua",
    "deleted" : false
  }, {
    "name" : "BLUE",
    "deleted" : false
  }, {
    "name" : "Black",
    "deleted" : false
  }, {
    "name" : "Black out",
    "deleted" : false
  }, {
    "name" : "Blue",
    "deleted" : false
  }, {
    "name" : "Brilliant Blue",
    "deleted" : false
  }, {
    "name" : "Browen",
    "deleted" : false
  }, {
    "name" : "Brown",
    "deleted" : false
  }, {
    "name" : "Caribbean Aqua",
    "deleted" : false
  }, {
    "name" : "GREEN",
    "deleted" : false
  }, {
    "name" : "Gemstone Green",
    "deleted" : false
  }, {
    "name" : "Gold",
    "deleted" : false
  }, {
    "name" : "Gray",
    "deleted" : false
  }, {
    "name" : "Green",
    "deleted" : false
  }, {
    "name" : "Hazel",
    "deleted" : false
  }, {
    "name" : "Pacific Blue",
    "deleted" : false
  }, {
    "name" : "Pure Gold",
    "deleted" : false
  }, {
    "name" : "Pure Hazel",
    "deleted" : false
  }, {
    "name" : "Sapphire",
    "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 431. response description
Path	Type	Description
`name`	`String`	contact lenses color name
`deleted`	`Boolean`	is contact lenses color deleted?

labels

request

GET /api/v2/contact-lenses/colors/labels HTTP/1.1

response

[ {
  "name" : "Amethyst",
  "deleted" : false
}, {
  "name" : "Aqua",
  "deleted" : false
}, {
  "name" : "BLUE",
  "deleted" : false
}, {
  "name" : "Black",
  "deleted" : false
}, {
  "name" : "Black out",
  "deleted" : false
}, {
  "name" : "Blue",
  "deleted" : false
}, {
  "name" : "Brilliant Blue",
  "deleted" : false
}, {
  "name" : "Browen",
  "deleted" : false
}, {
  "name" : "Brown",
  "deleted" : false
}, {
  "name" : "Caribbean Aqua",
  "deleted" : false
}, {
  "name" : "GREEN",
  "deleted" : false
}, {
  "name" : "Gemstone Green",
  "deleted" : false
}, {
  "name" : "Gold",
  "deleted" : false
}, {
  "name" : "Gray",
  "deleted" : false
}, {
  "name" : "Green",
  "deleted" : false
}, {
  "name" : "Hazel",
  "deleted" : false
}, {
  "name" : "Pacific Blue",
  "deleted" : false
}, {
  "name" : "Pure Gold",
  "deleted" : false
}, {
  "name" : "Pure Hazel",
  "deleted" : false
}, {
  "name" : "Sapphire",
  "deleted" : false
}, {
  "name" : "Sapphire Blue",
  "deleted" : false
}, {
  "name" : "Sea Green",
  "deleted" : false
}, {
  "name" : "Shimmer",
  "deleted" : false
}, {
  "name" : "Sparkle",
  "deleted" : false
}, {
  "name" : "Sterling Gray",
  "deleted" : false
}, {
  "name" : "Sterling Grey",
  "deleted" : false
}, {
  "name" : "TRUE SAPPHIRE",
  "deleted" : false
}, {
  "name" : "TURQUOISE",
  "deleted" : false
}, {
  "name" : "True Sapphire",
  "deleted" : false
}, {
  "name" : "True sapphire",
  "deleted" : false
}, {
  "name" : "Turquoise",
  "deleted" : false
}, {
  "name" : "Violet",
  "deleted" : false
}, {
  "name" : "~Aqua",
  "deleted" : false
}, {
  "name" : "~Blue",
  "deleted" : false
}, {
  "name" : "~Green",
  "deleted" : false
} ]

Table 432. response description
Path	Type	Description
`name`	`String`	contact lenses color name
`deleted`	`Boolean`	is contact lenses color deleted?

create

request

POST /api/v2/contact-lenses/colors HTTP/1.1

{
  "name" : "Test",
  "deleted" : false
}

Table 433. request description
Path	Type	Description	Constraints
name	String	contact lenses color name	Must not be blank. Size must be between 0 and 50 inclusive
deleted	Boolean	is contact lenses color deleted?	Must not be null

response

{
  "name" : "Test",
  "deleted" : false
}

Table 434. response description
Path	Type	Description
`name`	`String`	contact lenses color name
`deleted`	`Boolean`	is contact lenses color deleted?

get

request

GET /api/v2/contact-lenses/colors?name=Test HTTP/1.1

Table 435. request description
Parameter	Description
`name`	contact lenses color name

response

{
  "name" : "Test",
  "deleted" : false
}

Table 436. response description
Path	Type	Description
`name`	`String`	contact lenses color name
`deleted`	`Boolean`	is contact lenses color deleted?

update

request

PUT /api/v2/contact-lenses/colors?name=Test HTTP/1.1

{
  "name" : "Test",
  "deleted" : false
}

Table 437. request description
Path	Type	Description	Constraints
name	String	contact lenses color name	Must not be blank. Size must be between 0 and 50 inclusive
deleted	Boolean	is contact lenses color deleted?	Must not be null

Parameter Description

name

contact lenses color name

response

HTTP/1.1 200 OK

delete

request

DELETE /api/v2/contact-lenses/colors?name=Test HTTP/1.1

Table 438. request description
Parameter	Description
`name`	contact lenses color name

response

HTTP/1.1 200 OK