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

Returns the logged in users specific notification settings by Id.

Request Information

URI Parameters

NameDescriptionTypeAdditional 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
NameDescriptionTypeAdditional 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": "e2a9a9ad-c803-46f6-94fd-99c5b62d2add",
  "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": [
      "ca96dcdd-21b7-46d3-b36f-67b608e2afb4",
      "3620470b-5322-4922-9fb8-e9a4743a92fd"
    ],
    "UserOrDeviceTag": "sample string 4"
  },
  "AlertNotificationFilter": {
    "MyAlertsOnly": true,
    "OnWarning": true,
    "OnError": true,
    "OnCritical": true,
    "ActionRequired": true
  },
  "UserReportingNotificationFilter": {
    "UserOrDeviceIds": [
      "5592256c-0432-4ab7-931e-55efbd600e17",
      "dff85852-0201-4972-b869-ccb9618cca32"
    ],
    "UserOrDeviceTag": "sample string 1"
  },
  "UserNotReportingNotificationFilter": {
    "UserOrDeviceIds": [
      "3a0ccf70-b542-4e3b-a479-be9d927a24c6",
      "e608676f-5f0f-4732-a2a3-d32866c655ae"
    ],
    "UserOrDeviceTag": "sample string 1"
  },
  "MeasurementOutOfRangeFilter": {
    "FieldTag": "sample string 1",
    "FieldName": "sample string 2",
    "IsAboveWorkingRange": true,
    "IsBelowWorkingRange": true,
    "IsAboveErrorRange": true,
    "IsBelowErrorRange": true,
    "TriggerAfterCount": 7,
    "UserOrDeviceIds": [
      "72962a5b-037f-4bc7-a3b7-1d0ff6895892",
      "addcbcf9-1bb0-461d-8271-dbcbee38b7c9"
    ],
    "UserOrDeviceTag": "sample string 8"
  },
  "ExportCreatedNotificationFilter": {
    "AllExports": true,
    "ExportId": "0f5fce9a-9fbd-4087-a344-1426513bc481",
    "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": "364a91aa-7a18-4478-97e1-a46d27879216",
    "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": "d622b636-5de3-4d75-b6bb-fe78eb261f0f",
    "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": "3922f550-ad00-4c57-a219-0a21eb56b238",
    "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": "64c84b50-3d96-418c-b942-341689d3a9e3",
      "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"
    ],
    "Enabled": true
  },
  "Triggered": true,
  "RetriggerSettings": {
    "Option": 0,
    "AutoResetEnabled": true,
    "AutoResetAfterMinutes": 2.1,
    "AutoResetAfter": "00:00:00.1234567"
  },
  "TriggerResetsAt": "2017-06-26T17:11:11.6933561+00:00",
  "TriggeredAt": "2017-06-26T17:11:11.6933561+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>0f5fce9a-9fbd-4087-a344-1426513bc481</d2p1:ExportId>
  </ExportCreatedNotificationFilter>
  <Id>e2a9a9ad-c803-46f6-94fd-99c5b62d2add</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>72962a5b-037f-4bc7-a3b7-1d0ff6895892</d3p1:guid>
      <d3p1:guid>addcbcf9-1bb0-461d-8271-dbcbee38b7c9</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>d622b636-5de3-4d75-b6bb-fe78eb261f0f</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: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>64c84b50-3d96-418c-b942-341689d3a9e3</d3p1:Id>
    </d2p1:ActivateSceneRequestSettings>
    <d2p1:BreatheEffectSettings xmlns:d3p1="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.UserNotificationSettings.Actions.LifxSettings" />
    <d2p1:LifxBotUserId>3922f550-ad00-4c57-a219-0a21eb56b238</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>364a91aa-7a18-4478-97e1-a46d27879216</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>ca96dcdd-21b7-46d3-b36f-67b608e2afb4</d3p1:guid>
      <d3p1:guid>3620470b-5322-4922-9fb8-e9a4743a92fd</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>2017-06-26T17:11:11.6933561+00:00</TriggerResetsAt>
  <Triggered>true</Triggered>
  <TriggeredAt>2017-06-26T17:11:11.6933561+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>3a0ccf70-b542-4e3b-a479-be9d927a24c6</d3p1:guid>
      <d3p1:guid>e608676f-5f0f-4732-a2a3-d32866c655ae</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>5592256c-0432-4ab7-931e-55efbd600e17</d3p1:guid>
      <d3p1:guid>dff85852-0201-4972-b869-ccb9618cca32</d3p1:guid>
    </d2p1:UserOrDeviceIds>
    <d2p1:UserOrDeviceTag>sample string 1</d2p1:UserOrDeviceTag>
  </UserReportingNotificationFilter>
</UserNotificationSettingsDto>