The Basic Meeting List Toolbox

Types of Semantics

Try The New Semantic Workshop!

The “Full Feature” Semantic Responses

These are the three “main” types of searches. These are CSV, JSON and XML. They have been designed to allow you to ask for more than just simple search results. You can also ask for things like format codes and descriptions, change records and Service bodies. For simplicity’s sake, we’ll only cover one parameter: the switcher parameter, which you add to your URL, to elicit these responses.

Examples

Standard meeting Searches

These are standard searches. You add the switcher parameter as “=GetSearchResults”, which tells the root server to execute a search, and return the results to you in the requested format.

http://bmlt.newyorkna.org/main_server/client_interface/[csv|json|xml]/?switcher=GetSearchResults

  1. The Entire Greater New York Region Database, as a CSV File (This will download a fairly large CSV File)
  2. The Entire Greater New York Region Database, as a JSON File (This will download a fairly large JSON File)
  3. The Entire Greater New York Region Database, as an XML File (This will download a fairly large XML File)

Format Legend

These simply ask the Root Server to return all the possible choices for the formats. Basically, a “format legend.” You add the switcher parameter as “=GetFormats”.

http://bmlt.newyorkna.org/main_server/client_interface/[csv|json|xml]/?switcher=GetFormats

  1. The Greater New York Region Format Legend, as a CSV File
  2. The Greater New York Region Format Legend, as a JSON File
  3. The Greater New York Region Format Legend, as an XML File

Service Bodies

These simply ask the Root Server to return all the Service bodies it handles. You add the switcher parameter as “=GetServiceBodies”.

http://bmlt.newyorkna.org/main_server/client_interface/[csv|json|xml]/?switcher=GetServiceBodies

  1. The Greater New York Region Root Server Service Bodies, as a CSV File
  2. The Greater New York Region Root Server Service Bodies, as a JSON File
  3. The Greater New York Region Root Server Service Bodies, as an XML File

Administration Changes

These return changes made to the meeting lists. You add the switcher parameter as “=GetChanges”, which tells the root server to return the changes in which you are interested in the requested format. This example, for simplicity’s sake, will return all of the changes ever made. That results in a very large response. In reality, you will filter for more specific ranges of changes.

http://bmlt.newyorkna.org/main_server/client_interface/[csv|json|xml]/?switcher=GetChanges

  1. All Changes Ever Made to the Entire Greater New York Region Database, as a CSV File (This will download a very large CSV File)
  2. All Changes Ever Made to the Entire Greater New York Region Database, as a JSON File (This will download a very large JSON File)
  3. All Changes Ever Made to the Entire Greater New York Region Database, as an XML File (This will download a very large XML File)

In the following pages, we’ll cover the specific parameters that you can supply with the “GetSearchResults” and “GetChanges” values of the switcher parameter. The “GetFormats” and “GetServiceBodies” values ignore any other parameters, and return the same things each time.

NAWS Dump

http://bmlt.newyorkna.org/main_server/client_interface/csv/?switcher=GetNAWSDump&sb_id=XXX

As of Root Server Release version 2.4.6, it is now possible to get a simple, direct, NAWS-format CSV dump from the server. This is done by using the “switcher=GetNAWSDump&sb_id=XXX” parameters, where “XXX” is the BMLT ID of the Service body (and any Service bodies contained, therein -for example, specifying a Region will also return all its constituent ASCS) that you wish to dump.

The result will be a standard NAWS-format CSV file.

Example: http://bmlt.newyorkna.org/main_server/client_interface/csv/?switcher=GetNAWSDump&sb_id=1

The Geographic Semantic Responses

These are the three searches that return simple results, designed to be used for mapping/GPS applications (GPX, KML and POI CSV). They only allow meeting searches (no formats or Service bodies), and return a greatly simplified response.

http://bmlt.newyorkna.org/main_server/client_interface/[gpx|kml|poi]/

  1. The Entire Greater New York Region Database, as a GPX File (This will download a fairly large GPX File)
  2. The Entire Greater New York Region Database, as a KML File (This will download a fairly large KML File)
  3. The Entire Greater New York Region Database, as an POI CSV File (This will download a fairly large CSV File)

These will ignore the switcher parameter, and will accept the same specifiers as the switcher=GetSearchResults value.

In the next page, we’ll look at specifying meeting searches for semantic response.