GET api/Events?field={field}&search={search}&exact={exact}¤t={current}
This returns events where the specified field contains the specified search text or equals the search text if exact = true. If html is requested it converts to server local date time, otherwise date time is UTC.
Request Information
Parameters
| Name | Description | Additional information |
|---|---|---|
| field | The Name of the field to search against, not the dates |
Define this parameter in the request URI. |
| search | The text to search for |
Define this parameter in the request URI. |
| exact | Set to true if match must be exact |
Define this parameter in the request URI. |
| current | Set to false historic events are also required |
Define this parameter in the request URI. |
Response Information
filtered list of events
Response body formats
text/html
Sample:
<div class="input-group">
<label class="sr-only" for="filter">Filter</label>
<span class="input-group-addon">Filter</span>
<input id="filter" type="text" class="form-control" placeholder="Filter..." />
</div>
<table class="hdc-table table default" data-filter="#filter">
<thead>
<tr>
<th data-toggle="true" class="footable-first-column">
Title
</th>
<th>
Start Time
</th>
<th data-hide="phone">
End Time
</th>
<th data-hide="phone">
Venue
</th>
<th data-hide="phone,tablet">
Description
</th>
<th data-hide="phone,tablet">
Category
</th>
<th data-hide="phone,tablet">
Contact
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="sample string 5">sample string 2</a> </td>
<td>
4/20/2024 12:49:24 PM
</td>
<td>
4/20/2024 12:49:24 PM
</td>
<td>
sample string 3
</td>
<td>
sample string 6
</td>
<td>
sample string 4
</td>
<td>
<a href="sample string 8">sample string 7</a> </td>
</tr>
<tr>
<td>
<a href="sample string 5">sample string 2</a> </td>
<td>
4/20/2024 12:49:24 PM
</td>
<td>
4/20/2024 12:49:24 PM
</td>
<td>
sample string 3
</td>
<td>
sample string 6
</td>
<td>
sample string 4
</td>
<td>
<a href="sample string 8">sample string 7</a> </td>
</tr>
<tr>
<td>
<a href="sample string 5">sample string 2</a> </td>
<td>
4/20/2024 12:49:24 PM
</td>
<td>
4/20/2024 12:49:24 PM
</td>
<td>
sample string 3
</td>
<td>
sample string 6
</td>
<td>
sample string 4
</td>
<td>
<a href="sample string 8">sample string 7</a> </td>
</tr>
</tbody>
<tfoot class="hide-if-no-paging">
<tr>
<td colspan="6">
<ul class="pagination pagination-centered hide-if-no-paging"></ul>
</td>
</tr>
</tfoot>
</table>
application/json, text/json
Sample:
[
{
"id": 1,
"start_Time": "2024-04-20T12:49:24.0687673+01:00",
"end_Time": "2024-04-20T12:49:24.0687673+01:00",
"title": "sample string 2",
"venue": "sample string 3",
"category": "sample string 4",
"title_Link": "sample string 5",
"description": "sample string 6",
"contact": "sample string 7",
"contact_Link": "sample string 8"
},
{
"id": 1,
"start_Time": "2024-04-20T12:49:24.0687673+01:00",
"end_Time": "2024-04-20T12:49:24.0687673+01:00",
"title": "sample string 2",
"venue": "sample string 3",
"category": "sample string 4",
"title_Link": "sample string 5",
"description": "sample string 6",
"contact": "sample string 7",
"contact_Link": "sample string 8"
},
{
"id": 1,
"start_Time": "2024-04-20T12:49:24.0687673+01:00",
"end_Time": "2024-04-20T12:49:24.0687673+01:00",
"title": "sample string 2",
"venue": "sample string 3",
"category": "sample string 4",
"title_Link": "sample string 5",
"description": "sample string 6",
"contact": "sample string 7",
"contact_Link": "sample string 8"
}
]
application/xml, text/xml
Sample:
<ArrayOfEvent xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HDCAPIModel.Models">
<Event>
<Category>sample string 4</Category>
<Contact>sample string 7</Contact>
<Contact_Link>sample string 8</Contact_Link>
<Description>sample string 6</Description>
<End_Time>2024-04-20T12:49:24.0687673+01:00</End_Time>
<ID>1</ID>
<Start_Time>2024-04-20T12:49:24.0687673+01:00</Start_Time>
<Title>sample string 2</Title>
<Title_Link>sample string 5</Title_Link>
<Venue>sample string 3</Venue>
</Event>
<Event>
<Category>sample string 4</Category>
<Contact>sample string 7</Contact>
<Contact_Link>sample string 8</Contact_Link>
<Description>sample string 6</Description>
<End_Time>2024-04-20T12:49:24.0687673+01:00</End_Time>
<ID>1</ID>
<Start_Time>2024-04-20T12:49:24.0687673+01:00</Start_Time>
<Title>sample string 2</Title>
<Title_Link>sample string 5</Title_Link>
<Venue>sample string 3</Venue>
</Event>
<Event>
<Category>sample string 4</Category>
<Contact>sample string 7</Contact>
<Contact_Link>sample string 8</Contact_Link>
<Description>sample string 6</Description>
<End_Time>2024-04-20T12:49:24.0687673+01:00</End_Time>
<ID>1</ID>
<Start_Time>2024-04-20T12:49:24.0687673+01:00</Start_Time>
<Title>sample string 2</Title>
<Title_Link>sample string 5</Title_Link>
<Venue>sample string 3</Venue>
</Event>
</ArrayOfEvent>
text/javascript
Sample:
([{"id":1,"start_Time":"2024-04-20T12:49:24.0687673+01:00","end_Time":"2024-04-20T12:49:24.0687673+01:00","title":"sample string 2","venue":"sample string 3","category":"sample string 4","title_Link":"sample string 5","description":"sample string 6","contact":"sample string 7","contact_Link":"sample string 8"},{"id":1,"start_Time":"2024-04-20T12:49:24.0687673+01:00","end_Time":"2024-04-20T12:49:24.0687673+01:00","title":"sample string 2","venue":"sample string 3","category":"sample string 4","title_Link":"sample string 5","description":"sample string 6","contact":"sample string 7","contact_Link":"sample string 8"},{"id":1,"start_Time":"2024-04-20T12:49:24.0687673+01:00","end_Time":"2024-04-20T12:49:24.0687673+01:00","title":"sample string 2","venue":"sample string 3","category":"sample string 4","title_Link":"sample string 5","description":"sample string 6","contact":"sample string 7","contact_Link":"sample string 8"}]);