Skip to content

Show Shortened Url

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

Retrieve shortened url.

managingEntityIdentifier
required
string
""

Shortened Url owned by this owner identifier.

Example
owner-1
shortenedUrlIdentifier
required
string
""

Shortened Url identifier.

Example
shortened-url-1
Wink-Version
string
default: 2.0.0
Allowed values: 2.0

OK

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

Creator of entry

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

AffiliateAccount / Owner identifier

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

The site name of this entry

string
"" >= 1 characters
type
required

The type of document the uniqueId links to

string
""
Allowed values: SELLABLE_INVENTORY_SLUG SELLABLE_SUPPLIER_SLUG AFFILIATE_ACCOUNT_SLUG SYNDICATED_ITEM_SLUG URL
uniqueId
required

This is the unique ID for the specific URL we want to catch

string
"" >= 1 characters
entityId

Entity ID is where the unique ID originated from. This will be empty if it’s just a regular url. Required when type IS NOT URL.

string
""
url

For times when the user just wants to shorten a url and there is no underlying entity to speak of. Required when type IS URL.

string
""
imageList
Array<object>

The image list

object
url
required

The image url

string
"" >= 1 characters
secureUrl

The secure url

string
""
type

Image content type

string
""
width

Image width

string
""
height

Image height

string
""
alt

Alt text

string
""
videoList
Array<object>

The video list

object
url
required

The image url

string
"" >= 1 characters
secureUrl

The secure url

string
""
type

Image content type

string
""
width

Image width

string
""
height

Image height

string
""
alt

Alt text

string
""
audioList
Array<object>

The audio list

object
url
required

The image url

string
"" >= 1 characters
secureUrl

The secure url

string
""
type

Image content type

string
""
width

Image width

string
""
height

Image height

string
""
alt

Alt text

string
""
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
multimedias
Array<object>

The main media for this entry.

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
metadata

Extended metadata

object
key
additional properties
previousUniqueIds
Array<string>
Example
{
"id": "",
"createdDate": "",
"lastUpdate": "",
"version": "",
"userIdentifier": "",
"ownerIdentifier": "",
"title": "",
"type": "SELLABLE_INVENTORY_SLUG",
"uniqueId": "",
"entityId": "",
"url": "",
"imageList": [
""
],
"videoList": [
""
],
"audioList": [
""
],
"descriptions": [
""
],
"multimedias": [
null
],
"metadata": "",
"previousUniqueIds": [
""
]
}

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

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

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

Internal Server Error

object
Example generated
{}