API Method /users/search

This function handles user search. It performs the requested search, returning the results as an XML file.

Arguments

authentication: This method requires the usual authentication arguments.
keywords string: The search keywords.
sort_order string: Orders sorting of results by "relevance" (default), "username", "event_count", "venue_count", or "calendar_count".
count_only boolean: If count_only is set, an abbreviated version of the output will be returned. Only total_items and search_time elements are included in the result.
page_size integer: The desired number of results per "page".
page_number integer: The desired "page" number.

Example Request

Here's an example venue search URL:

http://api.evdb.com/rest/users/search?...&keywords=eventor

Output Parameters

Output from this function is an XML block with the following constructs:

total_items integer

The total number of venues matching this search.

page_size integer

The number of venues per "page" of returned.

page_count integer

The number of "pages" of output.

page_number integer

The current "page" number.

page_items integer

The number of venues returned in this block. This is not necessarly the same as page_count. The last page, for instance will probably not be a full page.

first_item integer

The item number of the first element on this page.

last_item integer

The item number of the last element on this page.

search_time float

The fractional number of seconds it took to satisfy this query.

users array

An array of usernames. Each user is composed of:

username string: The unique username of the user

Example XML Response

<?xml version="1.0" encoding="UTF-8"?>
<search version="0.2">
  <total_items>1</total_items>
  <page_size>10</page_size>
  <page_count>1</page_count>
  <page_number>1</page_number>
  <page_items>1</page_items>
  <first_item>1</first_item>
  <last_item>1</last_item>
  <search_time>0.003</search_time>
  <users>
    <user>
      <username>eventor</username>
    </user>
  </users>
</search>

Error Codes

This method may return these errors in an error document:

Authentication error: The specified user was not found or provided invalid credentials.
Missing parameter: A required parameter was not provided.

Eventful

Overview

Tools