GET api/v1/user/{userId}/notificationSettings/options

Request Information

URI Parameters

NameDescriptionTypeAdditional information
userId

string

None.

Body Parameters

None.

Response Information

Resource Description

NotificationOptionsDto
NameDescriptionTypeAdditional information
NotifyOnActions

Describes the actions that can be notified on.

Collection of NotifyOnActionOptionDto

None.

Actions

Describes the possible actions that can be taken when the notification criteria are met.

Collection of ActionOptionsDto

None.

Response Formats

application/json, text/json, application/senml+json

Sample:
{
  "NotifyOnActions": [
    {
      "NotifyOnAction": "StatusMessagePosted",
      "Label": "sample string 1",
      "Description": "sample string 2",
      "Links": [
        {
          "Href": "sample string 1",
          "Rel": "sample string 2",
          "Action": "sample string 3"
        },
        {
          "Href": "sample string 1",
          "Rel": "sample string 2",
          "Action": "sample string 3"
        }
      ]
    },
    {
      "NotifyOnAction": "StatusMessagePosted",
      "Label": "sample string 1",
      "Description": "sample string 2",
      "Links": [
        {
          "Href": "sample string 1",
          "Rel": "sample string 2",
          "Action": "sample string 3"
        },
        {
          "Href": "sample string 1",
          "Rel": "sample string 2",
          "Action": "sample string 3"
        }
      ]
    }
  ],
  "Actions": [
    {
      "Type": "sample string 1",
      "Label": "sample string 2",
      "Description": "sample string 3",
      "Links": [
        {
          "Href": "sample string 1",
          "Rel": "sample string 2",
          "Action": "sample string 3"
        },
        {
          "Href": "sample string 1",
          "Rel": "sample string 2",
          "Action": "sample string 3"
        }
      ]
    },
    {
      "Type": "sample string 1",
      "Label": "sample string 2",
      "Description": "sample string 3",
      "Links": [
        {
          "Href": "sample string 1",
          "Rel": "sample string 2",
          "Action": "sample string 3"
        },
        {
          "Href": "sample string 1",
          "Rel": "sample string 2",
          "Action": "sample string 3"
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample:
<NotificationOptionsDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.UserNotificationOptions">
  <Actions>
    <ActionOptionsDto>
      <Description>sample string 3</Description>
      <Label>sample string 2</Label>
      <Links xmlns:d4p1="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Shared">
        <d4p1:LinkViewModel>
          <d4p1:Action>sample string 3</d4p1:Action>
          <d4p1:Href>sample string 1</d4p1:Href>
          <d4p1:Rel>sample string 2</d4p1:Rel>
        </d4p1:LinkViewModel>
        <d4p1:LinkViewModel>
          <d4p1:Action>sample string 3</d4p1:Action>
          <d4p1:Href>sample string 1</d4p1:Href>
          <d4p1:Rel>sample string 2</d4p1:Rel>
        </d4p1:LinkViewModel>
      </Links>
      <Type>sample string 1</Type>
    </ActionOptionsDto>
    <ActionOptionsDto>
      <Description>sample string 3</Description>
      <Label>sample string 2</Label>
      <Links xmlns:d4p1="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Shared">
        <d4p1:LinkViewModel>
          <d4p1:Action>sample string 3</d4p1:Action>
          <d4p1:Href>sample string 1</d4p1:Href>
          <d4p1:Rel>sample string 2</d4p1:Rel>
        </d4p1:LinkViewModel>
        <d4p1:LinkViewModel>
          <d4p1:Action>sample string 3</d4p1:Action>
          <d4p1:Href>sample string 1</d4p1:Href>
          <d4p1:Rel>sample string 2</d4p1:Rel>
        </d4p1:LinkViewModel>
      </Links>
      <Type>sample string 1</Type>
    </ActionOptionsDto>
  </Actions>
  <NotifyOnActions>
    <NotifyOnActionOptionDto>
      <Description>sample string 2</Description>
      <Label>sample string 1</Label>
      <Links xmlns:d4p1="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Shared">
        <d4p1:LinkViewModel>
          <d4p1:Action>sample string 3</d4p1:Action>
          <d4p1:Href>sample string 1</d4p1:Href>
          <d4p1:Rel>sample string 2</d4p1:Rel>
        </d4p1:LinkViewModel>
        <d4p1:LinkViewModel>
          <d4p1:Action>sample string 3</d4p1:Action>
          <d4p1:Href>sample string 1</d4p1:Href>
          <d4p1:Rel>sample string 2</d4p1:Rel>
        </d4p1:LinkViewModel>
      </Links>
      <NotifyOnAction>StatusMessagePosted</NotifyOnAction>
    </NotifyOnActionOptionDto>
    <NotifyOnActionOptionDto>
      <Description>sample string 2</Description>
      <Label>sample string 1</Label>
      <Links xmlns:d4p1="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Shared">
        <d4p1:LinkViewModel>
          <d4p1:Action>sample string 3</d4p1:Action>
          <d4p1:Href>sample string 1</d4p1:Href>
          <d4p1:Rel>sample string 2</d4p1:Rel>
        </d4p1:LinkViewModel>
        <d4p1:LinkViewModel>
          <d4p1:Action>sample string 3</d4p1:Action>
          <d4p1:Href>sample string 1</d4p1:Href>
          <d4p1:Rel>sample string 2</d4p1:Rel>
        </d4p1:LinkViewModel>
      </Links>
      <NotifyOnAction>StatusMessagePosted</NotifyOnAction>
    </NotifyOnActionOptionDto>
  </NotifyOnActions>
</NotificationOptionsDto>