GET api/v1/notificationLists

Retrieves the Notification Lists associated with current user's TotalConnect account

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

AllNotificationListsResults

GetAllNotificationListsResults

Name	Type	Additional information
NotificationListCollection	Collection of NotificationListBaseInfo	None.
ResultCode	integer	None.
ResultData	string	None.

Response Formats

application/json, text/json

Sample:

{
  "NotificationListCollection": [
    {
      "NotificationListID": 1,
      "NotificationListName": "sample string 2",
      "IsNotificationListEnabled": true,
      "IsInUse": true,
      "AssociatedUsers": [
        {
          "UserID": 1
        },
        {
          "UserID": 1
        }
      ]
    },
    {
      "NotificationListID": 1,
      "NotificationListName": "sample string 2",
      "IsNotificationListEnabled": true,
      "IsInUse": true,
      "AssociatedUsers": [
        {
          "UserID": 1
        },
        {
          "UserID": 1
        }
      ]
    }
  ],
  "ResultCode": 1,
  "ResultData": "sample string 2"
}

application/xml, text/xml

Sample:

<GetAllNotificationListsResults xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TC2API.Resource.Models.ResultData">
  <ResultCode xmlns="http://schemas.datacontract.org/2004/07/TC2Utilities.RestApi">1</ResultCode>
  <ResultData xmlns="http://schemas.datacontract.org/2004/07/TC2Utilities.RestApi">sample string 2</ResultData>
  <NotificationListCollection xmlns:d2p1="http://schemas.datacontract.org/2004/07/TC2Domain">
    <d2p1:NotificationListBaseInfo>
      <d2p1:AssociatedUsers xmlns:d4p1="http://schemas.datacontract.org/2004/07/TC2Domain.EventNotificationConfiguration">
        <d4p1:NotificationListUserInfo>
          <d4p1:UserID>1</d4p1:UserID>
        </d4p1:NotificationListUserInfo>
        <d4p1:NotificationListUserInfo>
          <d4p1:UserID>1</d4p1:UserID>
        </d4p1:NotificationListUserInfo>
      </d2p1:AssociatedUsers>
      <d2p1:IsInUse>true</d2p1:IsInUse>
      <d2p1:IsNotificationListEnabled>true</d2p1:IsNotificationListEnabled>
      <d2p1:NotificationListID>1</d2p1:NotificationListID>
      <d2p1:NotificationListName>sample string 2</d2p1:NotificationListName>
    </d2p1:NotificationListBaseInfo>
    <d2p1:NotificationListBaseInfo>
      <d2p1:AssociatedUsers xmlns:d4p1="http://schemas.datacontract.org/2004/07/TC2Domain.EventNotificationConfiguration">
        <d4p1:NotificationListUserInfo>
          <d4p1:UserID>1</d4p1:UserID>
        </d4p1:NotificationListUserInfo>
        <d4p1:NotificationListUserInfo>
          <d4p1:UserID>1</d4p1:UserID>
        </d4p1:NotificationListUserInfo>
      </d2p1:AssociatedUsers>
      <d2p1:IsInUse>true</d2p1:IsInUse>
      <d2p1:IsNotificationListEnabled>true</d2p1:IsNotificationListEnabled>
      <d2p1:NotificationListID>1</d2p1:NotificationListID>
      <d2p1:NotificationListName>sample string 2</d2p1:NotificationListName>
    </d2p1:NotificationListBaseInfo>
  </NotificationListCollection>
</GetAllNotificationListsResults>