Client relation type

list

request
GET /api/v2/general/client-relation-type/list HTTP/1.1
Parameter Description

name

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

pageable

Pageable description

response
{
  "content" : [ {
    "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" : true,
  "totalElements" : 3,
  "totalPages" : 1,
  "first" : true,
  "size" : 20,
  "number" : 0,
  "sort" : {
    "empty" : true,
    "sorted" : false,
    "unsorted" : true
  },
  "numberOfElements" : 3,
  "empty" : false
}
Table 584. response description
Path Type Description

name

String

client relation type name

deleted

Boolean

is client relation type deleted?

create

request
POST /api/v2/general/client-relation-type HTTP/1.1

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

name

String

client relation type name

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

deleted

Boolean

is client relation type deleted?

Must not be null

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

name

String

client relation type name

deleted

Boolean

is client relation type deleted?

get

request
GET /api/v2/general/client-relation-type?name=Test HTTP/1.1
Table 587. request description
Parameter Description

name

client relation type name

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

name

String

client relation type name

deleted

Boolean

is client relation type deleted?

update

request
PUT /api/v2/general/client-relation-type?name=Test HTTP/1.1

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

name

String

client relation type name

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

deleted

Boolean

is client relation type deleted?

Must not be null

Parameter Description

name

client relation type name

response
HTTP/1.1 200 OK

delete

request
DELETE /api/v2/general/client-relation-type?name=Test HTTP/1.1
Table 590. request description
Parameter Description

name

client relation type name

response
HTTP/1.1 200 OK