Events: Search Events

Updated June 14, 2023 16:13

Search Events

POST /v2/event/get

This API returns a list of events that satisfy the search parameters provided. By default, only the first 50 searched events will be returned.

Parameter

StartDate DateTime

The start date and time range of the events to be searched.

EndDate DateTime

The end date and time range of the events to be searched.

Venue Array(Long)

The Venue Id Array. If specified then only those events will be shown which are booked for given Venue Ids.

EventStatus Array(Long)

The Event Status Id. If specified then only those events will be shown which are booked for given Event Status Id.

EventName String

The Event's Name. If specified then only those events will be shown which are booked with given Event Name.

EventNumber String

The Event's Number. If specified then only that event will be shown which are booked with given Event Number.

EventType Array(Long)

The Event's Type. If specified then only those events will be shown which are booked with given Event Type.

InvoiceNumber String

The Invoice Number. If specified then only that event will be shown which is having the invoice number same as mentioned.

EventCoordinator Array(Long)

The Event's Coordinator. If specified then only those events will be shown which are booked with given Event Coordinator.

DebtorNumber String

The Debtor Number. If specified then only those events will be shown whose contacts are having the same Debtor Number as mentioned.

EventDetailName String

The Event Detail catalogue item's name. If specified then only those events will be shown that contains event detail catalogue items with given Event Detail Name.

CreatedDate DateTime

The created date and time of the events to be searched. The API will search for events created after this date.

LastUpdatedDate DateTime

The updated date and time of the events to be searched. The API will search for events updated after this date.

StatusChangedDate DateTime

The status change date and time of the events to be searched. The API will search for events whose status has been changed after this date.

ExcludeEventCreatedStatus Boolean

This is to be passed along with StatusChangedDate. When true, the search result will contain only those events whose statuses have been updated.

OnlyPrimaryContact Boolean

This is to be passed along with Contact or ContactType.When true, only those events will be shown in which mentioned Contact or ContactType is primary.

Contact Array(Long)

The array of event contact ids. If specified only those events will be fetched in which provided contacts exist.

ContactType Array(Long)

The array of event contact type ids. If specified only those events will be fetched in which provided ContactType exist.

NextPageDirection String

What direction you would like to page for your next set of results. The only values allowed are forward or reverse.

LastPageEventNumber Integer

The Event Number of the last Event on your current set of results to be used as the reference point for your next set of results.

PageNo Integer

The Page Number of the Event list results.

Offset Integer

If Offset is specified then it will fetch the next number of records after offset and skip the previous records, for e.g If there are 50 records and offset is 10 then records will be fetched from 11 to 50.

RecordsPerPage Integer

The number of records per page.

SortingOrder Object Array

The sorting of data as per the ColoumnName provided.

NOTE: Sorting order cannot be passed along with NextPageDirection and LastPageEventNumber

JSON

{
  "EventName": "test",
  "StartDate": "01/12/2018 09:00",
  "EndDate": "01/02/2019 16:30",
  "Venue": [100172533],
  "EventStatus": [100012743],
  "EventNumber": "",
  "EventType": [100032779],
  "InvoiceNumber": "",
  "EventCoordinator": [100011131],
  "DebtorNumber": "123",
  "Contact":[100543023,100543024],
  "ContactType":[10000005283],
  "OnlyPrimaryContact":true,
  "NextPageDirection": "forward",
  "LastPageEventNumber": "",
  "PageNo": "1",
  "Offset": "0",
  "RecordsPerPage": "10",
  "SortingOrder": [{
    "ColumnName": "ModifiedDate",
    "IsAscending": false
  }]
}

Response:

Event with relevant event details

{
  "success": true,
  "result": [{
    "EventPax": 0,
    "EventNumber": "2601",
    "EventEndDate": "30/01/2019 23:00",
    "EventType": {
       "Id": 100032779,
       "Name": "NNEventType"
    },
   "EventContact": [{
      "ContactType": {
        "Id": 10000005283,
        "Name": "Sales Person"
      },
     "Email": "john.smith@testmail.com",
     "Organisation": "",
     "Phone": "5566556655",
     "IsPrimary": true,
     "GivenName": "John",
     "ContactId": 100543024,
     "SurName": "Smith",
     "ContactName": "John Smith",
     "EventContactId": 102199078
   }],
   "EventStartDate": "30/01/2019 14:30",
   "EventStatus": {
     "Type": "Queued",
     "TextColour": "#0000ff",
     "Id": 100012743,
     "Name": "Equeued",
     "Colour": "#00ff00"
   },
  "VenueBookings": [{
    "StartDate": "10/07/2020 13:30",
    "BookingId": 104892385,
    "VenueId": 100358410,
    "EndDate": "10/07/2020 22:00",
    "Name": "Hall"
   }],
  "EventCoordinator": {
    "Id": 100011131,
    "Name": "Abc Test User"
  },
  "EventName": "Test"
},{
  "EventPax": 0,
  "EventNumber": "2602",
  "EventEndDate": "30/01/2019 23:00",
  "EventType": {
    "Id": 100032779,
    "Name": "NNEventType"
  },
  "EventContact": [{
    "ContactType": {
       "Id": 10000005283,
       "Name": "Sales Person"
    },
    "Email": "john.smith@testmail.com",
    "Organisation": "",
    "Phone": "5566556655",
    "IsPrimary": true,
    "GivenName": "John",
    "ContactId": 100543024,
    "SurName": "Smith",
    "ContactName": "John Smith",
    "EventContactId": 102199078
  }],
  "EventStartDate": "30/01/2019 14:30",
  "EventStatus": {
    "Type": "Queued",
    "TextColour": "#0000ff",
    "Id": 100012743,
    "Name": "Equeued",
    "Colour": "#00ff00"
  },
  "EventCoordinator": {
    "Id": 100011131,
    "Name": "Abc Test User"
  },
  "VenueBookings": [{
    "StartDate": "10/07/2020 13:30",
    "BookingId": 104892385,
    "VenueId": 100358410,
    "EndDate": "10/07/2020 22:00",
    "Name": "Meeting Room"
  }],
  "EventName": "Test Event"
 }],
 "AdditionalInfo": {
 "Count": 2
 }
}

Was this article helpful?

Have more questions? Submit a request