Help Page Home

POST v/1/Rest/Public/{client_domain}/Events

Search for events based on the supplied parameters.

Request Information

URI Parameters

Name	Description	Type	Additional information
client_domain		string	None.

Body Parameters

the search parameters.

SearchEventsParameters

Name	Type	Additional information
Event_Id	integer	None.
EventName	string	None.
Type_Id	integer	None.
Active	boolean	None.
DateCreatedFrom	date	None.
DateCreatedTo	date	None.
PageStartFrom	integer	None.
PageSize	integer	None.
OrderByField	string	None.
OrderByDirection	OrderByDirections	None.

Request Formats

application/json, text/json

Sample:

{
  "Event_Id": 1,
  "EventName": "sample string 1",
  "Type_Id": 1,
  "Active": true,
  "DateCreatedFrom": "2024-12-22T12:16:04.8463907-05:00",
  "DateCreatedTo": "2024-12-22T12:16:04.8463907-05:00",
  "PageStartFrom": 1,
  "PageSize": 1,
  "OrderByField": "sample string 2",
  "OrderByDirection": 1
}

application/xml, text/xml

Sample:

<SearchEventsParameters xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <OrderByDirection>Ascending</OrderByDirection>
  <OrderByField>sample string 2</OrderByField>
  <PageSize>1</PageSize>
  <PageStartFrom>1</PageStartFrom>
  <DateCreatedFrom>2024-12-22T12:16:04.8463907-05:00</DateCreatedFrom>
  <DateCreatedTo>2024-12-22T12:16:04.8463907-05:00</DateCreatedTo>
  <Active>true</Active>
  <EventName>sample string 1</EventName>
  <Event_Id>1</Event_Id>
  <Type_Id>1</Type_Id>
</SearchEventsParameters>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'SearchEventsParameters'.

Response Information

Resource Description

a list of matching events.

GetEventsResponse

Name	Type	Additional information
Events	Collection of EventRecord	None.
QueryRecordCount	integer	None.
Successful	boolean	None.
Error	PublicApiError	None.

Response Formats

application/json, text/json

Sample:

{
  "Events": [
    {
      "Active": true,
      "StartDate": "2024-12-22T12:16:04.8504606-05:00",
      "EndDate": "2024-12-22T12:16:04.8504606-05:00",
      "Name": "sample string 2",
      "DateCreated": "2024-12-22T12:16:04.8504606-05:00",
      "Id": 4
    },
    {
      "Active": true,
      "StartDate": "2024-12-22T12:16:04.8504606-05:00",
      "EndDate": "2024-12-22T12:16:04.8504606-05:00",
      "Name": "sample string 2",
      "DateCreated": "2024-12-22T12:16:04.8504606-05:00",
      "Id": 4
    }
  ],
  "QueryRecordCount": 1,
  "Successful": true,
  "Error": {
    "Code": 0,
    "Message": "sample string 1"
  }
}

application/xml, text/xml

Sample:

<GetEventsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Error>
    <Message>sample string 1</Message>
    <Code>None</Code>
  </Error>
  <Successful>true</Successful>
  <QueryRecordCount>1</QueryRecordCount>
  <Events>
    <EventRecord>
      <Id>4</Id>
      <DateCreated>2024-12-22T12:16:04.8504606-05:00</DateCreated>
      <Name>sample string 2</Name>
      <Active>true</Active>
      <EndDate>2024-12-22T12:16:04.8504606-05:00</EndDate>
      <StartDate>2024-12-22T12:16:04.8504606-05:00</StartDate>
    </EventRecord>
    <EventRecord>
      <Id>4</Id>
      <DateCreated>2024-12-22T12:16:04.8504606-05:00</DateCreated>
      <Name>sample string 2</Name>
      <Active>true</Active>
      <EndDate>2024-12-22T12:16:04.8504606-05:00</EndDate>
      <StartDate>2024-12-22T12:16:04.8504606-05:00</StartDate>
    </EventRecord>
  </Events>
</GetEventsResponse>