The Basic Meeting List Toolbox

Calling Syntax for Data Export

There are a number of possible values. When we say “array,” we mean that the same parameter is repeated, with an open/close bracket ([]) between it and the values. For example: meeting_ids[]=123&meeting_ids[]=456 indicates that two meetings are being sought by ID: 123, and 456.

NOTE: These are all case-sensitive!
 weekdays
This is an array of positive integers (1-7). This is interpreted as an array of integers. Each integer represents a weekday (1 -> Sunday, 7 -> Saturday). A positive integer means that the search will look specifically for meetings that occur on that weekday. If the integer is negative (preceded by a minus sign -), then the criteria will be to look for meetings that don’t occur on that weekday. If no ‘weekdays’ values are given, then the search will not use the weekday field as a search criteria.
The following values specify a start time “window.” The meeting must start on, or after StartsAfterH/M, and can start no later than StartsBeforeH/M
 StartsAfterH
A positive integer between 0 and 23. The hour of the minimal start time for meetings, in military time.
 StartsAfterM
A positive integer between 0 and 59. The minute of the minimal start time for meetings, in military time.
 StartsBeforeH
A positive integer between 0 and 23. The hour of the maximal start time for meetings, in military time.
 StartsBeforeM
A positive integer between 0 and 59. The minute of the maximal start time for meetings, in military time.
The following values specify a time duration “window.” The meeting can last no longer than MaxDurationH/M, and no less than MinDurationH/M.
 MinDurationH
A positive integer. This is the number of hours in the minimal duration.
 MinDurationM
A positive integer. This is the number of minutes in the minimal duration.
 MaxDurationH
A positive integer. This is the number of hours in the maximal duration.
 MaxDurationM
A positive integer. This is the number of minutes in the maximal duration.
This is how meetings are located. We don’t use address lookups. Instead, we geolocate the meetings via the longitude and latitude fields in each record. If you don’t specify a geolocation, then the entire database is searched. If you do specify one, then only the portion within the radius is searched.
 geo_width
A floating point number. This is the radius (not diameter) of the search, in MILES (not Kilometers). If this is negative, then it should be an integer, and that indicates an auto-radius is requested to find the number of meetings in the integer.
 geo_width_km
A floating point number. This is the radius (not diameter) of the search, in KILOMETERS (not Miles). If this is negative, then it should be an integer, and that indicates an auto-radius is requested to find the number of meetings in the integer.
 long_val
If one of the three radius specifiers is zero or undefined, this is ignored. This is a floating point number that specifies the longitude, in degrees, of the center of the search radius.
 lat_val
If one of the three radius specifiers is zero or undefined, this is ignored. This is a floating point number that specifies the latitude, in degrees, of the center of the search radius.
These are the various string search functions
 SearchString
A string. If this is specified, then all the string fields of the meetings specified by the above criteria will be searched for the string. By default, if the language supports metaphone (sound like search), then that is used.
 StringSearchIsAnAddress
A boolean. Nonzero means that the given string should not be checked against any of the fields in the meeting data. Instead, it is to be considered a submission to the Google Maps geocode, and will be used to determine a cernter point in a local search.
 SearchStringAll
If nonzero, then all of the words in the search string will have to be matched for a meeting to qualify.
 SearchStringExact
If nonzero, metaphone will not be used, and the spelling must be exact.
 SearchStringRadius
If specified, the radius of the search around the address (ignored if StringSearchIsAnAddress is false). The units are in whatever the server units are for this language (can be miles or kilometers). Negative numbers must always be integers, and specify a rough target number of meetings for auto-radius.
 meeting_key
A string or array of strings. This is/these are the exact name[s] of the key[s] to match. If this is null (Default), meeting_key_value, meeting_key_match_case and meeting_key_contains are ignored. Non-string fields are ignored. The default set of string-searchable fields are listed below. It is possible to change them, in which case you will need to get the fields from your Root Server Administrator. You can specify one of more of these to be searched. The default search method is a “contains” search, using metaphone (“sounds like”):

meeting_name
The name of the meeting.
location_text
The name of the location (“St. Hugh’s Rectory,” etc.)
location_info
Any additional information about the location (“Entrance in rear,” etc.)
location_street
The street address of the location (“123 Main St.,” etc.)
location_city_subsection
The “Borough,” or city subsection, usable for addresses (“Bronx,” etc.)
location_neighborhood
The neighborhood (“Greenwich Village,” “Castro,” “West End,” etc.)
location_municipality
The city (“New York,” “Baltimore,”) or town
location_sub_province
The County
location_province
The State or main province
location_postal_code_1
The zip code or postal code
location_nation
The nation (Usually expressed as abbreviation, “USA,” “UK,” etc.)
comments
Any comments about the meeting
train_lines
Nearby rail/metro stations and lines
bus_lines
Nearby bus lines
 meeting_key_value
A string. The value to match. NOTE: As of Version 1.5, this is matched with a metaphone match, as well as the RegEx match.
 meeting_key_match_case
If 1, the case must match. Default is 0. NOTE: As of Version 1.5, setting this to 1 also stops the metaphone search.
 meeting_key_contains
If this is set to 0, then the string must be complete. Default is 1 (contains).
These control the sorting
 sort_key
The keys by which to sort. These are established at the root server. The default keys are:

weekday
This sorts first, by weekday, then by town, then by borough, then by neighborhood, and finally by start time. This is the default for lists.
time
This sorts first, by weekday, then by start time, then by town, then by borough, and finally by neighborhood.
town
This sorts first, by town, then by borough, then by neighborhood, then by weekday, and finally, by start time.
 sort_dir
This is the direction of the sort. It can be:

asc
Ascending (Default)
desc
Descending
 sort_results_by_distance

( NOTE: This is only valid for root server version 1.8.11 and later!)

This only applies for radius sorts. If this is true (1), then the results will be sorted by distance after the initial sort (which means that sort by distance always has the highest priority). This will always be closest meetings first, farthest last.
These are more advanced parameters. Most require IDs and codes that you must get from the Root Server Administrator:
 sort_keys

( NOTE: new in Version 2.1)

This allows you to arbitrarily set the sort keys. The value is a comma-separated list of sort keys
Sort priority is left to right, with the highest priority item the first item, and the lowest being the last item.
The list is in database format; for example:

 weekday_tinyint,location_municipality,start_time

, for a search that will sort first on the weekday, then by the name of the town, then by the start time of the meeting. Specifying this will cause

 sort_key

to be ignored.

It will also override

 sort_dir

. The default sort will be ascending. If you want descending, then add

 desc

as one of the sort keys.

 services
This is an array of positive integers. Each integer represents the ID of a Service Body. A positive integer means that the search will look specifically for meetings that contain that Service Body ID. If the integer is negative (preceded by a minus sign -), then the criteria will be to look for meetings that don’t contain that ID. If no ‘services’ values are given, then the search will not use the Service Body field as a search criteria.
 meeting_ids
An array of positive integers. Each integer is an ID of an individual meeting. If this is set, all other search criteria are ignored.
 formats
This is an array of positive integers. This is interpreted as an array of integers. Each integer represents a format shared ID. A format ID means that the search will look specifically for meetings that have that format. If the format is negative (preceded by a minus sign -), then the criteria will be to look for meetings that don’t have that format. If no ‘formats’ values are given, then the search will not use the formats field as a search criteria.
 langs
This is an array of 2-character strings. The search will look specifically for meetings that are in the indicated language[s]. If the language is preceded by a minus sign -, then the criteria will be to look for meetings that are not in that language. If no ‘langs’ values are given, then the search will not use the lang_enum field as a search criteria.