Documentation

GET /service/api/notifications/subscriptions/eventtypes

Gets a list of available event types that can be subscribed to, with information on required scope permissions and subscription domains for each event type.

Request Information

URI Parameters

None.

URI Sample(s)

GET	https://unityapi.webrootcloudav.com/service/api/notifications/subscriptions/eventtypes

Body Parameters

None.

Response Information

Resource Description

List of available event types.

GetEventTypesResponseModel

Name	Description	Type	Additional Information
Count	The total number of available event types.	integer	None.
EventTypes	The list of supported event types.	Collection of GetEventTypesResponseModelEventType	None.

Sample Response

{
  "Count": 2,
  "EventTypes": [
    {
      "EventType": "EventType_1",
      "Description": "EventType description",
      "Scopes": [
        "Console.GSM",
        "SkyStatus.GSM"
      ],
      "Domains": [
        {
          "Type": "GSM",
          "Values": [
            "GSMKey"
          ]
        },
        {
          "Type": "Site",
          "Values": [
            "GSMKey",
            "SiteKey"
          ]
        }
      ]
    },
    {
      "EventType": "EventType_2",
      "Description": "EventType description",
      "Scopes": [
        "Console.GSM",
        "SkyStatus.GSM"
      ],
      "Domains": [
        {
          "Type": "GSM",
          "Values": [
            "GSMKey"
          ]
        },
        {
          "Type": "Site",
          "Values": [
            "GSMKey",
            "SiteKey"
          ]
        }
      ]
    }
  ]
}

<GetEventTypesResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.Notifications.Models">
  <Count>2</Count>
  <EventTypes>
    <GetEventTypesResponseModelEventType>
      <Description>EventType description</Description>
      <Domains>
        <GetEventTypesResponseModelEventTypeDomain>
          <Type>GSM</Type>
          <Values xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>GSMKey</d6p1:string>
          </Values>
        </GetEventTypesResponseModelEventTypeDomain>
        <GetEventTypesResponseModelEventTypeDomain>
          <Type>Site</Type>
          <Values xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>GSMKey</d6p1:string>
            <d6p1:string>SiteKey</d6p1:string>
          </Values>
        </GetEventTypesResponseModelEventTypeDomain>
      </Domains>
      <EventType>EventType_1</EventType>
      <Scopes xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>Console.GSM</d4p1:string>
        <d4p1:string>SkyStatus.GSM</d4p1:string>
      </Scopes>
    </GetEventTypesResponseModelEventType>
    <GetEventTypesResponseModelEventType>
      <Description>EventType description</Description>
      <Domains>
        <GetEventTypesResponseModelEventTypeDomain>
          <Type>GSM</Type>
          <Values xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>GSMKey</d6p1:string>
          </Values>
        </GetEventTypesResponseModelEventTypeDomain>
        <GetEventTypesResponseModelEventTypeDomain>
          <Type>Site</Type>
          <Values xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>GSMKey</d6p1:string>
            <d6p1:string>SiteKey</d6p1:string>
          </Values>
        </GetEventTypesResponseModelEventTypeDomain>
      </Domains>
      <EventType>EventType_2</EventType>
      <Scopes xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>Console.GSM</d4p1:string>
        <d4p1:string>SkyStatus.GSM</d4p1:string>
      </Scopes>
    </GetEventTypesResponseModelEventType>
  </EventTypes>
</GetEventTypesResponseModel>