API docs by Redocly

Geo Service API (0.0.0)

Perform geo coding based on user input.

Monitoring

Return the liveness of the service

Return the liveness of the service

Responses

Response samples

Content type
application/json
{
  • "is_alive": true
}

Return the readiness of the service

Return the readiness of the service

Responses

Response samples

Content type
application/json
{
  • "is_alive": true
}

Geo Code

Get GeoCode with Address

Get GeoCode with Address

Authorizations:
bearerAuth
query Parameters
street_address
string

Street Address

country
string

Country Address

Responses

Response samples

Content type
application/json
{
  • "value": {
    }
}

Update status to Placed from Created

Update status to Placed from Created

Authorizations:
bearerAuth
Request Body schema: application/json
street_address
required
string
city
string
state
string
country
string
zip_code
string

Responses

Request samples

Content type
application/json
{
  • "street_address": "string",
  • "city": "string",
  • "state": "string",
  • "country": "string",
  • "zip_code": "string"
}

Response samples

Content type
application/json
{
  • "value": {
    }
}

Geo Distance

Post distance between two addresses

Post distance between two addresses

Authorizations:
bearerAuth
Request Body schema: application/json
object (address-with-latlng)
object (address-with-latlng)

Responses

Request samples

Content type
application/json
{
  • "from_address": {
    },
  • "to_address": {
    }
}

Response samples

Content type
application/json
{
  • "value": {
    }
}

Post distance between multiple addresses

Post distance between multiple addresses

Authorizations:
bearerAuth
Request Body schema: application/json
order_type
required
any
Enum: "all" "marine"
required
Array of objects (address-with-latlng)

Responses

Request samples

Content type
application/json
{
  • "order_type": "all",
  • "stops": [
    ]
}

Response samples

Content type
application/json
{
  • "multi-distance_data": null
}

Saved Address

Get Saved Address List

Get Saved Address List

Authorizations:
bearerAuth
query Parameters
page
integer <int64> >= 1
Default: 1
per_page
integer <int64> >= 1
Default: 200

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "geo_datas": [
    ]
}

Post new saved address

Post new saved address

Authorizations:
bearerAuth
Request Body schema: application/json
id
required
string
building_name
required
string
street_address
required
string
city
required
string
state
required
string
country
required
string
zip_code
required
string
lat
required
number
lng
required
number
status
string
source
string
source_reference
string
is_default_pickup
boolean
is_default_delivery
boolean

Responses

Request samples

Content type
application/json
{
  • "id": "xxxxx-xxxxx-xxxxxxx-xxxxxx-xxxxx",
  • "building_name": "Venue Building",
  • "street_address": "391a orchard rd",
  • "city": "singapore",
  • "state": "singapore",
  • "country": "singapore",
  • "zip_code": "238873",
  • "lat": 1.302707,
  • "lng": 103.834289,
  • "source": "google-map",
  • "source_reference": "ChIJj6KI8ZEZ2jER5dtmqBYIAuo",
  • "status": "placed"
}

Response samples

Content type
application/json
{
  • "id": "xxxxx-xxxxx-xxxxxxx-xxxxxx-xxxxx",
  • "building_name": "Venue Building",
  • "street_address": "391a orchard rd",
  • "city": "singapore",
  • "state": "singapore",
  • "country": "singapore",
  • "zip_code": "238873",
  • "lat": 1.302707,
  • "lng": 103.834289,
  • "source": "google-map",
  • "source_reference": "ChIJj6KI8ZEZ2jER5dtmqBYIAuo",
  • "status": "placed"
}

Update saved address

Update saved address

Authorizations:
bearerAuth
path Parameters
id
required
string

ID of saved address

Request Body schema: application/json
building_name
required
string

Responses

Request samples

Content type
application/json
{
  • "building_name": "string"
}

Response samples

Content type
application/json
{
  • "id": "xxxxx-xxxxx-xxxxxxx-xxxxxx-xxxxx",
  • "building_name": "Venue Building",
  • "street_address": "391a orchard rd",
  • "city": "singapore",
  • "state": "singapore",
  • "country": "singapore",
  • "zip_code": "238873",
  • "lat": 1.302707,
  • "lng": 103.834289,
  • "source": "google-map",
  • "source_reference": "ChIJj6KI8ZEZ2jER5dtmqBYIAuo",
  • "status": "placed"
}

Get Saved Address Detail

Get Saved Address Detail

Authorizations:
bearerAuth
path Parameters
id
required
string

ID of saved address

Responses

Response samples

Content type
application/json
{
  • "id": "xxxxx-xxxxx-xxxxxxx-xxxxxx-xxxxx",
  • "building_name": "Venue Building",
  • "street_address": "391a orchard rd",
  • "city": "singapore",
  • "state": "singapore",
  • "country": "singapore",
  • "zip_code": "238873",
  • "lat": 1.302707,
  • "lng": 103.834289,
  • "source": "google-map",
  • "source_reference": "ChIJj6KI8ZEZ2jER5dtmqBYIAuo",
  • "status": "placed"
}

Saved Address By Ops

Get Saved Address List

Get Saved Address List

Authorizations:
bearerAuth
query Parameters
org_id
string

Organization IDs

page
integer <int64> >= 1
Default: 1
per_page
integer <int64> >= 1
Default: 200

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "geo_datas": [
    ]
}

Sys Post new saved address

Sys Post new saved address

Authorizations:
bearerAuth
Request Body schema: application/json
id
string
building_name
required
string
street_address
required
string
city
required
string
state
required
string
country
required
string
zip_code
required
string
lat
required
number
lng
required
number
status
string
source
string
source_reference
string
org_id
required
string
is_default_pickup
boolean
is_default_delivery
boolean

Responses

Request samples

Content type
application/json
{
  • "building_name": "Venue Building",
  • "street_address": "391a orchard rd",
  • "city": "singapore",
  • "state": "singapore",
  • "country": "singapore",
  • "zip_code": "238873",
  • "lat": 1.302707,
  • "lng": 103.834289,
  • "source": "google-map",
  • "source_reference": "ChIJj6KI8ZEZ2jER5dtmqBYIAuo",
  • "status": "placed",
  • "org_id": "xxxxx-xxxxx-xxxxxxx-xxxxxx-xxxxx",
  • "is_default_pickup": true
}

Response samples

Content type
application/json
{
  • "id": "xxxxx-xxxxx-xxxxxxx-xxxxxx-xxxxx",
  • "building_name": "Venue Building",
  • "street_address": "391a orchard rd",
  • "city": "singapore",
  • "state": "singapore",
  • "country": "singapore",
  • "zip_code": "238873",
  • "lat": 1.302707,
  • "lng": 103.834289,
  • "source": "google-map",
  • "source_reference": "ChIJj6KI8ZEZ2jER5dtmqBYIAuo",
  • "status": "placed"
}

Saved Address By Ops

Saved Address By Ops

Authorizations:
bearerAuth
path Parameters
id
required
string

ID of saved address

Responses

Response samples

Content type
application/json
{
  • "id": "xxxxx-xxxxx-xxxxxxx-xxxxxx-xxxxx",
  • "building_name": "Venue Building",
  • "street_address": "391a orchard rd",
  • "city": "singapore",
  • "state": "singapore",
  • "country": "singapore",
  • "zip_code": "238873",
  • "lat": 1.302707,
  • "lng": 103.834289,
  • "source": "google-map",
  • "source_reference": "ChIJj6KI8ZEZ2jER5dtmqBYIAuo",
  • "status": "placed"
}

Update saved address

Update saved address

Authorizations:
bearerAuth
path Parameters
id
required
string

ID of saved address

Request Body schema: application/json
building_name
required
string

Responses

Request samples

Content type
application/json
{
  • "building_name": "string"
}

Response samples

Content type
application/json
{
  • "id": "xxxxx-xxxxx-xxxxxxx-xxxxxx-xxxxx",
  • "building_name": "Venue Building",
  • "street_address": "391a orchard rd",
  • "city": "singapore",
  • "state": "singapore",
  • "country": "singapore",
  • "zip_code": "238873",
  • "lat": 1.302707,
  • "lng": 103.834289,
  • "source": "google-map",
  • "source_reference": "ChIJj6KI8ZEZ2jER5dtmqBYIAuo",
  • "status": "placed"
}

Get saved address detail by name

Get saved address detail by name

Authorizations:
bearerAuth
path Parameters
orgID
required
string

Organization IDs

name
required
string

Name of saved address

Responses

Response samples

Content type
application/json
{
  • "id": "xxxxx-xxxxx-xxxxxxx-xxxxxx-xxxxx",
  • "building_name": "Venue Building",
  • "street_address": "391a orchard rd",
  • "city": "singapore",
  • "state": "singapore",
  • "country": "singapore",
  • "zip_code": "238873",
  • "lat": 1.302707,
  • "lng": 103.834289,
  • "source": "google-map",
  • "source_reference": "ChIJj6KI8ZEZ2jER5dtmqBYIAuo",
  • "status": "placed"
}

Delete saved address

Delete saved address

Authorizations:
bearerAuth
path Parameters
orgID
required
string

Organization IDs

id
required
string

ID of saved address

Responses

Response samples

Content type
application/json
{
  • "id": "xxxxx-xxxxx-xxxxxxx-xxxxxx-xxxxx",
  • "building_name": "Venue Building",
  • "street_address": "391a orchard rd",
  • "city": "singapore",
  • "state": "singapore",
  • "country": "singapore",
  • "zip_code": "238873",
  • "lat": 1.302707,
  • "lng": 103.834289,
  • "source": "google-map",
  • "source_reference": "ChIJj6KI8ZEZ2jER5dtmqBYIAuo",
  • "status": "placed"
}

Marine Location By Ops

Get Marine Location

Get Marine Location

Authorizations:
bearerAuth
query Parameters
page
integer <int64> >= 1
Default: 1
per_page
integer <int64> >= 1
Default: 200
term
string

Search term

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "geo_datas": [
    ]
}

Post new marine location

Post new marine location

Authorizations:
bearerAuth
Request Body schema: application/json
id
string
name_address
required
string
city
string
state
string
country
required
string
lat
required
number
lng
required
number
source
string
created_at
string
updated_at
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name_address": "string",
  • "city": "string",
  • "state": "string",
  • "country": "string",
  • "lat": 0,
  • "lng": 0,
  • "source": "string",
  • "created_at": "string",
  • "updated_at": "string"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "server_time": "string"
}

Delete marine location

Delete marine location

Authorizations:
bearerAuth
path Parameters
id
required
string

ID of marine location

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "server_time": "string"
}

Update marine location

Update marine location

Authorizations:
bearerAuth
path Parameters
id
required
string

ID of marine location

Request Body schema: application/json
id
string
name_address
required
string
city
string
state
string
country
required
string
lat
required
number
lng
required
number
source
string
created_at
string
updated_at
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name_address": "string",
  • "city": "string",
  • "state": "string",
  • "country": "string",
  • "lat": 0,
  • "lng": 0,
  • "source": "string",
  • "created_at": "string",
  • "updated_at": "string"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "server_time": "string"
}

Get Marine Location Detail

Get Marine Location Detail

Authorizations:
bearerAuth
path Parameters
id
required
string

ID of marine location

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name_address": "string",
  • "city": "string",
  • "state": "string",
  • "country": "string",
  • "lat": 0,
  • "lng": 0,
  • "source": "string",
  • "created_at": "string",
  • "updated_at": "string"
}

Marine Location

Get Marine Location

Get Marine Location

Authorizations:
bearerAuth
query Parameters
page
integer <int64> >= 1
Default: 1
per_page
integer <int64> >= 1
Default: 200
term
string

Search term

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "geo_datas": [
    ]
}