API resources

Search

The global search is the admin's search box as an endpoint. Give it a name, an e-mail address or a receipt number and it returns matching offers, editions, organisers, participants, accounts and receipts at once.

The search result model

Every group holds references with uuid and name (and alias where the record has one). Fetch the full record with its own endpoint.

Name
query
Type
string
Description
The search term, as sent.
Name
offers
Type
reference[]
Description
Offers whose name matches.
Name
editions
Type
reference[]
Description
Editions whose name matches.
Name
hosts
Type
reference[]
Description
Organisers whose name matches.
Name
participants
Type
reference[]
Description
Participants whose first or last name matches. Needs ROLE_PARTICIPANTS_ADMIN; empty otherwise.
Name
accounts
Type
reference[]
Description
Accounts whose first name, last name or e-mail matches. Needs ROLE_ADMIN; empty otherwise.
Name
receipts
Type
reference[]
Description
Receipts whose number or billing address matches, or that cover a participant whose name matches. The reference's name is the receipt number. Needs ROLE_PARTICIPANTS_ADMIN; empty otherwise.

GET/search

Search

Searches everything you may see. Organiser users get only their own offers and organisers, and the editions they can create offers in.

Required parameters

Name
q
Type
string
Description
The search term, at least 2 characters. A shorter term is a 400, a missing one a 422. Matches any part of a name, e-mail address or receipt number, ignoring case.

Optional parameters

Name
limit
Type
integer
Description
The maximum number of hits per group, from 1 to 50; values outside are moved into that range. Defaults to 10.

Request

GET·/search

curl -G https://ferienpass-musterstadt.de/api/search \
  -H "Authorization: Bearer $FEPLI_TOKEN" \
  --data-urlencode "q=Müller" \
  -d limit=5

Response

{
  "query": "Müller",
  "offers": [],
  "editions": [],
  "participants": [
    { "uuid": "0191c7b3-1f2a-7c4d-8e5f-6a7b8c9d0e06", "name": "Lena Müller" },
    { "uuid": "0191c7b3-2e3f-7a4b-9c5d-6e7f8a9b0c16", "name": "Paul Müller" }
  ],
  "accounts": [
    { "uuid": "0191c7b2-4d5e-7f60-8a1b-2c3d4e5f6a05", "name": "Anna Müller" }
  ],
  "hosts": [],
  "receipts": [
    { "uuid": "0192e1a0-7b8c-7d9e-a0f1-2b3c4d5e6f08", "name": "RE-142" }
  ]
}