POST api/v3/locations/{locationId}/devices/{deviceId}/Events

Returns a set of device or audit event records. A maximum of 100 records can be returned per call.Eevnts by partition (This method is used HttpPost action. Reason: "EventFilters" input model pass more inbound params.)

Request Information

URI Parameters

Name	Description	Type	Additional information
locationId	Location ID	integer	Required
deviceId	Device ID	integer	Required

Body Parameters

Input Filter for Events

EventFilters

Name	Description	Type	Additional information
FilterClass	Events filter class	integer	None.
MaxRecords	Max records	integer	None.
EventTypeFilters	List of event type filters	Collection of integer	None.
ShowHidden	It how Hidden	boolean	None.
ShowLocked	Its show the locked events	boolean	None.
StartDateTime	Start DateTime for events	string	None.
EndDateTime	End DateTime for events	string	None.
DateFormat	Date format	integer	None.
TimeFormat	Time format	integer	None.
SortOrder	Sorting order (ASC/DESC)	integer	None.
LastEventIdReceived	Received last eventId	integer	None.
PartitionIds	List of Partition Ids	Collection of integer	None.

Request Formats

application/json, text/json

Sample:

{
  "FilterClass": 1,
  "MaxRecords": 2,
  "EventTypeFilters": [
    1,
    2
  ],
  "ShowHidden": true,
  "ShowLocked": true,
  "StartDateTime": "sample string 5",
  "EndDateTime": "sample string 6",
  "DateFormat": 7,
  "TimeFormat": 8,
  "SortOrder": 9,
  "LastEventIdReceived": 10,
  "PartitionIds": [
    1,
    2
  ]
}

application/xml, text/xml

Sample:

<EventFilters xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TC2WebAPIController.Models.V1.Events">
  <DateFormat>7</DateFormat>
  <EndDateTime>sample string 6</EndDateTime>
  <EventTypeFilters xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </EventTypeFilters>
  <FilterClass>1</FilterClass>
  <LastEventIdReceived>10</LastEventIdReceived>
  <MaxRecords>2</MaxRecords>
  <PartitionIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </PartitionIds>
  <ShowHidden>true</ShowHidden>
  <ShowLocked>true</ShowLocked>
  <SortOrder>9</SortOrder>
  <StartDateTime>sample string 5</StartDateTime>
  <TimeFormat>8</TimeFormat>
</EventFilters>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

EventsResult

Name	Description	Type	Additional information
ResultCode		integer	None.
ResultData		string	None.
Events	List of Event Record	Collection of EventRecord	None.
HasMore	Get more events or not.	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "Events": [
    {
      "EventRecordId": 1,
      "EventType": 2,
      "Event": "sample string 3",
      "Originator": "sample string 4",
      "Notice": "sample string 5",
      "Notes": "sample string 6",
      "HasNotes": true,
      "IsLocked": true,
      "IsHidden": true,
      "RecDateTimeGMT": "sample string 10",
      "RecDateLocal": "sample string 11",
      "RecDateSuffix": "sample string 12",
      "FilterClass": 13,
      "DeviceId": 14,
      "EventFilterTypeID": 15,
      "MediaId": "sample string 16",
      "Viewed": 17,
      "PanelEventId": 18
    },
    {
      "EventRecordId": 1,
      "EventType": 2,
      "Event": "sample string 3",
      "Originator": "sample string 4",
      "Notice": "sample string 5",
      "Notes": "sample string 6",
      "HasNotes": true,
      "IsLocked": true,
      "IsHidden": true,
      "RecDateTimeGMT": "sample string 10",
      "RecDateLocal": "sample string 11",
      "RecDateSuffix": "sample string 12",
      "FilterClass": 13,
      "DeviceId": 14,
      "EventFilterTypeID": 15,
      "MediaId": "sample string 16",
      "Viewed": 17,
      "PanelEventId": 18
    }
  ],
  "HasMore": true,
  "ResultCode": 1,
  "ResultData": "sample string 2"
}

application/xml, text/xml

Sample:

<EventsResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TC2WebAPIController.Models.V1.Events">
  <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>
  <Events xmlns:d2p1="http://schemas.datacontract.org/2004/07/TC2Domain.Event_History">
    <d2p1:EventRecord>
      <d2p1:DeviceId>14</d2p1:DeviceId>
      <d2p1:Event>sample string 3</d2p1:Event>
      <d2p1:EventFilterTypeID>15</d2p1:EventFilterTypeID>
      <d2p1:EventRecordId>1</d2p1:EventRecordId>
      <d2p1:EventType>2</d2p1:EventType>
      <d2p1:FilterClass>13</d2p1:FilterClass>
      <d2p1:HasNotes>true</d2p1:HasNotes>
      <d2p1:IsHidden>true</d2p1:IsHidden>
      <d2p1:IsLocked>true</d2p1:IsLocked>
      <d2p1:MediaId>sample string 16</d2p1:MediaId>
      <d2p1:Notes>sample string 6</d2p1:Notes>
      <d2p1:Notice>sample string 5</d2p1:Notice>
      <d2p1:Originator>sample string 4</d2p1:Originator>
      <d2p1:PanelEventId>18</d2p1:PanelEventId>
      <d2p1:RecDateLocal>sample string 11</d2p1:RecDateLocal>
      <d2p1:RecDateSuffix>sample string 12</d2p1:RecDateSuffix>
      <d2p1:RecDateTimeGMT>sample string 10</d2p1:RecDateTimeGMT>
      <d2p1:Viewed>17</d2p1:Viewed>
    </d2p1:EventRecord>
    <d2p1:EventRecord>
      <d2p1:DeviceId>14</d2p1:DeviceId>
      <d2p1:Event>sample string 3</d2p1:Event>
      <d2p1:EventFilterTypeID>15</d2p1:EventFilterTypeID>
      <d2p1:EventRecordId>1</d2p1:EventRecordId>
      <d2p1:EventType>2</d2p1:EventType>
      <d2p1:FilterClass>13</d2p1:FilterClass>
      <d2p1:HasNotes>true</d2p1:HasNotes>
      <d2p1:IsHidden>true</d2p1:IsHidden>
      <d2p1:IsLocked>true</d2p1:IsLocked>
      <d2p1:MediaId>sample string 16</d2p1:MediaId>
      <d2p1:Notes>sample string 6</d2p1:Notes>
      <d2p1:Notice>sample string 5</d2p1:Notice>
      <d2p1:Originator>sample string 4</d2p1:Originator>
      <d2p1:PanelEventId>18</d2p1:PanelEventId>
      <d2p1:RecDateLocal>sample string 11</d2p1:RecDateLocal>
      <d2p1:RecDateSuffix>sample string 12</d2p1:RecDateSuffix>
      <d2p1:RecDateTimeGMT>sample string 10</d2p1:RecDateTimeGMT>
      <d2p1:Viewed>17</d2p1:Viewed>
    </d2p1:EventRecord>
  </Events>
  <HasMore>true</HasMore>
</EventsResult>