POST /service/api/notifications/subscriptions/{subscriptionId}/position

Generates a position token which can be used to start fetching notifications.

Request Information

URI Parameters

NameDescriptionTypeAdditional Information
subscriptionId

The identifier of the subscription this positional token should refer to.

 string

Required

URI Sample(s)

POST
https://unityapi.webrootcloudav.com/service/api/notifications/subscriptions/1b399e9d-2083-4021-aaa4-30e1a9d385dd/position

Body Parameters

Details on where the position should point to in Unity's notification queue.

GeneratePositionRequestModel
NameDescriptionTypeAdditional Information
PositionType

The type of position which should be created. This can be one of the following values:

  • "new" = Start at the most current position (excluding the latest notification)
  • "latest" = Start at the most current position (including the latest notification)
  • "date" = Start with the first event that occurred at or after the date specified in StartDate
  • "horizon" = Start at the oldest event available
Note that when starting at historical events (applicable to "date" and "horizon") the notifications you get may be several days old. Due to the fact that event notifications are only stored for a certain amount of time, older events will be discarded after a while, no matter whether they have been fetched or not. Therefore please ensure to fetch your notifications in time.

 string

Required
StartDate

The event date to start reading from. Only applicable, if a PositionType of "date" was specified. Please keep in mind that StartDate relates to the time an event was made available to the Unity API systems. When receiving notifications with such a date-based starting position, the response may include events with a slightly earlier event time than specified in StartDate.

 date

None.

Sample Request

{
  "PositionType": "date",
  "StartDate": "2024-12-20T17:00:00"
}                    
<GeneratePositionRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.Notifications.Models">
  <PositionType>date</PositionType>
  <StartDate>2024-12-20T17:00:00</StartDate>
</GeneratePositionRequestModel>

Response Information

Resource Description

A positional token which can be used in a fetch call.

GeneratePositionResponseModel
NameDescriptionTypeAdditional Information
Position

The start position which corresponds to the request parameters. This position can be used in subsequent notification fetch requests.

 string

None.

Sample Response

{
  "Position": "5kSfGOdEnxjmwVSG4yHdCNIEAAAAAAAAMjI0NTU4NmYtNzg0MS00YmE1LTg2ZGYtNTVlYTQ5YWQ4MjZj"
}                    
<GeneratePositionResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.Notifications.Models">
  <Position>5kSfGOdEnxjmwVSG4yHdCNIEAAAAAAAAMjI0NTU4NmYtNzg0MS00YmE1LTg2ZGYtNTVlYTQ5YWQ4MjZj</Position>
</GeneratePositionResponseModel>