Skip to content
Wink

Create Announcement

POST
/api/managing-entity/{managingEntityIdentifier}/extranet/announcement
 
curl --request POST \
  --url https://api.wink.travel/api/managing-entity/hotel-1/extranet/announcement \
  --header 'Content-Type: application/json' \
  --header 'Wink-Version: 2.0' \
  --data '{ "startDate": "", "endDate": "", "descriptions": [ "" ], "showTitle": false, "showAlways": false }'

Create a new announcement

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
managingEntityIdentifier
required
string
""

Create announcement for this property identifier

Example 
hotel-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
startDate

Start date for when announcement is valid

string format: date
""
Example 
2022-10-24
endDate

End date for when announcement is no longer valid

string format: date
""
Example 
2022-11-25
descriptions
required

List of all localized announcements.

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
showTitle

When enabled, the property does not want the title to be displayed

boolean
Example 
true
showAlways

When enabled, the property wants this announcement always to be displayed

boolean
Example 
true

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

Hotel identifier manager has access to.

string format: uuid
"" >= 1 characters
startDate

Start date for when announcement is valid

string format: date
""
endDate

End date for when announcement is no longer valid

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 enabled, the property does not want the title to be displayed

boolean
showAlways

When enabled, the property wants this announcement always to be displayed

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

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