GET api/v1/locations/{LocationId}/events?FilterClass={FilterClass}

Returns a list of available event type filter values that are to be used for filtering the event record retrieval.

Request Information

URI Parameters

Name	Description	Type	Additional information
LocationId	Location ID	integer	Required
FilterClass	Filter Class	integer	Required

Body Parameters

None.

Response Information

Resource Description

EventTypeFilterResult

Name	Type	Additional information
ResultCode	integer	None.
ResultData	string	None.
EventTypeFilters	Collection of FilterEventType	None.

Response Formats

application/json, text/json

Sample:

{
  "EventTypeFilters": [
    {
      "EventTypeFilterId": 1,
      "EventTypeFilterName": "sample string 2",
      "EventClass": 3
    },
    {
      "EventTypeFilterId": 1,
      "EventTypeFilterName": "sample string 2",
      "EventClass": 3
    }
  ],
  "ResultCode": 1,
  "ResultData": "sample string 2"
}

application/xml, text/xml

Sample:

<EventTypeFilterResult 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>
  <EventTypeFilters xmlns:d2p1="http://schemas.datacontract.org/2004/07/TC2Domain.Event_History">
    <d2p1:FilterEventType>
      <d2p1:EventClass>3</d2p1:EventClass>
      <d2p1:EventTypeFilterId>1</d2p1:EventTypeFilterId>
      <d2p1:EventTypeFilterName>sample string 2</d2p1:EventTypeFilterName>
    </d2p1:FilterEventType>
    <d2p1:FilterEventType>
      <d2p1:EventClass>3</d2p1:EventClass>
      <d2p1:EventTypeFilterId>1</d2p1:EventTypeFilterId>
      <d2p1:EventTypeFilterName>sample string 2</d2p1:EventTypeFilterName>
    </d2p1:FilterEventType>
  </EventTypeFilters>
</EventTypeFilterResult>