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

Returns the logged in users specific notification settings by Id.

Request Information

URI Parameters

Name	Description	Type	Additional information
userId	The User's Id	globally unique identifier	Required
id	The Notification Option Id to get.	globally unique identifier	Required

Body Parameters

None.

Response Information

Resource Description

UserNotificationSettingsDto

Name	Description	Type	Additional information
Id	Unique Id of these settings.	globally unique identifier	None.
Name	Friendly name for this notification	string	None.
NotifyOnAction	Action to notify on.	NotifyOnActionDto	None.
Enabled	If the notification is enabled (running)	boolean	None.
Suspended	If the notification is suspended due to rate limiting.	boolean	None.
Links		Collection of LinkDto	None.
Actions	Actions that can be taken on this notification (not to be confused with actions that are triggered)	Collection of LinkDto	None.
StatusPostNotificationFilter	Options for notifications watching users or devices.	StatusPostNotificationFilterDto	None.
AlertNotificationFilter	Options for notifications watching alerts.	AlertNotificationFilterDto	None.
UserReportingNotificationFilter		UserReportingNotificationFilterDto	None.
UserNotReportingNotificationFilter		UserNotReportingNotificationFilterDto	None.
MeasurementOutOfRangeFilter		MeasurementOutOfRangeFilterDto	None.
ExportCreatedNotificationFilter		ExportCreatedNotificationFilterDto	None.
SendEmailAction	Send an email for notification	SendEmailActionDto	None.
SendSmsAction	Send an email for notification	SendSmsActionDto	None.
SendToParticleAction	Send message to Particle.io to call a method on a particle device (Core, Photon, etc.)	SendToParticleActionDto	None.
PostStatusMessageAction	Post a status message to the timeline when the notificaiton is triggered.	PostStatusMessageActionDto	None.
RaiseAlertAction	Raise an alert when the notification is triggered	RaiseAlertActionDto	None.
SendLifxLightCommand	Send a command to LIFX to action a change in lighting.	LifxLightCommandActionDto	None.
Triggered	If this notification is in the triggered state for one or more devices.	boolean	None.
RetriggerSettings	How the notification re-triggers.	RetriggerSettingsDto	None.
TriggerResetsAt	When the trigger is expected to automatically reset.	date	None.
TriggeredAt	When this was triggered. This is the earliest trigger if their is more than one (e.g. many devices)	date	None.

Response Formats

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

Sample:

{
  "Id": "c62f33c9-7afd-4922-9ca4-73c15058f770",
  "Name": "sample string 2",
  "NotifyOnAction": "StatusMessagePosted",
  "Enabled": true,
  "Suspended": true,
  "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": [
    {
      "Href": "sample string 1",
      "Rel": "sample string 2",
      "Action": "sample string 3"
    },
    {
      "Href": "sample string 1",
      "Rel": "sample string 2",
      "Action": "sample string 3"
    }
  ],
  "StatusPostNotificationFilter": {
    "AllPosts": true,
    "ContainsText": "sample string 2",
    "ExactMatch": true,
    "UserOrDeviceIds": [
      "429f76b5-ff5e-4267-b591-dbac21a0edd6",
      "02298f66-5edf-467d-b042-b9dfa6acc9e6"
    ],
    "UserOrDeviceTag": "sample string 4"
  },
  "AlertNotificationFilter": {
    "MyAlertsOnly": true,
    "OnWarning": true,
    "OnError": true,
    "OnCritical": true,
    "ActionRequired": true
  },
  "UserReportingNotificationFilter": {
    "UserOrDeviceIds": [
      "4c6b15eb-7f42-4590-822c-6b9f488b0c52",
      "47bd51c5-728a-409b-8992-679a06366754"
    ],
    "UserOrDeviceTag": "sample string 1"
  },
  "UserNotReportingNotificationFilter": {
    "UserOrDeviceIds": [
      "8aad532c-8f10-425c-a596-c417b533fe34",
      "c74f54b0-5a8c-48b3-85e3-e58d76c88f5c"
    ],
    "UserOrDeviceTag": "sample string 1"
  },
  "MeasurementOutOfRangeFilter": {
    "FieldTag": "sample string 1",
    "FieldName": "sample string 2",
    "IsAboveWorkingRange": true,
    "IsBelowWorkingRange": true,
    "IsAboveErrorRange": true,
    "IsBelowErrorRange": true,
    "TriggerAfterCount": 7,
    "UserOrDeviceIds": [
      "71f94f25-e17c-47ce-8cef-5cba875cfe30",
      "7a22fd8d-0d26-4c88-bf6c-cb6a259e745d"
    ],
    "UserOrDeviceTag": "sample string 8"
  },
  "ExportCreatedNotificationFilter": {
    "AllExports": true,
    "ExportId": "49de4367-5a94-4c2b-b04a-e07878c3bd7c",
    "ByTag": "sample string 2"
  },
  "SendEmailAction": {
    "Subject": "sample string 1",
    "MessageHtml": "sample string 2",
    "Enabled": true
  },
  "SendSmsAction": {
    "Message": "sample string 1",
    "Enabled": true
  },
  "SendMqttMessageAction": {
    "Topic": "sample string 1",
    "Message": "sample string 2",
    "MessageBytes": "QEA=",
    "QosLevel": 64,
    "Retain": true,
    "Enabled": true
  },
  "SendToParticleAction": {
    "DeviceId": "7204dbaf-4c53-4dd0-ae4c-3fe7a7fc72dc",
    "MethodName": "sample string 2",
    "Args": [
      "sample string 1",
      "sample string 2"
    ],
    "Enabled": true
  },
  "PostStatusMessageAction": {
    "Message": "sample string 1",
    "Tags": [
      "sample string 1",
      "sample string 2"
    ],
    "Enabled": true
  },
  "RaiseAlertAction": {
    "Message": "sample string 1",
    "AlertLevel": "Warning",
    "Tags": [
      "sample string 1",
      "sample string 2"
    ],
    "ToAll": true,
    "AssignToUserId": "9ab1d517-d5d8-475f-a73a-4de63a2beef5",
    "ActionRequired": true,
    "Enabled": true
  },
  "SendAwsSnsMessageAction": {
    "Topic": "sample string 1",
    "Enabled": true
  },
  "SendVoiceMessageAction": {
    "Message": "sample string 1",
    "Enabled": true
  },
  "SendWebHookAction": {
    "HttpMethod": "sample string 1",
    "Url": "sample string 2",
    "Enabled": true
  },
  "SendLifxLightCommand": {
    "Action": "sample string 1",
    "LifxBotUserId": "341c8202-f275-4296-8b0c-68a0b438413e",
    "TogglePowerSettings": {
      "Selector": "sample string 1",
      "Duration": 2
    },
    "SetStateSettings": {
      "Selector": "sample string 1",
      "Power": true,
      "Duration": 3,
      "Color": "sample string 4",
      "Brightness": 1.1
    },
    "PulseEffectSettings": {
      "Selector": "sample string 1",
      "FromColor": "sample string 2",
      "PowerOn": true,
      "Peak": 1.1,
      "Period": 1.1,
      "Cycles": 1,
      "Color": "sample string 3"
    },
    "BreatheEffectSettings": {},
    "ActivateSceneRequestSettings": {
      "Id": "23640ce6-996e-40f7-b5b1-62cadf813227",
      "Duration": 2
    },
    "Enabled": true
  },
  "SendIftttEvent": {
    "Url": "sample string 1",
    "EventName": "sample string 2",
    "Value1": "sample string 3",
    "Value2": "sample string 4",
    "Value3": "sample string 5",
    "Tags": [
      "sample string 1",
      "sample string 2"
    ],
    "ServiceKey": "sample string 6",
    "Enabled": true
  },
  "Triggered": true,
  "RetriggerSettings": {
    "Option": 0,
    "AutoResetEnabled": true,
    "AutoResetAfterMinutes": 2.1,
    "AutoResetAfter": "00:00:00.1234567"
  },
  "TriggerResetsAt": "2020-01-21T23:13:41.1504599+00:00",
  "TriggeredAt": "2020-01-21T23:13:41.1504599+00:00"
}

application/xml, text/xml

Sample:

<UserNotificationSettingsDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.UserNotificationSettings">
  <Actions xmlns:d2p1="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Shared">
    <d2p1:LinkViewModel>
      <d2p1:Action>sample string 3</d2p1:Action>
      <d2p1:Href>sample string 1</d2p1:Href>
      <d2p1:Rel>sample string 2</d2p1:Rel>
    </d2p1:LinkViewModel>
    <d2p1:LinkViewModel>
      <d2p1:Action>sample string 3</d2p1:Action>
      <d2p1:Href>sample string 1</d2p1:Href>
      <d2p1:Rel>sample string 2</d2p1:Rel>
    </d2p1:LinkViewModel>
  </Actions>
  <AlertNotificationFilter xmlns:d2p1="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.UserNotificationSettings.Filters">
    <d2p1:ActionRequired>true</d2p1:ActionRequired>
    <d2p1:MyAlertsOnly>true</d2p1:MyAlertsOnly>
    <d2p1:OnCritical>true</d2p1:OnCritical>
    <d2p1:OnError>true</d2p1:OnError>
    <d2p1:OnWarning>true</d2p1:OnWarning>
  </AlertNotificationFilter>
  <Enabled>true</Enabled>
  <ExportCreatedNotificationFilter xmlns:d2p1="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.UserNotificationSettings.Filters">
    <d2p1:AllExports>true</d2p1:AllExports>
    <d2p1:ByTag>sample string 2</d2p1:ByTag>
    <d2p1:ExportId>49de4367-5a94-4c2b-b04a-e07878c3bd7c</d2p1:ExportId>
  </ExportCreatedNotificationFilter>
  <Id>c62f33c9-7afd-4922-9ca4-73c15058f770</Id>
  <Links xmlns:d2p1="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Shared">
    <d2p1:LinkViewModel>
      <d2p1:Action>sample string 3</d2p1:Action>
      <d2p1:Href>sample string 1</d2p1:Href>
      <d2p1:Rel>sample string 2</d2p1:Rel>
    </d2p1:LinkViewModel>
    <d2p1:LinkViewModel>
      <d2p1:Action>sample string 3</d2p1:Action>
      <d2p1:Href>sample string 1</d2p1:Href>
      <d2p1:Rel>sample string 2</d2p1:Rel>
    </d2p1:LinkViewModel>
  </Links>
  <MeasurementOutOfRangeFilter xmlns:d2p1="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.UserNotificationSettings.Filters">
    <d2p1:UserOrDeviceIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:guid>71f94f25-e17c-47ce-8cef-5cba875cfe30</d3p1:guid>
      <d3p1:guid>7a22fd8d-0d26-4c88-bf6c-cb6a259e745d</d3p1:guid>
    </d2p1:UserOrDeviceIds>
    <d2p1:UserOrDeviceTag>sample string 8</d2p1:UserOrDeviceTag>
    <d2p1:FieldName>sample string 2</d2p1:FieldName>
    <d2p1:FieldTag>sample string 1</d2p1:FieldTag>
    <d2p1:IsAboveErrorRange>true</d2p1:IsAboveErrorRange>
    <d2p1:IsAboveWorkingRange>true</d2p1:IsAboveWorkingRange>
    <d2p1:IsBelowErrorRange>true</d2p1:IsBelowErrorRange>
    <d2p1:IsBelowWorkingRange>true</d2p1:IsBelowWorkingRange>
    <d2p1:TriggerAfterCount>7</d2p1:TriggerAfterCount>
  </MeasurementOutOfRangeFilter>
  <Name>sample string 2</Name>
  <NotifyOnAction>StatusMessagePosted</NotifyOnAction>
  <PostStatusMessageAction xmlns:d2p1="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.UserNotificationSettings.Actions">
    <d2p1:Enabled>true</d2p1:Enabled>
    <d2p1:Message>sample string 1</d2p1:Message>
    <d2p1:Tags xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </d2p1:Tags>
  </PostStatusMessageAction>
  <RaiseAlertAction xmlns:d2p1="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.UserNotificationSettings.Actions">
    <d2p1:Enabled>true</d2p1:Enabled>
    <d2p1:ActionRequired>true</d2p1:ActionRequired>
    <d2p1:AlertLevel>Warning</d2p1:AlertLevel>
    <d2p1:AssignToUserId>9ab1d517-d5d8-475f-a73a-4de63a2beef5</d2p1:AssignToUserId>
    <d2p1:Message>sample string 1</d2p1:Message>
    <d2p1:Tags xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </d2p1:Tags>
    <d2p1:ToAll>true</d2p1:ToAll>
  </RaiseAlertAction>
  <RetriggerSettings xmlns:d2p1="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.UserNotificationSettings.Filters">
    <d2p1:AutoResetAfter>PT0.1234567S</d2p1:AutoResetAfter>
    <d2p1:AutoResetAfterMinutes>2.1</d2p1:AutoResetAfterMinutes>
    <d2p1:AutoResetEnabled>true</d2p1:AutoResetEnabled>
    <d2p1:Option>EveryTime</d2p1:Option>
  </RetriggerSettings>
  <SendAwsSnsMessageAction xmlns:d2p1="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.UserNotificationSettings.Actions">
    <d2p1:Enabled>true</d2p1:Enabled>
    <d2p1:Topic>sample string 1</d2p1:Topic>
  </SendAwsSnsMessageAction>
  <SendEmailAction xmlns:d2p1="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.UserNotificationSettings.Actions">
    <d2p1:Enabled>true</d2p1:Enabled>
    <d2p1:MessageHtml>sample string 2</d2p1:MessageHtml>
    <d2p1:Subject>sample string 1</d2p1:Subject>
  </SendEmailAction>
  <SendIftttEvent xmlns:d2p1="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.UserNotificationSettings.Actions">
    <d2p1:Enabled>true</d2p1:Enabled>
    <d2p1:EventName>sample string 2</d2p1:EventName>
    <d2p1:ServiceKey>sample string 6</d2p1:ServiceKey>
    <d2p1:Tags xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </d2p1:Tags>
    <d2p1:Url>sample string 1</d2p1:Url>
    <d2p1:Value1>sample string 3</d2p1:Value1>
    <d2p1:Value2>sample string 4</d2p1:Value2>
    <d2p1:Value3>sample string 5</d2p1:Value3>
  </SendIftttEvent>
  <SendLifxLightCommand xmlns:d2p1="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.UserNotificationSettings.Actions">
    <d2p1:Enabled>true</d2p1:Enabled>
    <d2p1:Action>sample string 1</d2p1:Action>
    <d2p1:ActivateSceneRequestSettings xmlns:d3p1="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.UserNotificationSettings.Actions.LifxSettings">
      <d3p1:Duration>2</d3p1:Duration>
      <d3p1:Id>23640ce6-996e-40f7-b5b1-62cadf813227</d3p1:Id>
    </d2p1:ActivateSceneRequestSettings>
    <d2p1:BreatheEffectSettings xmlns:d3p1="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.UserNotificationSettings.Actions.LifxSettings" />
    <d2p1:LifxBotUserId>341c8202-f275-4296-8b0c-68a0b438413e</d2p1:LifxBotUserId>
    <d2p1:PulseEffectSettings xmlns:d3p1="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.UserNotificationSettings.Actions.LifxSettings">
      <d3p1:Color>sample string 3</d3p1:Color>
      <d3p1:Cycles>1</d3p1:Cycles>
      <d3p1:FromColor>sample string 2</d3p1:FromColor>
      <d3p1:Peak>1.1</d3p1:Peak>
      <d3p1:Period>1.1</d3p1:Period>
      <d3p1:PowerOn>true</d3p1:PowerOn>
      <d3p1:Selector>sample string 1</d3p1:Selector>
    </d2p1:PulseEffectSettings>
    <d2p1:SetStateSettings xmlns:d3p1="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.UserNotificationSettings.Actions.LifxSettings">
      <d3p1:Brightness>1.1</d3p1:Brightness>
      <d3p1:Color>sample string 4</d3p1:Color>
      <d3p1:Duration>3</d3p1:Duration>
      <d3p1:Power>true</d3p1:Power>
      <d3p1:Selector>sample string 1</d3p1:Selector>
    </d2p1:SetStateSettings>
    <d2p1:TogglePowerSettings xmlns:d3p1="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.UserNotificationSettings.Actions.LifxSettings">
      <d3p1:Duration>2</d3p1:Duration>
      <d3p1:Selector>sample string 1</d3p1:Selector>
    </d2p1:TogglePowerSettings>
  </SendLifxLightCommand>
  <SendMqttMessageAction xmlns:d2p1="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.UserNotificationSettings.Actions">
    <d2p1:Enabled>true</d2p1:Enabled>
    <d2p1:Message>sample string 2</d2p1:Message>
    <d2p1:MessageBytes>QEA=</d2p1:MessageBytes>
    <d2p1:QosLevel>64</d2p1:QosLevel>
    <d2p1:Retain>true</d2p1:Retain>
    <d2p1:Topic>sample string 1</d2p1:Topic>
  </SendMqttMessageAction>
  <SendSmsAction xmlns:d2p1="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.UserNotificationSettings.Actions">
    <d2p1:Enabled>true</d2p1:Enabled>
    <d2p1:Message>sample string 1</d2p1:Message>
  </SendSmsAction>
  <SendToParticleAction xmlns:d2p1="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.UserNotificationSettings.Actions">
    <d2p1:Enabled>true</d2p1:Enabled>
    <d2p1:Args xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </d2p1:Args>
    <d2p1:DeviceId>7204dbaf-4c53-4dd0-ae4c-3fe7a7fc72dc</d2p1:DeviceId>
    <d2p1:MethodName>sample string 2</d2p1:MethodName>
  </SendToParticleAction>
  <SendVoiceMessageAction xmlns:d2p1="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.UserNotificationSettings.Actions">
    <d2p1:Enabled>true</d2p1:Enabled>
    <d2p1:Message>sample string 1</d2p1:Message>
  </SendVoiceMessageAction>
  <SendWebHookAction xmlns:d2p1="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.UserNotificationSettings.Actions">
    <d2p1:Enabled>true</d2p1:Enabled>
    <d2p1:HttpMethod>sample string 1</d2p1:HttpMethod>
    <d2p1:Url>sample string 2</d2p1:Url>
  </SendWebHookAction>
  <StatusPostNotificationFilter xmlns:d2p1="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.UserNotificationSettings.Filters">
    <d2p1:UserOrDeviceIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:guid>429f76b5-ff5e-4267-b591-dbac21a0edd6</d3p1:guid>
      <d3p1:guid>02298f66-5edf-467d-b042-b9dfa6acc9e6</d3p1:guid>
    </d2p1:UserOrDeviceIds>
    <d2p1:UserOrDeviceTag>sample string 4</d2p1:UserOrDeviceTag>
    <d2p1:AllPosts>true</d2p1:AllPosts>
    <d2p1:ContainsText>sample string 2</d2p1:ContainsText>
    <d2p1:ExactMatch>true</d2p1:ExactMatch>
  </StatusPostNotificationFilter>
  <Suspended>true</Suspended>
  <TriggerResetsAt>2020-01-21T23:13:41.1504599+00:00</TriggerResetsAt>
  <Triggered>true</Triggered>
  <TriggeredAt>2020-01-21T23:13:41.1504599+00:00</TriggeredAt>
  <UserNotReportingNotificationFilter xmlns:d2p1="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.UserNotificationSettings.Filters">
    <d2p1:UserOrDeviceIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:guid>8aad532c-8f10-425c-a596-c417b533fe34</d3p1:guid>
      <d3p1:guid>c74f54b0-5a8c-48b3-85e3-e58d76c88f5c</d3p1:guid>
    </d2p1:UserOrDeviceIds>
    <d2p1:UserOrDeviceTag>sample string 1</d2p1:UserOrDeviceTag>
  </UserNotReportingNotificationFilter>
  <UserReportingNotificationFilter xmlns:d2p1="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.UserNotificationSettings.Filters">
    <d2p1:UserOrDeviceIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:guid>4c6b15eb-7f42-4590-822c-6b9f488b0c52</d3p1:guid>
      <d3p1:guid>47bd51c5-728a-409b-8992-679a06366754</d3p1:guid>
    </d2p1:UserOrDeviceIds>
    <d2p1:UserOrDeviceTag>sample string 1</d2p1:UserOrDeviceTag>
  </UserReportingNotificationFilter>
</UserNotificationSettingsDto>