GeoLocationServiceImpl

string

The Spring bean identifier containing the service being called.geoLocationServiceImpl

string

default:"PROTOTYPE"

Bean scope. Use PROTOTYPE for service calls.

string

The public service method name shown in the signature below.

object[]

The method argument array. Each argument is passed as an object with index 0, 1, and so on; the value must match the Java parameter type.

Headers

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

Send Lang-Context and Site-Context with every request. For protected methods, send the JWT in the Authorization header as Bearer <token>. Access: GUEST. Bearer Token: not required.

GUEST — unauthenticated users; only whitelist services are available.
USER — authentication is required; methods with USER checks are available.
ADMIN — full access to public methods of all services.
If a method checks a role internally, GUEST may receive null.

Methods

AddressRepository

Argument	Type	Description
—	—	This method does not accept arguments.

getAddressRepository

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

Deque<Map<String, Object>>

Argument	Type	Description
`requestJson`	`String`	Passed through `args[0].0`.

getPaginationFilter

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

LinkedHashSet<Country>

Argument	Type	Description
`requestJson`	`String`	Passed through `args[0].0`.

searchCountries

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

Page<Country>

Argument	Type	Description
`requestJson`	`String`	Passed through `args[0].0`.

searchCountriesPaged

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

List<Address>

Argument	Type	Description
`query`	`String`	Passed through `args[0].0`.
`from`	`String`	Passed through `args[1].1`.
`to`	`String`	Passed through `args[2].2`.

searchAddresses

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

Address

Argument	Type	Description
`addressId`	`String`	Passed through `args[0].0`.

getAddressById

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

List<Country>

Argument	Type	Description
—	—	This method does not accept arguments.

getCountries

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

Country

Argument	Type	Description
`code`	`String`	Passed through `args[0].0`.

getCountryByCode

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

String

Argument	Type	Description
`code`	`String`	Passed through `args[0].0`.

getCountryCodeValue

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

Country

Argument	Type	Description
`sellerId`	`String`	Passed through `args[0].0`.

getCountryBySellerId

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

String

Argument	Type	Description
`sellerId`	`String`	Passed through `args[0].0`.

getCountryNameBySellerId

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

List<Seller>

Argument	Type	Description
`countryCode`	`String`	Passed through `args[0].0`.

getSellersByCountryCode

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

Address

Argument	Type	Description
`addressAsMap`	`LinkedHashMap<String, Object>`	Passed through `args[0].0`.

createAddress

Example JSON request object:

{
    "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

Argument	Type	Description
`addressAsMap`	`LinkedHashMap<String, Object>`	Passed through `args[0].0`.

saveAddress

Example JSON request object:

{
    "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

Argument	Type	Description
`addressId`	`String`	Passed through `args[0].0`.

removeAddressAndClean

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

void

Argument	Type	Description
`addressesIds`	`ArrayList<String>`	Passed through `args[0].0`.

removeAddressesByIds

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

Address

Argument	Type	Description
`sellerId`	`String`	Passed through `args[0].0`.
`addressAsMap`	`LinkedHashMap<String, Object>`	Passed through `args[1].1`.

addShippingAddress

Example JSON request object:

{
    "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

Argument	Type	Description
`sellerId`	`String`	Passed through `args[0].0`.
`addressId`	`String`	Passed through `args[1].1`.

removeShippingAddress

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

void

Argument	Type	Description
`sellerId`	`String`	Passed through `args[0].0`.
`addressId`	`String`	Passed through `args[1].1`.

removeAddressFromSeller

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

Set<Address>

Argument	Type	Description
`sellerId`	`String`	Passed through `args[0].0`.

getShippingAddresses

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

Client integration

Clients

Services

REST API

Headers

Methods

getAddressRepository

getPaginationFilter

searchCountries

searchCountriesPaged

searchAddresses

getAddressById

getCountries

getCountryByCode

getCountryCodeValue

getCountryBySellerId

getCountryNameBySellerId

getSellersByCountryCode

createAddress

saveAddress

removeAddressAndClean

removeAddressesByIds

addShippingAddress

removeShippingAddress

removeAddressFromSeller

getShippingAddresses

​Headers

​Methods

​getAddressRepository

​getPaginationFilter

​searchCountries

​searchCountriesPaged

​searchAddresses

​getAddressById

​getCountries

​getCountryByCode

​getCountryCodeValue

​getCountryBySellerId

​getCountryNameBySellerId

​getSellersByCountryCode

​createAddress

​saveAddress

​removeAddressAndClean

​removeAddressesByIds

​addShippingAddress

​removeShippingAddress

​removeAddressFromSeller

​getShippingAddresses

Headers

Methods

getAddressRepository

getPaginationFilter

searchCountries

searchCountriesPaged

searchAddresses

getAddressById

getCountries

getCountryByCode

getCountryCodeValue

getCountryBySellerId

getCountryNameBySellerId

getSellersByCountryCode

createAddress

saveAddress

removeAddressAndClean

removeAddressesByIds

addShippingAddress

removeShippingAddress

removeAddressFromSeller

getShippingAddresses