GET api/v1/eventMetaDataV2/locations/{locationId}?additionalInput={additionalInput}

Get the Event Metadata applicable for the Given Location based on Partitions. Used for Notification Configuration Equivalent SOAP API: GetEventMetaDataExV2

Request Information

URI Parameters

NameDescriptionTypeAdditional information
locationId

Location ID

integer

Required

additionalInput

additionalInput

string

None.

Body Parameters

None.

Response Information

Resource Description

EventMetaDataExResult

EventMetaDataExResult
NameDescriptionTypeAdditional information
EventClassCollection

Collection of EventClass

None.

LocationLimitations

string

None.

LocationCameraList

Collection of CameraSimple

None.

SceneDeviceInfoList

Collection of SceneDeviceInfo

None.

ResultCode

integer

None.

ResultData

string

None.

Response Formats

application/json, text/json

Sample:
{
  "EventClassCollection": [
    {
      "EventClassID": 1,
      "EventClassDescription": "sample string 2",
      "EventGroupList": [
        {
          "EventGroupID": 1,
          "EventGroupName": "sample string 2"
        },
        {
          "EventGroupID": 1,
          "EventGroupName": "sample string 2"
        }
      ],
      "EventTypeCollection": [
        {
          "EventTypeID": 1,
          "EventGroupID": 2,
          "EventTypeDescription": "sample string 3",
          "EventTypeCapabilities": 511,
          "EventModifierCollection": [
            {
              "EventModifierID": 1,
              "EventModifierDescription": "sample string 2",
              "DeviceID": 3,
              "EventModifierType": "sample string 4",
              "PartitionId": 5
            },
            {
              "EventModifierID": 1,
              "EventModifierDescription": "sample string 2",
              "DeviceID": 3,
              "EventModifierType": "sample string 4",
              "PartitionId": 5
            }
          ],
          "EventClassID": 5,
          "EventModifierMapID": 6,
          "CanTriggerScene": true,
          "CanTriggerVideo": true,
          "CanBeScheduled": true,
          "CanBeDelayed": true,
          "CanBeStateDependent": true,
          "CanBeException": true,
          "CanBeTimeDeadLine": true,
          "CanBeSentToPanel": true,
          "CanSendEmail": true
        },
        {
          "EventTypeID": 1,
          "EventGroupID": 2,
          "EventTypeDescription": "sample string 3",
          "EventTypeCapabilities": 511,
          "EventModifierCollection": [
            {
              "EventModifierID": 1,
              "EventModifierDescription": "sample string 2",
              "DeviceID": 3,
              "EventModifierType": "sample string 4",
              "PartitionId": 5
            },
            {
              "EventModifierID": 1,
              "EventModifierDescription": "sample string 2",
              "DeviceID": 3,
              "EventModifierType": "sample string 4",
              "PartitionId": 5
            }
          ],
          "EventClassID": 5,
          "EventModifierMapID": 6,
          "CanTriggerScene": true,
          "CanTriggerVideo": true,
          "CanBeScheduled": true,
          "CanBeDelayed": true,
          "CanBeStateDependent": true,
          "CanBeException": true,
          "CanBeTimeDeadLine": true,
          "CanBeSentToPanel": true,
          "CanSendEmail": true
        }
      ]
    },
    {
      "EventClassID": 1,
      "EventClassDescription": "sample string 2",
      "EventGroupList": [
        {
          "EventGroupID": 1,
          "EventGroupName": "sample string 2"
        },
        {
          "EventGroupID": 1,
          "EventGroupName": "sample string 2"
        }
      ],
      "EventTypeCollection": [
        {
          "EventTypeID": 1,
          "EventGroupID": 2,
          "EventTypeDescription": "sample string 3",
          "EventTypeCapabilities": 511,
          "EventModifierCollection": [
            {
              "EventModifierID": 1,
              "EventModifierDescription": "sample string 2",
              "DeviceID": 3,
              "EventModifierType": "sample string 4",
              "PartitionId": 5
            },
            {
              "EventModifierID": 1,
              "EventModifierDescription": "sample string 2",
              "DeviceID": 3,
              "EventModifierType": "sample string 4",
              "PartitionId": 5
            }
          ],
          "EventClassID": 5,
          "EventModifierMapID": 6,
          "CanTriggerScene": true,
          "CanTriggerVideo": true,
          "CanBeScheduled": true,
          "CanBeDelayed": true,
          "CanBeStateDependent": true,
          "CanBeException": true,
          "CanBeTimeDeadLine": true,
          "CanBeSentToPanel": true,
          "CanSendEmail": true
        },
        {
          "EventTypeID": 1,
          "EventGroupID": 2,
          "EventTypeDescription": "sample string 3",
          "EventTypeCapabilities": 511,
          "EventModifierCollection": [
            {
              "EventModifierID": 1,
              "EventModifierDescription": "sample string 2",
              "DeviceID": 3,
              "EventModifierType": "sample string 4",
              "PartitionId": 5
            },
            {
              "EventModifierID": 1,
              "EventModifierDescription": "sample string 2",
              "DeviceID": 3,
              "EventModifierType": "sample string 4",
              "PartitionId": 5
            }
          ],
          "EventClassID": 5,
          "EventModifierMapID": 6,
          "CanTriggerScene": true,
          "CanTriggerVideo": true,
          "CanBeScheduled": true,
          "CanBeDelayed": true,
          "CanBeStateDependent": true,
          "CanBeException": true,
          "CanBeTimeDeadLine": true,
          "CanBeSentToPanel": true,
          "CanSendEmail": true
        }
      ]
    }
  ],
  "LocationLimitations": "sample string 1",
  "LocationCameraList": [
    {
      "CameraDeviceID": 1,
      "CameraName": "sample string 2"
    },
    {
      "CameraDeviceID": 1,
      "CameraName": "sample string 2"
    }
  ],
  "SceneDeviceInfoList": [
    {
      "DeviceID": 1,
      "DeviceName": "sample string 2",
      "DeviceTypeID": 3,
      "PartnerID": 4
    },
    {
      "DeviceID": 1,
      "DeviceName": "sample string 2",
      "DeviceTypeID": 3,
      "PartnerID": 4
    }
  ],
  "ResultCode": 2,
  "ResultData": "sample string 3"
}

application/xml, text/xml

Sample:
<EventMetaDataExResult 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">2</ResultCode>
  <ResultData xmlns="http://schemas.datacontract.org/2004/07/TC2Utilities.RestApi">sample string 3</ResultData>
  <EventClassCollection xmlns:d2p1="http://schemas.datacontract.org/2004/07/TC2Domain.EventNotificationConfiguration">
    <d2p1:EventClass>
      <d2p1:EventClassDescription>sample string 2</d2p1:EventClassDescription>
      <d2p1:EventClassID>1</d2p1:EventClassID>
      <d2p1:EventGroupList>
        <d2p1:EventGroup>
          <d2p1:EventGroupID>1</d2p1:EventGroupID>
          <d2p1:EventGroupName>sample string 2</d2p1:EventGroupName>
        </d2p1:EventGroup>
        <d2p1:EventGroup>
          <d2p1:EventGroupID>1</d2p1:EventGroupID>
          <d2p1:EventGroupName>sample string 2</d2p1:EventGroupName>
        </d2p1:EventGroup>
      </d2p1:EventGroupList>
      <d2p1:EventTypeCollection>
        <d2p1:EventType>
          <d2p1:CanBeDelayed>true</d2p1:CanBeDelayed>
          <d2p1:CanBeException>true</d2p1:CanBeException>
          <d2p1:CanBeScheduled>true</d2p1:CanBeScheduled>
          <d2p1:CanBeSentToPanel>true</d2p1:CanBeSentToPanel>
          <d2p1:CanBeStateDependent>true</d2p1:CanBeStateDependent>
          <d2p1:CanBeTimeDeadLine>true</d2p1:CanBeTimeDeadLine>
          <d2p1:CanSendEmail>true</d2p1:CanSendEmail>
          <d2p1:CanTriggerScene>true</d2p1:CanTriggerScene>
          <d2p1:CanTriggerVideo>true</d2p1:CanTriggerVideo>
          <d2p1:EventClassID>5</d2p1:EventClassID>
          <d2p1:EventGroupID>2</d2p1:EventGroupID>
          <d2p1:EventModifierCollection>
            <d2p1:EventModifierInfo>
              <d2p1:DeviceID>3</d2p1:DeviceID>
              <d2p1:EventModifierDescription>sample string 2</d2p1:EventModifierDescription>
              <d2p1:EventModifierID>1</d2p1:EventModifierID>
              <d2p1:EventModifierType>sample string 4</d2p1:EventModifierType>
              <d2p1:PartitionId>5</d2p1:PartitionId>
            </d2p1:EventModifierInfo>
            <d2p1:EventModifierInfo>
              <d2p1:DeviceID>3</d2p1:DeviceID>
              <d2p1:EventModifierDescription>sample string 2</d2p1:EventModifierDescription>
              <d2p1:EventModifierID>1</d2p1:EventModifierID>
              <d2p1:EventModifierType>sample string 4</d2p1:EventModifierType>
              <d2p1:PartitionId>5</d2p1:PartitionId>
            </d2p1:EventModifierInfo>
          </d2p1:EventModifierCollection>
          <d2p1:EventModifierMapID>6</d2p1:EventModifierMapID>
          <d2p1:EventTypeCapabilities>511</d2p1:EventTypeCapabilities>
          <d2p1:EventTypeDescription>sample string 3</d2p1:EventTypeDescription>
          <d2p1:EventTypeID>1</d2p1:EventTypeID>
        </d2p1:EventType>
        <d2p1:EventType>
          <d2p1:CanBeDelayed>true</d2p1:CanBeDelayed>
          <d2p1:CanBeException>true</d2p1:CanBeException>
          <d2p1:CanBeScheduled>true</d2p1:CanBeScheduled>
          <d2p1:CanBeSentToPanel>true</d2p1:CanBeSentToPanel>
          <d2p1:CanBeStateDependent>true</d2p1:CanBeStateDependent>
          <d2p1:CanBeTimeDeadLine>true</d2p1:CanBeTimeDeadLine>
          <d2p1:CanSendEmail>true</d2p1:CanSendEmail>
          <d2p1:CanTriggerScene>true</d2p1:CanTriggerScene>
          <d2p1:CanTriggerVideo>true</d2p1:CanTriggerVideo>
          <d2p1:EventClassID>5</d2p1:EventClassID>
          <d2p1:EventGroupID>2</d2p1:EventGroupID>
          <d2p1:EventModifierCollection>
            <d2p1:EventModifierInfo>
              <d2p1:DeviceID>3</d2p1:DeviceID>
              <d2p1:EventModifierDescription>sample string 2</d2p1:EventModifierDescription>
              <d2p1:EventModifierID>1</d2p1:EventModifierID>
              <d2p1:EventModifierType>sample string 4</d2p1:EventModifierType>
              <d2p1:PartitionId>5</d2p1:PartitionId>
            </d2p1:EventModifierInfo>
            <d2p1:EventModifierInfo>
              <d2p1:DeviceID>3</d2p1:DeviceID>
              <d2p1:EventModifierDescription>sample string 2</d2p1:EventModifierDescription>
              <d2p1:EventModifierID>1</d2p1:EventModifierID>
              <d2p1:EventModifierType>sample string 4</d2p1:EventModifierType>
              <d2p1:PartitionId>5</d2p1:PartitionId>
            </d2p1:EventModifierInfo>
          </d2p1:EventModifierCollection>
          <d2p1:EventModifierMapID>6</d2p1:EventModifierMapID>
          <d2p1:EventTypeCapabilities>511</d2p1:EventTypeCapabilities>
          <d2p1:EventTypeDescription>sample string 3</d2p1:EventTypeDescription>
          <d2p1:EventTypeID>1</d2p1:EventTypeID>
        </d2p1:EventType>
      </d2p1:EventTypeCollection>
    </d2p1:EventClass>
    <d2p1:EventClass>
      <d2p1:EventClassDescription>sample string 2</d2p1:EventClassDescription>
      <d2p1:EventClassID>1</d2p1:EventClassID>
      <d2p1:EventGroupList>
        <d2p1:EventGroup>
          <d2p1:EventGroupID>1</d2p1:EventGroupID>
          <d2p1:EventGroupName>sample string 2</d2p1:EventGroupName>
        </d2p1:EventGroup>
        <d2p1:EventGroup>
          <d2p1:EventGroupID>1</d2p1:EventGroupID>
          <d2p1:EventGroupName>sample string 2</d2p1:EventGroupName>
        </d2p1:EventGroup>
      </d2p1:EventGroupList>
      <d2p1:EventTypeCollection>
        <d2p1:EventType>
          <d2p1:CanBeDelayed>true</d2p1:CanBeDelayed>
          <d2p1:CanBeException>true</d2p1:CanBeException>
          <d2p1:CanBeScheduled>true</d2p1:CanBeScheduled>
          <d2p1:CanBeSentToPanel>true</d2p1:CanBeSentToPanel>
          <d2p1:CanBeStateDependent>true</d2p1:CanBeStateDependent>
          <d2p1:CanBeTimeDeadLine>true</d2p1:CanBeTimeDeadLine>
          <d2p1:CanSendEmail>true</d2p1:CanSendEmail>
          <d2p1:CanTriggerScene>true</d2p1:CanTriggerScene>
          <d2p1:CanTriggerVideo>true</d2p1:CanTriggerVideo>
          <d2p1:EventClassID>5</d2p1:EventClassID>
          <d2p1:EventGroupID>2</d2p1:EventGroupID>
          <d2p1:EventModifierCollection>
            <d2p1:EventModifierInfo>
              <d2p1:DeviceID>3</d2p1:DeviceID>
              <d2p1:EventModifierDescription>sample string 2</d2p1:EventModifierDescription>
              <d2p1:EventModifierID>1</d2p1:EventModifierID>
              <d2p1:EventModifierType>sample string 4</d2p1:EventModifierType>
              <d2p1:PartitionId>5</d2p1:PartitionId>
            </d2p1:EventModifierInfo>
            <d2p1:EventModifierInfo>
              <d2p1:DeviceID>3</d2p1:DeviceID>
              <d2p1:EventModifierDescription>sample string 2</d2p1:EventModifierDescription>
              <d2p1:EventModifierID>1</d2p1:EventModifierID>
              <d2p1:EventModifierType>sample string 4</d2p1:EventModifierType>
              <d2p1:PartitionId>5</d2p1:PartitionId>
            </d2p1:EventModifierInfo>
          </d2p1:EventModifierCollection>
          <d2p1:EventModifierMapID>6</d2p1:EventModifierMapID>
          <d2p1:EventTypeCapabilities>511</d2p1:EventTypeCapabilities>
          <d2p1:EventTypeDescription>sample string 3</d2p1:EventTypeDescription>
          <d2p1:EventTypeID>1</d2p1:EventTypeID>
        </d2p1:EventType>
        <d2p1:EventType>
          <d2p1:CanBeDelayed>true</d2p1:CanBeDelayed>
          <d2p1:CanBeException>true</d2p1:CanBeException>
          <d2p1:CanBeScheduled>true</d2p1:CanBeScheduled>
          <d2p1:CanBeSentToPanel>true</d2p1:CanBeSentToPanel>
          <d2p1:CanBeStateDependent>true</d2p1:CanBeStateDependent>
          <d2p1:CanBeTimeDeadLine>true</d2p1:CanBeTimeDeadLine>
          <d2p1:CanSendEmail>true</d2p1:CanSendEmail>
          <d2p1:CanTriggerScene>true</d2p1:CanTriggerScene>
          <d2p1:CanTriggerVideo>true</d2p1:CanTriggerVideo>
          <d2p1:EventClassID>5</d2p1:EventClassID>
          <d2p1:EventGroupID>2</d2p1:EventGroupID>
          <d2p1:EventModifierCollection>
            <d2p1:EventModifierInfo>
              <d2p1:DeviceID>3</d2p1:DeviceID>
              <d2p1:EventModifierDescription>sample string 2</d2p1:EventModifierDescription>
              <d2p1:EventModifierID>1</d2p1:EventModifierID>
              <d2p1:EventModifierType>sample string 4</d2p1:EventModifierType>
              <d2p1:PartitionId>5</d2p1:PartitionId>
            </d2p1:EventModifierInfo>
            <d2p1:EventModifierInfo>
              <d2p1:DeviceID>3</d2p1:DeviceID>
              <d2p1:EventModifierDescription>sample string 2</d2p1:EventModifierDescription>
              <d2p1:EventModifierID>1</d2p1:EventModifierID>
              <d2p1:EventModifierType>sample string 4</d2p1:EventModifierType>
              <d2p1:PartitionId>5</d2p1:PartitionId>
            </d2p1:EventModifierInfo>
          </d2p1:EventModifierCollection>
          <d2p1:EventModifierMapID>6</d2p1:EventModifierMapID>
          <d2p1:EventTypeCapabilities>511</d2p1:EventTypeCapabilities>
          <d2p1:EventTypeDescription>sample string 3</d2p1:EventTypeDescription>
          <d2p1:EventTypeID>1</d2p1:EventTypeID>
        </d2p1:EventType>
      </d2p1:EventTypeCollection>
    </d2p1:EventClass>
  </EventClassCollection>
  <LocationCameraList xmlns:d2p1="http://schemas.datacontract.org/2004/07/TC2Domain.EventNotificationConfiguration">
    <d2p1:CameraSimple>
      <d2p1:CameraDeviceID>1</d2p1:CameraDeviceID>
      <d2p1:CameraName>sample string 2</d2p1:CameraName>
    </d2p1:CameraSimple>
    <d2p1:CameraSimple>
      <d2p1:CameraDeviceID>1</d2p1:CameraDeviceID>
      <d2p1:CameraName>sample string 2</d2p1:CameraName>
    </d2p1:CameraSimple>
  </LocationCameraList>
  <LocationLimitations>sample string 1</LocationLimitations>
  <SceneDeviceInfoList xmlns:d2p1="http://schemas.datacontract.org/2004/07/TC2Domain.EventNotificationConfiguration">
    <d2p1:SceneDeviceInfo>
      <d2p1:DeviceID>1</d2p1:DeviceID>
      <d2p1:DeviceName>sample string 2</d2p1:DeviceName>
      <d2p1:DeviceTypeID>3</d2p1:DeviceTypeID>
      <d2p1:PartnerID>4</d2p1:PartnerID>
    </d2p1:SceneDeviceInfo>
    <d2p1:SceneDeviceInfo>
      <d2p1:DeviceID>1</d2p1:DeviceID>
      <d2p1:DeviceName>sample string 2</d2p1:DeviceName>
      <d2p1:DeviceTypeID>3</d2p1:DeviceTypeID>
      <d2p1:PartnerID>4</d2p1:PartnerID>
    </d2p1:SceneDeviceInfo>
  </SceneDeviceInfoList>
</EventMetaDataExResult>