Optima2 API v.2 REST

list

request

GET /api/v2/catalog/cities 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

[ "", "California", "DefinitelyNewCity", "Springfield", "test", "Милан", "Москва", "Порхов", "Псков", "Санкт-Петербург", "Санкт-Петерубрг", "Сыктывкар", "Тула" ]

Table 600. response description
Path	Type	Description
`[]`	`Array`	Available cities for using in forms.

create

request

POST /api/v2/general/cities HTTP/1.1

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

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

response

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

Table 602. response description
Path	Type	Description
`name`	`String`	city name
`deleted`	`Boolean`	is city deleted?

get

request

GET /api/v2/general/cities?name=Test HTTP/1.1

Table 603. request description
Parameter	Description
`name`	city name

response

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

Table 604. response description
Path	Type	Description
`name`	`String`	city name
`deleted`	`Boolean`	is city deleted?

update

request

PUT /api/v2/general/cities?name=Test HTTP/1.1

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

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

Parameter Description

name

city name

response

HTTP/1.1 200 OK

delete

request

DELETE /api/v2/general/cities?name=Test HTTP/1.1

Table 606. request description
Parameter	Description
`name`	city name

response

HTTP/1.1 200 OK