Skip to content
Wink

Create Ranked Grid

POST
/api/managing-entity/{managingEntityIdentifier}/studio/ranked-grids
 
curl --request POST \
  --url https://api.wink.travel/api/managing-entity/owner-1/studio/ranked-grids \
  --header 'Content-Type: application/json' \
  --header 'Wink-Version: 2.0' \
  --data '{ "name": "", "customizationIdentifier": "", "descriptions": "", "keywords": [ "" ], "lookup": "", "animate": false, "animateDelay": -1, "sort": "MEMBER", "displayType": "NATIVE" }'

Create a new ranked grid

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
managingEntityIdentifier
required
string
""

Create list 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

Request Body required

Section titled “Request Body required ”
Media type application/json
object
name
required

Descriptive name of this list for seller use only

string
"" >= 1 characters
Example 
My ranked list
customizationIdentifier
required

Customization identifier

string format: uuid
"" >= 1 characters
Example 
customization-1
descriptions
required

Contains custom title and description of grid

Array<object>
"" >= 1 items <= 2147483647 items
object
name
required

Use as title or short text description

string
""
Example 
An example title
description
required

Longer text description

string
"" >= 1 characters <= 2147483647 characters
Example 
This is a longer description in the specified language.
language
required

Indicate which language this description is written in.

string
default: en >= 2 characters <= 2 characters
Example 
en
creator

Whether it was user or system generated.

string
default: USER
Allowed values: SYSTEM USER
Example 
SYSTEM
md5ContentHash

The md5 hash of the name, description and language.

string
""
hashMismatch
boolean
keywords
required
Array<string>
>= 1 items <= 2147483647 items
lookup
required

The destination to display ranked inventory from.

object
identifier

Unique lookup identifier

string format: uuid
""
Example 
lookup-1
type

Type of lookup

string
""
Allowed values: CITY ISLAND HOTEL SPA MEETING_ROOM RESTAURANT ATTRACTION ACTIVITY PLACE COUNTRY
Example 
CITY
typeIdentifier

Unique lookup type identifier

string format: uuid
""
Example 
lookup-city-1
name

Name of lookup

string
""
Example 
Archery on horseback
urlName

Url-friendly slug that uniquely identifies this lookup

string
""
Example 
archery-on-horseback
ownerIdentifier

Lookup that is supplier inventory includes the supplier identifier

string format: uuid
""
Example 
hotel-1
ownerName

Lookup that is supplier inventory includes the supplier name

string
""
Example 
My Chic Hotel
cityName

Closest city where lookup entry is located

string
""
Example 
Los Angeles
countryName

Country where lookup entry is located

string
""
Example 
United States
subCountryName

State where lookup entry is located

string
""
Example 
California
subSubCountryName

County where lookup entry is located

string
""
Example 
Orange County
countryCode

Country code

string
""
Example 
US
ownerType

The type of owner that created this lookup

string
""
Allowed values: TRAVELIKO HOTEL
Example 
HOTEL
languageCode

The language the lookup code was written in

string
""
Example 
en-US
sort

Platform-specific sort

integer format: int32
""
Example 
2
origin

If this lookup is the origin lookup.

boolean
Example 
true
lowercaseName

Name in lower case

string
""
Example 
archery on horseback
location
required

Geo-location

object
x
number format: double
y
number format: double
type
string
coordinates
Array<number>
Example 
{
  "type": "POINT",
  "coordinates": [
    100.5581533,
    13.7370197
  ]
}
animate

Create an animated gif instead of a list of images

boolean
Example 
false
animateDelay

Controls animation delay in milliseconds. -1 is disabled

integer format: int32
default: -1
sort

Determines which badge to show on the Web Component. Is also used to sort properties for search grids.

string
""
Allowed values: MEMBER PRICE_LOW_TO_HIGH PRICE_HIGH_TO_LOW PRICE POPULARITY ECO EXPERIENCE PERK LOYALTY ADD_ON
Example 
MEMBER
displayType

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

string
default: NATIVE
Allowed values: NATIVE HOTEL ROOM
Example 
NATIVE

Responses

Section titled “ Responses ”

201

Section titled “201 ”

Created

Media type application/json
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

AffiliateAccount identifier

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

Descriptive name of this list for seller use only

string
"" >= 1 characters
customizationIdentifier
required

Customization identifier

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

Contains custom title and description of grid

Array<object>
"" >= 1 items <= 2147483647 items
object
name
required

Use as title or short text description

string
""
description
required

Longer text description

string
"" >= 1 characters <= 2147483647 characters
language
required

Indicate which language this description is written in.

string
default: en >= 2 characters <= 2 characters
creator

Whether it was user or system generated.

string
default: USER
Allowed values: SYSTEM USER
md5ContentHash

The md5 hash of the name, description and language.

string
""
hashMismatch
boolean
keywords
required
Array<string>
>= 1 items <= 2147483647 items
status
required

Status

string
default: ACTIVE
Allowed values: ACTIVE INACTIVE REMOVED
lookup
required

The destination to display ranked inventory from.

object
identifier

Unique lookup identifier

string format: uuid
""
type

Type of lookup

string
""
Allowed values: CITY ISLAND HOTEL SPA MEETING_ROOM RESTAURANT ATTRACTION ACTIVITY PLACE COUNTRY
typeIdentifier

Unique lookup type identifier

string format: uuid
""
name

Name of lookup

string
""
urlName

Url-friendly slug that uniquely identifies this lookup

string
""
ownerIdentifier

Lookup that is supplier inventory includes the supplier identifier

string format: uuid
""
ownerName

Lookup that is supplier inventory includes the supplier name

string
""
cityName

Closest city where lookup entry is located

string
""
countryName

Country where lookup entry is located

string
""
subCountryName

State where lookup entry is located

string
""
subSubCountryName

County where lookup entry is located

string
""
countryCode

Country code

string
""
ownerType

The type of owner that created this lookup

string
""
Allowed values: TRAVELIKO HOTEL
languageCode

The language the lookup code was written in

string
""
sort

Platform-specific sort

integer format: int32
""
origin

If this lookup is the origin lookup.

boolean
lowercaseName

Name in lower case

string
""
location
required

Geo-location

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

Create an animated gif instead of a list of images

boolean
animateDelay

Controls animation delay in milliseconds. -1 is disabled

integer format: int32
default: -1
sort

Determines which badge to show on the Web Component. Is also used to sort properties for search grids.

string
""
Allowed values: MEMBER PRICE_LOW_TO_HIGH PRICE_HIGH_TO_LOW PRICE POPULARITY ECO EXPERIENCE PERK LOYALTY ADD_ON
displayType

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

string
default: NATIVE
Allowed values: NATIVE HOTEL ROOM
Example 
{
  "id": "",
  "createdDate": "",
  "lastUpdate": "",
  "version": "",
  "ownerIdentifier": "",
  "name": "",
  "customizationIdentifier": "",
  "descriptions": "",
  "keywords": [
    ""
  ],
  "status": "ACTIVE",
  "lookup": "",
  "animate": false,
  "animateDelay": -1,
  "sort": "MEMBER",
  "displayType": "NATIVE"
}

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