Skip to content
Wink

Map + Markers

GET
/api/public/{managingEntityIdentifier}/map/{mapIdentifier}/markers
 
curl --request GET \
  --url https://api.wink.travel/api/public//map/example/markers \
  --header 'Wink-Version: 2.0'

Load map and map markers for a configurable map.

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
managingEntityIdentifier
required
string
""

Managing entity identifier

mapIdentifier
required
string

Header Parameters

Section titled “Header Parameters ”
Wink-Version
string
default: 2.0.0
Allowed values: 2.0

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OK

Media type application/json
object
map
required
object
identifier
required

Map identifier

string format: uuid
"" >= 1 characters
ownerIdentifier
required

Map owner identifier

string format: uuid
"" >= 1 characters
customizationIdentifier
required

Customization identifier

string format: uuid
"" >= 1 characters
name
required

Name of map

string
"" >= 1 characters
typeIdentifier
required

Inventory type identifier. Either a single channel inventory identifier, a list identifier or a dynamic search identifier.

string format: uuid
"" >= 1 characters
type
required

Type of blocking

string
""
Allowed values: SINGLE LIST SEARCH
center
required

Map center point

object
x
number format: double
y
number format: double
type
string
coordinates
Array<number>
draggable
required

User can move around / pan the map

boolean
default: true
zoomable
required

User can zoom in/out of the map

boolean
default: true
initialZoomLevel
required

Valid Google maps zoom level

integer format: int32
"" <= 21
mapStyle
required

Map style

string
""
Allowed values: normal clean bluish
mapMarkerColor
required

Map marker color

string
""
Allowed values: cc2138
mapHeight
required

Map height in pixels

integer format: int32
"" >= 1
displayType
required

Indicate which initial values to display first on the front-facing card

string
default: NATIVE
Allowed values: NATIVE HOTEL ROOM
circles
Array<object>

A way to persist a GeoJSON circle

object
radius
required

Circle radius from center

number format: double
""
point
required

Circle center point

object
x
number format: double
y
number format: double
type
string
coordinates
Array<number>
rectangles
Array<object>

Custom-defined rectangles

object
rectangle
required

A GeoJSON rectangle

object
southWest
required

A GeoJSON rectangle

object
x
number format: double
y
number format: double
type
string
coordinates
Array<number>
northEast
required

A GeoJSON rectangle

object
x
number format: double
y
number format: double
type
string
coordinates
Array<number>
markers
Array<object>

Custom-defined markers

object
point
required

A GeoJSON point

object
x
number format: double
y
number format: double
type
string
coordinates
Array<number>
polygons
Array<object>

Custom-defined polygons

object
polygon
required

A GeoJSON polygon

object
points
Array<object>
object
x
number format: double
y
number format: double
coordinates
Array<object>
object
type
string
coordinates
Array<object>
object
x
number format: double
y
number format: double
type
string
markers
required
Array<object>

Inventory map marker

object
channelInventoryIdentifier
required

Identifier of the list, channel inventory or search

string
""
point
required

Location of inventory

object
x
number format: double
y
number format: double
type
string
coordinates
Array<number>
supplierIdentifier
required

Hotel identifier

string format: uuid
""
supplierName
required

Hotel name

string
""
inventoryIdentifier
required

Actual inventory identifier

string format: uuid
""
inventoryType
required

Type of inventory

string
""
Allowed values: GUEST_ROOM ADD_ON MEETING_ROOM RESTAURANT SPA ATTRACTION PLACE ACTIVITY
inventoryName
required

Name of inventory

string
""
lowestDisplayPrice
required

Lowest price of inventory in desired currency

object
amount
required
number
currency
required
string
>= 1 characters
Example 
{
  "map": {
    "identifier": "",
    "ownerIdentifier": "",
    "customizationIdentifier": "",
    "name": "",
    "typeIdentifier": "",
    "type": "SINGLE",
    "center": "",
    "draggable": true,
    "zoomable": true,
    "initialZoomLevel": "",
    "mapStyle": "normal",
    "mapMarkerColor": "cc2138",
    "mapHeight": "",
    "displayType": "NATIVE",
    "circles": [
      null
    ],
    "rectangles": [
      ""
    ],
    "markers": [
      ""
    ],
    "polygons": [
      ""
    ]
  },
  "markers": [
    null
  ]
}

400

Section titled “400 ”

Bad Request

object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties
Example generated
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "https://example.com",
  "properties": {
    "additionalProperty": "example"
  }
}

401

Section titled “401 ”

Unauthorized

Media type */*
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties

403

Section titled “403 ”

Forbidden

Media type */*
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties

500

Section titled “500 ”

Internal Server Error

object
Example generated
{}