Skip to content
Wink

Show WinkLinks Entries

GET
/api/managing-entity/{managingEntityIdentifier}/wink-links/syndication/entry/list
 
curl --request GET \
  --url 'https://api.wink.travel/api/managing-entity/owner-1/wink-links/syndication/entry/list?status=PUBLISHED' \
  --header 'Wink-Version: 2.0'

Retrieve list of syndication entries.

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
managingEntityIdentifier
required
string
""

List syndication entries owned by this owner identifier.

Example 
owner-1

Query Parameters

Section titled “Query Parameters ”
status
string
""

Return based on this status.

Example 
PUBLISHED

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
""
userIdentifier
required

Creator of entry

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

The user’s owner company this entry associates with

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

The site name of this entry

string
"" >= 1 characters
contentUrl
required

The url of this entry

string
"" >= 1 characters
sort
required

How the author wants this entry to get sorted

integer format: int32
""
status
required

This can change if it’s linked to travel inventory that is no longer available.

string
""
Allowed values: ACTIVE INACTIVE REMOVED
type
required

The syndication entry type

string
""
Allowed values: WEB_LINK MAP GRID CARD FILE QUOTE POST LOCKED
metadata

Extended metadata

object
key
additional properties
descriptions
required

Localized descriptions describing inventory.

Array<object>
>= 1 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
tags

Optional user categories

Array<object>
""
object
value
required

The value that should be persisted.

string
"" >= 1 characters
label
required

English readable text of the value.

string
"" >= 1 characters
multimedias

The main multimedias for this entry.

Array<object>
""

Multimedia that contains less information than Multimedia object

object
multimediaIdentifier
required

Document identifier

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

Use this identifier to communicate with Cloudinary.

string
"" >= 1 characters
type
required

Whether Cloudinary media is a VIDEO or IMAGE.

string
""
Allowed values: IMAGE VIDEO AUDIO RAW
source
required

Currently ONLY using Cloudinary to store all image / video assets.

string
default: CLOUDINARY
Allowed values: YOUTUBE CLOUDINARY
sort
required

Sort allows you to control how you want to sort this record in a list of media records.

integer format: int32
default: 999
angle

Media angle

string
""
width
required

Media width in pixels.

integer format: int32
"" >= 1
height
required

Media height in pixels.

integer format: int32
"" >= 1
published

Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.

boolean
category

Supported OTA specification PIC code. See OTA geoname data

string
""
descriptions

Localized media captions to give user some context about where this media was taken.

Array<object>
""
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
lifestyleType

Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.

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
attribution

Whether image has attribution properties

Array<object>
""
object
url

URL to contributor

string
""
name
required

Name of contributor

string
"" >= 1 characters
isLandscape

True if media width is greater or equal to height

boolean
display

Whether to treat all links as flat web links or try to embed more advanced data.

string
""
Allowed values: FROM_SETTINGS FROM_LAYOUT BANNER BANNER_INTELLIGENT
disabled

Whether author wants to disable the post.

boolean
publishDate

An optional date for when this post will be displayed.

string format: date-time
""
publishStatus

Publish status of post.

string
default: PUBLISHED
Allowed values: PUBLISHED ARCHIVED
lockCode

Optional code the author can require be entered by the user in order to see the post.

string
""
uniqueId

Optional unique code that can be used to access this record.

string
"" >= 5 characters <= 5 characters
userTags
Array<string>
hashTags
Array<string>
Example 
[
  {
    "id": "",
    "createdDate": "",
    "lastUpdate": "",
    "version": "",
    "userIdentifier": "",
    "ownerIdentifier": "",
    "title": "",
    "contentUrl": "",
    "sort": "",
    "status": "ACTIVE",
    "type": "WEB_LINK",
    "metadata": "",
    "descriptions": [
      ""
    ],
    "tags": "",
    "multimedias": "",
    "display": "FROM_SETTINGS",
    "disabled": false,
    "publishDate": "",
    "publishStatus": "PUBLISHED",
    "lockCode": "",
    "uniqueId": "",
    "userTags": [
      ""
    ],
    "hashTags": [
      ""
    ]
  }
]

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