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

Request Information

URI Parameters

Name	Description	Type	Additional information
userId		string	None.

Body Parameters

None.

Response Information

Resource Description

NotificationOptionsDto

Name	Description	Type	Additional information
NotifyOnActions	Describes the actions that can be notified on.	Collection of NotifyOnActionOptionDto	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"
        }
      ],
      "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"
            }
          ],
          "DefaultSubject": "sample string 4",
          "DefaultMessage": "sample string 5"
        },
        {
          "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"
            }
          ],
          "DefaultSubject": "sample string 4",
          "DefaultMessage": "sample string 5"
        }
      ],
      "ReplaceableTokens": [
        {
          "Token": "sample string 1",
          "Description": "sample string 2"
        },
        {
          "Token": "sample string 1",
          "Description": "sample string 2"
        }
      ],
      "HasFilterOptions": true,
      "FilterOnUsers": true,
      "FilterOnTags": true,
      "IsRealTime": true
    },
    {
      "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"
            }
          ],
          "DefaultSubject": "sample string 4",
          "DefaultMessage": "sample string 5"
        },
        {
          "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"
            }
          ],
          "DefaultSubject": "sample string 4",
          "DefaultMessage": "sample string 5"
        }
      ],
      "ReplaceableTokens": [
        {
          "Token": "sample string 1",
          "Description": "sample string 2"
        },
        {
          "Token": "sample string 1",
          "Description": "sample string 2"
        }
      ],
      "HasFilterOptions": true,
      "FilterOnUsers": true,
      "FilterOnTags": true,
      "IsRealTime": true
    }
  ]
}

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">
  <NotifyOnActions>
    <NotifyOnActionOptionDto>
      <Actions>
        <ActionOptionsDto>
          <DefaultMessage>sample string 5</DefaultMessage>
          <DefaultSubject>sample string 4</DefaultSubject>
          <Description>sample string 3</Description>
          <Label>sample string 2</Label>
          <Links xmlns:d6p1="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Shared">
            <d6p1:LinkViewModel>
              <d6p1:Action>sample string 3</d6p1:Action>
              <d6p1:Href>sample string 1</d6p1:Href>
              <d6p1:Rel>sample string 2</d6p1:Rel>
            </d6p1:LinkViewModel>
            <d6p1:LinkViewModel>
              <d6p1:Action>sample string 3</d6p1:Action>
              <d6p1:Href>sample string 1</d6p1:Href>
              <d6p1:Rel>sample string 2</d6p1:Rel>
            </d6p1:LinkViewModel>
          </Links>
          <Type>sample string 1</Type>
        </ActionOptionsDto>
        <ActionOptionsDto>
          <DefaultMessage>sample string 5</DefaultMessage>
          <DefaultSubject>sample string 4</DefaultSubject>
          <Description>sample string 3</Description>
          <Label>sample string 2</Label>
          <Links xmlns:d6p1="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Shared">
            <d6p1:LinkViewModel>
              <d6p1:Action>sample string 3</d6p1:Action>
              <d6p1:Href>sample string 1</d6p1:Href>
              <d6p1:Rel>sample string 2</d6p1:Rel>
            </d6p1:LinkViewModel>
            <d6p1:LinkViewModel>
              <d6p1:Action>sample string 3</d6p1:Action>
              <d6p1:Href>sample string 1</d6p1:Href>
              <d6p1:Rel>sample string 2</d6p1:Rel>
            </d6p1:LinkViewModel>
          </Links>
          <Type>sample string 1</Type>
        </ActionOptionsDto>
      </Actions>
      <Description>sample string 2</Description>
      <FilterOnTags>true</FilterOnTags>
      <FilterOnUsers>true</FilterOnUsers>
      <HasFilterOptions>true</HasFilterOptions>
      <IsRealTime>true</IsRealTime>
      <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>
      <ReplaceableTokens>
        <ReplaceableTokenDto>
          <Description>sample string 2</Description>
          <Token>sample string 1</Token>
        </ReplaceableTokenDto>
        <ReplaceableTokenDto>
          <Description>sample string 2</Description>
          <Token>sample string 1</Token>
        </ReplaceableTokenDto>
      </ReplaceableTokens>
    </NotifyOnActionOptionDto>
    <NotifyOnActionOptionDto>
      <Actions>
        <ActionOptionsDto>
          <DefaultMessage>sample string 5</DefaultMessage>
          <DefaultSubject>sample string 4</DefaultSubject>
          <Description>sample string 3</Description>
          <Label>sample string 2</Label>
          <Links xmlns:d6p1="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Shared">
            <d6p1:LinkViewModel>
              <d6p1:Action>sample string 3</d6p1:Action>
              <d6p1:Href>sample string 1</d6p1:Href>
              <d6p1:Rel>sample string 2</d6p1:Rel>
            </d6p1:LinkViewModel>
            <d6p1:LinkViewModel>
              <d6p1:Action>sample string 3</d6p1:Action>
              <d6p1:Href>sample string 1</d6p1:Href>
              <d6p1:Rel>sample string 2</d6p1:Rel>
            </d6p1:LinkViewModel>
          </Links>
          <Type>sample string 1</Type>
        </ActionOptionsDto>
        <ActionOptionsDto>
          <DefaultMessage>sample string 5</DefaultMessage>
          <DefaultSubject>sample string 4</DefaultSubject>
          <Description>sample string 3</Description>
          <Label>sample string 2</Label>
          <Links xmlns:d6p1="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Shared">
            <d6p1:LinkViewModel>
              <d6p1:Action>sample string 3</d6p1:Action>
              <d6p1:Href>sample string 1</d6p1:Href>
              <d6p1:Rel>sample string 2</d6p1:Rel>
            </d6p1:LinkViewModel>
            <d6p1:LinkViewModel>
              <d6p1:Action>sample string 3</d6p1:Action>
              <d6p1:Href>sample string 1</d6p1:Href>
              <d6p1:Rel>sample string 2</d6p1:Rel>
            </d6p1:LinkViewModel>
          </Links>
          <Type>sample string 1</Type>
        </ActionOptionsDto>
      </Actions>
      <Description>sample string 2</Description>
      <FilterOnTags>true</FilterOnTags>
      <FilterOnUsers>true</FilterOnUsers>
      <HasFilterOptions>true</HasFilterOptions>
      <IsRealTime>true</IsRealTime>
      <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>
      <ReplaceableTokens>
        <ReplaceableTokenDto>
          <Description>sample string 2</Description>
          <Token>sample string 1</Token>
        </ReplaceableTokenDto>
        <ReplaceableTokenDto>
          <Description>sample string 2</Description>
          <Token>sample string 1</Token>
        </ReplaceableTokenDto>
      </ReplaceableTokens>
    </NotifyOnActionOptionDto>
  </NotifyOnActions>
</NotificationOptionsDto>