GeoLocationServiceImpl

string

Идентификатор Spring bean, который содержит вызываемый сервис.geoLocationServiceImpl

string

по умолчанию:"PROTOTYPE"

Область действия bean. Для вызовов сервисов используется PROTOTYPE.

string

Имя публичного метода сервиса, указанное в сигнатуре ниже.

object[]

Массив аргументов метода. Каждый аргумент передаётся объектом с индексом 0, 1 и т. д.; значение должно соответствовать Java-типу параметра.

Headers

POST /api/v1/bean/request
Content-Type: application/json
Lang-Context: ru
Site-Context: my-site
Authorization: Bearer <token>

Заголовки Lang-Context и Site-Context необходимо передавать в каждом запросе. Для защищённых методов передавайте JWT в заголовке Authorization в формате Bearer <token>. Доступ: GUEST. Bearer Token: не требуется.

GUEST — без логина; доступен только whitelist.
USER — требуется авторизация; доступны методы с проверкой USER.
ADMIN — полный доступ к public-методам всех сервисов.
Если метод проверяет роль внутри логики, GUEST может получить null.

Методы

AddressRepository

Аргумент	Тип	Описание
—	—	Метод не принимает аргументы.

getAddressRepository

{
  "beanId": "geoLocationServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "getAddressRepository",
  "args": []
}

Deque<Map<String, Object>>

Аргумент	Тип	Описание
`requestJson`	`String`	Передаётся через `args[0].0`.

getPaginationFilter

{
  "beanId": "geoLocationServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "getPaginationFilter",
  "args": [
    {
      "0": null
    }
  ]
}

LinkedHashSet<Country>

Аргумент	Тип	Описание
`requestJson`	`String`	Передаётся через `args[0].0`.

searchCountries

{
  "beanId": "geoLocationServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "searchCountries",
  "args": [
    {
      "0": null
    }
  ]
}

Page<Country>

Аргумент	Тип	Описание
`requestJson`	`String`	Передаётся через `args[0].0`.

searchCountriesPaged

{
  "beanId": "geoLocationServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "searchCountriesPaged",
  "args": [
    {
      "0": null
    }
  ]
}

List<Address>

Аргумент	Тип	Описание
`query`	`String`	Передаётся через `args[0].0`.
`from`	`String`	Передаётся через `args[1].1`.
`to`	`String`	Передаётся через `args[2].2`.

searchAddresses

{
  "beanId": "geoLocationServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "searchAddresses",
  "args": [
    {
      "0": null,
      "1": null,
      "2": null
    }
  ]
}

Address

Аргумент	Тип	Описание
`addressId`	`String`	Передаётся через `args[0].0`.

getAddressById

{
  "beanId": "geoLocationServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "getAddressById",
  "args": [
    {
      "0": null
    }
  ]
}

List<Country>

Аргумент	Тип	Описание
—	—	Метод не принимает аргументы.

getCountries

{
  "beanId": "geoLocationServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "getCountries",
  "args": []
}

Country

Аргумент	Тип	Описание
`code`	`String`	Передаётся через `args[0].0`.

getCountryByCode

{
  "beanId": "geoLocationServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "getCountryByCode",
  "args": [
    {
      "0": null
    }
  ]
}

String

Аргумент	Тип	Описание
`code`	`String`	Передаётся через `args[0].0`.

getCountryCodeValue

{
  "beanId": "geoLocationServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "getCountryCodeValue",
  "args": [
    {
      "0": null
    }
  ]
}

Country

Аргумент	Тип	Описание
`sellerId`	`String`	Передаётся через `args[0].0`.

getCountryBySellerId

{
  "beanId": "geoLocationServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "getCountryBySellerId",
  "args": [
    {
      "0": null
    }
  ]
}

String

Аргумент	Тип	Описание
`sellerId`	`String`	Передаётся через `args[0].0`.

getCountryNameBySellerId

{
  "beanId": "geoLocationServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "getCountryNameBySellerId",
  "args": [
    {
      "0": null
    }
  ]
}

List<Seller>

Аргумент	Тип	Описание
`countryCode`	`String`	Передаётся через `args[0].0`.

getSellersByCountryCode

{
  "beanId": "geoLocationServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "getSellersByCountryCode",
  "args": [
    {
      "0": null
    }
  ]
}

Address

Аргумент	Тип	Описание
`addressAsMap`	`LinkedHashMap<String, Object>`	Передаётся через `args[0].0`.

createAddress

Пример JSON объекта запроса:

{
    "id":  null,
    "houseNumber":  null,
    "city":  null,
    "street":  null,
    "postalCode":  null,
    "country":  null,
    "fallIntoObjects":  null
}

Request:

{
  "beanId": "geoLocationServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "createAddress",
  "args": [
    {
      "0": null
    }
  ]
}

Address

Аргумент	Тип	Описание
`addressAsMap`	`LinkedHashMap<String, Object>`	Передаётся через `args[0].0`.

saveAddress

Пример JSON объекта запроса:

{
    "id":  null,
    "houseNumber":  null,
    "city":  null,
    "street":  null,
    "postalCode":  null,
    "country":  null,
    "fallIntoObjects":  null
}

Request:

{
  "beanId": "geoLocationServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "saveAddress",
  "args": [
    {
      "0": null
    }
  ]
}

void

Аргумент	Тип	Описание
`addressId`	`String`	Передаётся через `args[0].0`.

removeAddressAndClean

{
  "beanId": "geoLocationServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "removeAddressAndClean",
  "args": [
    {
      "0": null
    }
  ]
}

void

Аргумент	Тип	Описание
`addressesIds`	`ArrayList<String>`	Передаётся через `args[0].0`.

removeAddressesByIds

{
  "beanId": "geoLocationServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "removeAddressesByIds",
  "args": [
    {
      "0": null
    }
  ]
}

Address

Аргумент	Тип	Описание
`sellerId`	`String`	Передаётся через `args[0].0`.
`addressAsMap`	`LinkedHashMap<String, Object>`	Передаётся через `args[1].1`.

addShippingAddress

Пример JSON объекта запроса:

{
    "id":  null,
    "houseNumber":  null,
    "city":  null,
    "street":  null,
    "postalCode":  null,
    "country":  null,
    "fallIntoObjects":  null
}

Request:

{
  "beanId": "geoLocationServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "addShippingAddress",
  "args": [
    {
      "0": null,
      "1": null
    }
  ]
}

void

Аргумент	Тип	Описание
`sellerId`	`String`	Передаётся через `args[0].0`.
`addressId`	`String`	Передаётся через `args[1].1`.

removeShippingAddress

{
  "beanId": "geoLocationServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "removeShippingAddress",
  "args": [
    {
      "0": null,
      "1": null
    }
  ]
}

void

Аргумент	Тип	Описание
`sellerId`	`String`	Передаётся через `args[0].0`.
`addressId`	`String`	Передаётся через `args[1].1`.

removeAddressFromSeller

{
  "beanId": "geoLocationServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "removeAddressFromSeller",
  "args": [
    {
      "0": null,
      "1": null
    }
  ]
}

Set<Address>

Аргумент	Тип	Описание
`sellerId`	`String`	Передаётся через `args[0].0`.

getShippingAddresses

{
  "beanId": "geoLocationServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "getShippingAddresses",
  "args": [
    {
      "0": null
    }
  ]
}

Клиенты для интеграции

Клиенты

Сервисы

REST API

Headers

Методы

getAddressRepository

getPaginationFilter

searchCountries

searchCountriesPaged

searchAddresses

getAddressById

getCountries

getCountryByCode

getCountryCodeValue

getCountryBySellerId

getCountryNameBySellerId

getSellersByCountryCode

createAddress

saveAddress

removeAddressAndClean

removeAddressesByIds

addShippingAddress

removeShippingAddress

removeAddressFromSeller

getShippingAddresses

​Headers

​Методы

​getAddressRepository

​getPaginationFilter

​searchCountries

​searchCountriesPaged

​searchAddresses

​getAddressById

​getCountries

​getCountryByCode

​getCountryCodeValue

​getCountryBySellerId

​getCountryNameBySellerId

​getSellersByCountryCode

​createAddress

​saveAddress

​removeAddressAndClean

​removeAddressesByIds

​addShippingAddress

​removeShippingAddress

​removeAddressFromSeller

​getShippingAddresses

Headers

Методы

getAddressRepository

getPaginationFilter

searchCountries

searchCountriesPaged

searchAddresses

getAddressById

getCountries

getCountryByCode

getCountryCodeValue

getCountryBySellerId

getCountryNameBySellerId

getSellersByCountryCode

createAddress

saveAddress

removeAddressAndClean

removeAddressesByIds

addShippingAddress

removeShippingAddress

removeAddressFromSeller

getShippingAddresses