Skip to content
Wink

Show Activity Stream

GET
/api/activity-stream/{entityIdentifier}/list
 
curl --request GET \
  --url https://api.wink.travel/api/activity-stream//list \
  --header 'Wink-Version: 2.0'

Displays activity stream for specified entity ID.

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
entityIdentifier
required
string
""

ID of entity to retrieve stream for

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

Who can track this stream?

string
""
Allowed values: EVERYONE AUTHENTICATED OWNER ADMIN
entityIdentifier
required

ID of tracked entity

string format: uuid
"" >= 1 characters
emotion

Optional emotion. The actual implementation of the emotion is down to the consumer of the stream.

string
""
comment

Optional comment. For when the activity was created manually by a user. If i18nKey is not populated, comment is required.

string
""
i18nKey
required

Localized key. Key will be used to generate text on the front-end. If comment is not populated, i18n is required.

string
"" >= 1 characters
attachmentId

Optional attachment. For when we allow users to upload documents to the activity via Cloudinary.

string
""
user

Optional user. Attached when an authenticated user is available in the context of the activity.

object
userIdentifier
required

User ID of authenticated person that created the stream.

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

Full name of user.

string
"" >= 1 characters
profilePictureUrl

Optional url of user’s profile picture

string
""
Example 
[
  {
    "id": "",
    "createdDate": "",
    "lastUpdate": "",
    "version": "",
    "acl": "EVERYONE",
    "entityIdentifier": "",
    "emotion": "",
    "comment": "",
    "i18nKey": "",
    "attachmentId": "",
    "user": ""
  }
]

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