POST Users/UpdateSubscribedEvents

Updates the user's subscribed events. Note: You MUST pass all subscribed events for the user to this endpoint.

Request Information

URI Parameters

None.

Body Parameters

Collection of UserEventSubscriptionDTO
NameDescriptionTypeAdditional information
UserID

ID of the user

globally unique identifier

None.

EventID

ID of the event

globally unique identifier

None.

LastRunTime

Event last run time

date

None.

NextDueTime

Event nxt due time

date

None.

Frequency

Frequency

Frequencies

None.

FrequencyForMy

Frequency for My Notifications

Frequencies

None.

Request Formats

application/json, text/json

Sample:
{
  "results": [
    {
      "UserID": "1b9fba3e-9036-4a13-b04f-0dca4f3781c6",
      "EventID": "45fdff82-4e25-465a-89d6-88f75aebab0d",
      "LastRunTime": "2024-05-14T10:04:40Z",
      "NextDueTime": "2024-05-14T10:04:40Z",
      "Frequency": 0,
      "FrequencyForMy": 0
    },
    {
      "UserID": "1b9fba3e-9036-4a13-b04f-0dca4f3781c6",
      "EventID": "45fdff82-4e25-465a-89d6-88f75aebab0d",
      "LastRunTime": "2024-05-14T10:04:40Z",
      "NextDueTime": "2024-05-14T10:04:40Z",
      "Frequency": 0,
      "FrequencyForMy": 0
    }
  ]
}

text/javascript

Sample:
{"results":[{"UserID":"1b9fba3e-9036-4a13-b04f-0dca4f3781c6","EventID":"45fdff82-4e25-465a-89d6-88f75aebab0d","LastRunTime":"2024-05-14T10:04:40Z","NextDueTime":"2024-05-14T10:04:40Z","Frequency":0,"FrequencyForMy":0},{"UserID":"1b9fba3e-9036-4a13-b04f-0dca4f3781c6","EventID":"45fdff82-4e25-465a-89d6-88f75aebab0d","LastRunTime":"2024-05-14T10:04:40Z","NextDueTime":"2024-05-14T10:04:40Z","Frequency":0,"FrequencyForMy":0}]}

application/bson

Sample:
Binary JSON content. See http://bsonspec.org for details.

application/xml, text/xml

Sample:
<ArrayOfUserEventSubscriptionDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Lpp.Dns.DTO">
  <UserEventSubscriptionDTO>
    <EventID>45fdff82-4e25-465a-89d6-88f75aebab0d</EventID>
    <Frequency>Immediately</Frequency>
    <FrequencyForMy>Immediately</FrequencyForMy>
    <LastRunTime xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2024-05-14T14:04:40.5681598Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>-240</d3p1:OffsetMinutes>
    </LastRunTime>
    <NextDueTime xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2024-05-14T14:04:40.5681598Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>-240</d3p1:OffsetMinutes>
    </NextDueTime>
    <UserID>1b9fba3e-9036-4a13-b04f-0dca4f3781c6</UserID>
  </UserEventSubscriptionDTO>
  <UserEventSubscriptionDTO>
    <EventID>45fdff82-4e25-465a-89d6-88f75aebab0d</EventID>
    <Frequency>Immediately</Frequency>
    <FrequencyForMy>Immediately</FrequencyForMy>
    <LastRunTime xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2024-05-14T14:04:40.5681598Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>-240</d3p1:OffsetMinutes>
    </LastRunTime>
    <NextDueTime xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2024-05-14T14:04:40.5681598Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>-240</d3p1:OffsetMinutes>
    </NextDueTime>
    <UserID>1b9fba3e-9036-4a13-b04f-0dca4f3781c6</UserID>
  </UserEventSubscriptionDTO>
</ArrayOfUserEventSubscriptionDTO>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.