Search events
POST/v1/event/searchSearch events by name, date, location, or category
Request
Query Params
page
integer <int32>
opcional
Padrão:
0
perPage
integer <int32>
opcional
Padrão:
10
Body Params application/json
filters
array[object (SearchFilterRequest) {4}]
opcional
The filters to be used in the search
filter_key
string
opcional
The key to search for
value
object
opcional
The value to search for
operation
enum<string>
opcional
The comparison used to search for the term
Valores permitidos:
eqnegtgeltlecnicbwibewiencbnennunn
data_option
enum<string>
opcional
The option used to combine the search criteria
Valores permitidos:
allany
sorts
array[object (SortSearchRequest) {2}]
opcional
The sorts to be used in the search
sort
string
opcional
The field to sort the results by
direction
enum<string>
opcional
The direction to sort the results by
Valores permitidos:
ascdesc
Example
{
"filters": [
{
"filter_key": "string",
"value": {},
"operation": "eq",
"data_option": "all"
}
],
"sorts": [
{
"sort": "string",
"direction": "asc"
}
]
}Request samples
Responses
OK(200)
Pedido inválido(400)
HTTP Code: 200
Content Type : JSONapplication/json
Events retrieved successfully
Data Schema
currentPage
integer <int32>
opcional
perPage
integer <int32>
opcional
total
integer <int64>
opcional
items
array[object (SearchEventResponse) {9}]
opcional
id
string
opcional
name
string
opcional
description
string
opcional
company_id
string
opcional
init_date
string <date>
opcional
end_date
string <date>
opcional
status
enum<string>
opcional
Valores permitidos:
SCHEDULEDPUBLISHEDOPENEDIN_PROGRESSCANCELEDFINISHED
address
object (AddressResponse)
opcional
configuration
object
opcional
Example
{
"currentPage": 0,
"perPage": 0,
"total": 0,
"items": [
{
"id": "string",
"name": "string",
"description": "string",
"company_id": "string",
"init_date": "2019-08-24",
"end_date": "2019-08-24",
"status": "SCHEDULED",
"address": {
"street": "string",
"number": "string",
"complement": "string",
"neighborhood": "string",
"city": "string",
"state": "string",
"country": "string",
"zip_code": "string"
},
"configuration": {
"property1": "string",
"property2": "string"
}
}
]
}Last modified: 4 months ago