Lenses brand

list

request
GET /api/v2/lenses/brands/list HTTP/1.1
Parameter Description

name

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

pageable

Pageable description
response
{
  "content" : [ {
    "name" : "A-ZONE",
    "deleted" : false
  }, {
    "name" : "AS",
    "deleted" : false
  }, {
    "name" : "AZ",
    "deleted" : false
  }, {
    "name" : "Access Easy A",
    "deleted" : false
  }, {
    "name" : "Access Easy B",
    "deleted" : false
  }, {
    "name" : "Access HD A",
    "deleted" : false
  }, {
    "name" : "Access HD B",
    "deleted" : false
  }, {
    "name" : "Acclimate",
    "deleted" : false
  }, {
    "name" : "Acclimates",
    "deleted" : false
  }, {
    "name" : "Acclimates II",
    "deleted" : false
  }, {
    "name" : "Activations",
    "deleted" : false
  }, {
    "name" : "Airwear",
    "deleted" : false
  }, {
    "name" : "Airwear Baby",
    "deleted" : false
  }, {
    "name" : "Airwear Junior",
    "deleted" : false
  }, {
    "name" : "Airwear Transitions",
    "deleted" : false
  }, {
    "name" : "Altolite",
    "deleted" : false
  }, {
    "name" : "Altolite (TINTABLE)",
    "deleted" : false
  }, {
    "name" : "Altolite Big",
    "deleted" : false
  }, {
    "name" : "Altolite Kids",
    "deleted" : false
  }, {
    "name" : "Anti-Fatigue",
    "deleted" : false
  } ],
  "pageable" : {
    "pageNumber" : 0,
    "pageSize" : 20,
    "sort" : {
      "empty" : true,
      "sorted" : false,
      "unsorted" : true
    },
    "offset" : 0,
    "paged" : true,
    "unpaged" : false
  },
  "last" : false,
  "totalElements" : 130,
  "totalPages" : 7,
  "first" : true,
  "size" : 20,
  "number" : 0,
  "sort" : {
    "empty" : true,
    "sorted" : false,
    "unsorted" : true
  },
  "numberOfElements" : 20,
  "empty" : false
}
Table 710. response description
Path Type Description

name

String

lenses brand name

deleted

Boolean

is lenses brand deleted?

create

request
POST /api/v2/lenses/brands HTTP/1.1

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

name

String

lenses brand name

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

deleted

Boolean

is lenses brand deleted?

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

name

String

lenses brand name

deleted

Boolean

is lenses brand deleted?

get

request
GET /api/v2/lenses/brands?name=Test HTTP/1.1
Table 713. request description
Parameter Description

name

lenses brand name
response
{
  "name" : "Test",
  "deleted" : false
}
Table 714. response description
Path Type Description

name

String

lenses brand name

deleted

Boolean

is lenses brand deleted?

update

request
PUT /api/v2/lenses/brands?name=Test HTTP/1.1

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

name

String

lenses brand name

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

deleted

Boolean

is lenses brand deleted?

Must not be null
Parameter Description

name

lenses brand name
response
HTTP/1.1 200 OK

delete

request
DELETE /api/v2/lenses/brands?name=Test HTTP/1.1
Table 716. request description
Parameter Description

name

lenses brand name
response
HTTP/1.1 200 OK

← Previous: Glasses type | ↑ Up: Optima2 API v.2 REST | Next: Lenses class →