Skip to content

Get announcement details

GET
/api/managing-entity/{managingEntityIdentifier}/extranet/announcement/{announcementIdentifier}
curl --request GET \
--url https://api.wink.travel/api/managing-entity/d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69/extranet/announcement/b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47 \
--header 'Authorization: Bearer <token>' \
--header 'Wink-Version: 2.0'

Returns a single announcement by its identifier, including all configured dates, content in all languages, and visibility settings. Requires CONTENT:READ on the managing entity.

managingEntityIdentifier
required
string
""

Unique identifier of the property (managing entity)

Example
d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69
announcementIdentifier
required
string
""

Unique identifier of the announcement to retrieve

Example
b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47
Wink-Version
string
default: 2.0.0
Allowed values: 2.0

The requested announcement

Media type application/json
object
id

Document UUID

string format: uuid
""
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
""
hotelIdentifier
required

Unique identifier of the property (managing entity) for which this announcement is configured.

string format: uuid
"" >= 1 characters
startDate

Date when this announcement becomes active and visible to travelers.

string format: date
""
endDate

Date when this announcement expires and is no longer displayed.

string format: date
""
descriptions
required

List of all localized announcements.

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
showTitle

When true, the announcement title is displayed to travelers; when false, only the description content is shown.

boolean
showAlways

When true, the announcement is always visible regardless of booking dates; when false, visibility is restricted to the configured start and end dates.

boolean
Example
{
"id": "",
"createdDate": "",
"lastUpdate": "",
"version": "",
"hotelIdentifier": "",
"startDate": "",
"endDate": "",
"descriptions": [
""
],
"showTitle": false,
"showAlways": false
}

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

Insufficient permissions: CONTENT:READ not granted on the managing entity

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

Announcement not found or does not belong to the specified property

Media type application/json
object
id

Document UUID

string format: uuid
""
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
""
hotelIdentifier
required

Unique identifier of the property (managing entity) for which this announcement is configured.

string format: uuid
"" >= 1 characters
startDate

Date when this announcement becomes active and visible to travelers.

string format: date
""
endDate

Date when this announcement expires and is no longer displayed.

string format: date
""
descriptions
required

List of all localized announcements.

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
showTitle

When true, the announcement title is displayed to travelers; when false, only the description content is shown.

boolean
showAlways

When true, the announcement is always visible regardless of booking dates; when false, visibility is restricted to the configured start and end dates.

boolean
Example
{
"id": "",
"createdDate": "",
"lastUpdate": "",
"version": "",
"hotelIdentifier": "",
"startDate": "",
"endDate": "",
"descriptions": [
""
],
"showTitle": false,
"showAlways": false
}

Internal Server Error

object
Example generated
{}