Guides
Start typing to search…

Search events (GET)

This API allows you to search for one or multiple events.

Call

In this call, you can select none, one, or multiple criteria to search events by and how you want the data organized in the response. If there are no criteria provided, the call will return a list of all the users in the platform. If more than one criterion is provided, then the system will use a logical AND for matches. The options available to use in this call are:

  • Search Criteria: The available criteria to search users with.
  • Payload Organization: The available options to organize the payload.

Search Criteria

  • resourceGuid: The resourceGuid of the event that will be searched.
  • Name: The new event’s name.
  • startDateFrom: The lower value of the range the search will use for startDate, in other words, the search can be made in a range of dates, for the starting date, this would be the lower value of the range. This field expects the format: yyyy-mm-dd (1998-10-01). If startDateTo is empty, this field could have any value, if not, this field would need to be equal to or lower than startDateTo.
  • startDateTo: The upper value of the range the search will use for startDate, in other words, the search can be made in a range of dates, for the starting date, this would be the upper value of the range. This field expects the format: yyyy-mm-dd (1998-10-01). If startDateFrom is empty, this field could have any value, if not, this field would need to be equal to or greater than startDateFrom.
  • endDateFrom: The lower value of the range the search will use for endDate, in other words, the search can be made in a range of dates, for the ending date, this would be the lower value of the range. This field expects the format: yyyy-mm-dd (1998-10-01). If endDateTo is empty, this field could have any value, if not, this field would need to be equal to or lower than endDateTo.
  • endDateTo: The upper value of the range the search will use for endDate, in other words, the search can be made in a range of dates, for the ending date, this would be the upper value of the range. This field expects the format: yyyy-mm-dd (1998-10-01). If endDateFrom is empty, this field could have any value, if not, this field would need to be equal to or greater than endDateFrom.
  • city: the event location’s city.
  • state: the event location’s state.
  • country: the event location’s country.

Payload Organization

  • Page: This field refers to the result page you want to be shown. In other words, the responses for this API are divided into pages that go from 0 to the number of pages needed to show all the records, this parameter allows you to select which page you will have in your response. The default value is page 0.
  • Size: This field refers to the number of records you want to be displayed on each page. In other words, each response consists of 1 page and several records on that page, this parameter allows you to select the number of records that will be displayed per page. The default value is 1000 records per page.
  • Sort: This field refers to the sorting order you want for the records in the response. In order to use this parameter you must follow this format: [field name].keyword,asc/desc (firstName.keyword,desc). If no sort parameters are provided, the response will sort them ascending by their ID on the database table, the default order is always ascending.

Response

This API will return a payload in JSON format, listing all the events that matched the search and their information. Ends with the information about the number of records returned, the page that was returned, and the size of the page.

Example

{
  "content": [
    {
      "resourceGuid": "aa19675e-fe02-4aaf-956a-6dade8b6057e",
      "name": "Documentation Event 1",
      "...",
      "isVolunteering": null,
      "registrationDeadline": null
    },
    {
      "resourceGuid": "aa19675e-fe02-4aaf-956a-6dade8b6054e",
      "name": "Documentation Event 2",
      "...",
      "isVolunteering": true,
      "registrationDeadline": null
    },
		{
      "resourceGuid": "aa19675e-fe02-4aaf-957a-6dade8b6057e",
      "name": "Documentation Event 3",
      "...",
      "isVolunteering": false,
      "registrationDeadline": null
    }
  ],
  "pageable": {
    "sort": {
      "sorted": true,
      "unsorted": false,
      "empty": false
    },
    "pageNumber": 2,
    "pageSize": 1,
    "offset": 2,
    "paged": true,
    "unpaged": false
  },
  "last": false,
  "totalElements": 5,
  "totalPages": 5,
  "sort": {
    "sorted": true,
    "unsorted": false,
    "empty": false
  },
  "first": false,
  "number": 2,
  "numberOfElements": 1,
  "size": 1,
  "empty": false
}

API URL: https://gateway.enterprisealumni.com/api/v2/event/search

*Use gateway-us for the United States region and gateway-uk for the UK region. For the Frankfurt region, simply use gateway.

Updated 19 days ago