Show one for account

GET

/api/managing-entity/{managingEntityIdentifier}/message/{messageIdentifier}

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

• Endpoint

Retrieve a single notification belonging to the given managing entity by its identifier.

Authorizations

• oauth2ClientCredentials

Parameters

Path Parameters

managingEntityIdentifier

required

string

""

Managing entity identifier

Example

d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69

messageIdentifier

required

string

""

Message identifier to be retrieved

Example

b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47

Header Parameters

Wink-Version

string

default: 2.0.0

Allowed values: 2.0

Responses

200

Notification retrieved successfully

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

""

userIdentifier

required

Owner identifier

string format: uuid

"" >= 1 characters

managingEntityIdentifier

ManagingEntity identifier

string format: uuid

""

name

Owner name

string

""

priority

required

Importance of message

string

""

Allowed values: HIGH MEDIUM LOW

type

required

Message type

string

""

Allowed values: ALERT MESSAGE FEATURE

recipientType

required

Recipient type

string

""

Allowed values: USER ACCOUNT

messageTemplateId

required

Message template

string

"" >= 1 characters

subject

required

Subject of message

string

"" >= 1 characters

body

required

Body of message

string

"" >= 1 characters

ctaUrl

Path to feature

string

""

read

AffiliateAccount read announcement

boolean

markedAsRemoved

Message marked as removed

boolean

notifyViaEmail

Also send email announcement

boolean

Example

{
  "id": "",
  "createdDate": "",
  "lastUpdate": "",
  "version": "",
  "userIdentifier": "",
  "managingEntityIdentifier": "",
  "name": "",
  "priority": "HIGH",
  "type": "ALERT",
  "recipientType": "USER",
  "messageTemplateId": "",
  "subject": "",
  "body": "",
  "ctaUrl": "",
  "read": false,
  "markedAsRemoved": false,
  "notifyViaEmail": false
}

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

object

type

string format: uri

title

string

status

integer format: int32

detail

string

instance

string format: uri

properties

object

key

additional properties

object

type

string format: uri

title

string

status

integer format: int32

detail

string

instance

string format: uri

properties

object

key

additional properties

object

type

string format: uri

title

string

status

integer format: int32

detail

string

instance

string format: uri

properties

object

key

additional properties

object

type

string format: uri

title

string

status

integer format: int32

detail

string

instance

string format: uri

properties

object

key

additional properties

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

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

404

Notification not found

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

""

userIdentifier

required

Owner identifier

string format: uuid

"" >= 1 characters

managingEntityIdentifier

ManagingEntity identifier

string format: uuid

""

name

Owner name

string

""

priority

required

Importance of message

string

""

Allowed values: HIGH MEDIUM LOW

type

required

Message type

string

""

Allowed values: ALERT MESSAGE FEATURE

recipientType

required

Recipient type

string

""

Allowed values: USER ACCOUNT

messageTemplateId

required

Message template

string

"" >= 1 characters

subject

required

Subject of message

string

"" >= 1 characters

body

required

Body of message

string

"" >= 1 characters

ctaUrl

Path to feature

string

""

read

AffiliateAccount read announcement

boolean

markedAsRemoved

Message marked as removed

boolean

notifyViaEmail

Also send email announcement

boolean

Example

{
  "id": "",
  "createdDate": "",
  "lastUpdate": "",
  "version": "",
  "userIdentifier": "",
  "managingEntityIdentifier": "",
  "name": "",
  "priority": "HIGH",
  "type": "ALERT",
  "recipientType": "USER",
  "messageTemplateId": "",
  "subject": "",
  "body": "",
  "ctaUrl": "",
  "read": false,
  "markedAsRemoved": false,
  "notifyViaEmail": false
}

500

Internal Server Error

object

Example ^generated

{}

object

object

object

object