Skip to content
Wink

Show Dynamic Lists

GET
/api/managing-entity/{managingEntityIdentifier}/studio/dynamic-list
 
curl --request GET \
  --url https://api.wink.travel/api/managing-entity/owner-1/studio/dynamic-list \
  --header 'Wink-Version: 2.0'

Retrieve all saved searches for owner

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
managingEntityIdentifier
required
string
""

List searches owned by this owner identifier.

Example 
owner-1

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
Array<object>
object
id

Document UUID

string
""
createdDate

Datetime this record was first created

string format: date-time
""
lastUpdate

Datetime this record was last updated

string format: date-time
""
version

Version property that shows how many times this document has been persisted. Document will not persist if the version property is less than current version property in the system. Result in an optimistic locking exception.

integer format: int64
""
ownerIdentifier
required

Entity identifier of record creator

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

Name of dynamic list for when user want to persist it

string
"" >= 1 characters
propertyName

Regex expression filter matching on property name.

string
""
locationCategories

Supported OTA specification LOC code. See OTA geoname data

Array<string>
""
segmentCategories

Supported OTA specification SEG code. See OTA geoname data

Array<string>
""
hotelCategories

Supported OTA specification PCT code. See OTA geoname data

Array<string>
""
architecturalStyles

Supported OTA specification ARC code. See OTA geoname data

Array<string>
""
inventoryName

Regex expression filter matching on inventory name

string
""
continents

Continent filter

Array<string>
countries

Country filter

Array<string>
cities

City filter

Array<string>
showEcoFriendly

Filter on eco-friendly hotels

boolean
showPetFriendly

Filter on pet-friendly hotels

boolean
showChildFriendly

Filter on child-friendly hotels

boolean
showPopular

Filter on hotel that has had a certain amount of bookings

boolean
showDirectOnly

Filter on direct inventory

boolean
lifestyles

Filter on lifestyles

Array<string>
""
Allowed values: LIFESTYLE_HEALTH_FITNESS LIFESTYLE_RELAX LIFESTYLE_ADULT_ONLY LIFESTYLE_ADVENTURE LIFESTYLE_BUSINESS LIFESTYLE_LGBT LIFESTYLE_SINGLE_PARENT LIFESTYLE_SOLO_FEMALE LIFESTYLE_BEAUTY LIFESTYLE_FOODIE LIFESTYLE_FAMILY LIFESTYLE_ROMANCE LIFESTYLE_COUPLE LIFESTYLE_SOLO LIFESTYLE_BACKPACKER LIFESTYLE_SHOPPING LIFESTYLE_SPORTS LIFESTYLE_MOUNTAIN LIFESTYLE_BEACH LIFESTYLE_CITY LIFESTYLE_COUNTRY LIFESTYLE_CULTURE LIFESTYLE_ECO
hotelStars

Filter on number of stars the hotel has.

integer format: int32
""
aggregateReviewRating

Filter on aggregate review score the hotel has

integer format: int32
""
nearPoint

Find hotels close to certain location

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

Use this in conjunction with nearPoint. Control the distance from point we are searching for.

integer format: int64
0
inventoryTypes

Filter on inventory types

Array<string>
Allowed values: GUEST_ROOM ADD_ON MEETING_ROOM RESTAURANT SPA ATTRACTION PLACE ACTIVITY
primaryOrderBy

Control how you want the search results sorted. Options are:

  • 1: Inventory name
  • 2: Price: High to low
  • 3: Price: Low to high
  • 4: Commission: High to low
  • 5: Commission: Low to high
  • 6: Discount: High to low
  • 7: Discount: Low to high
string
""
Example 
[
  {
    "id": "",
    "createdDate": "",
    "lastUpdate": "",
    "version": "",
    "ownerIdentifier": "",
    "name": "",
    "propertyName": "",
    "locationCategories": "",
    "segmentCategories": "",
    "hotelCategories": "",
    "architecturalStyles": "",
    "inventoryName": "",
    "continents": [
      ""
    ],
    "countries": [
      ""
    ],
    "cities": [
      ""
    ],
    "showEcoFriendly": false,
    "showPetFriendly": false,
    "showChildFriendly": false,
    "showPopular": false,
    "showDirectOnly": false,
    "lifestyles": "",
    "hotelStars": "",
    "aggregateReviewRating": "",
    "nearPoint": "",
    "radiusInMeters": 0,
    "inventoryTypes": [
      "GUEST_ROOM"
    ],
    "primaryOrderBy": ""
  }
]

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