CSV, XML and JSON Export Options

Examples:

Get all changes after July 4th, 2009 (CSV):

http://bmlt.magshare.net/stable/main_server/client_interface/csv/?switcher=GetChanges&start_date=2009-07-04

Get all changes in the 1-year period between July 4th, 2009, and July 3rd, 2010 (XML):

http://bmlt.magshare.net/stable/main_server/client_interface/xml/?switcher=GetChanges&start_date=2009-07-04&end_date=2010-07-03

Get all changes for the Kings Bay Area Service, in the 1-year period between July 4th, 2009, and July 3rd, 2010 (JSON):

http://bmlt.magshare.net/stable/main_server/client_interface/json/?switcher=GetChanges&start_date=2009-07-04&end_date=2010-07-03&service_body_id=1007

Get all changes for the meeting "People in Focus" (XML):

http://bmlt.magshare.net/stable/main_server/client_interface/xml/?switcher=GetChanges&meeting_id=273

Additional Response (XML Only)

The XML response now has the capability to return Service body information. This is accessed via the "GetServiceBodies.php" file. It is NOT a "switcher" value.

http://bmlt.magshare.net/stable/main_server/client_interface/xml/GetServiceBodies.php

This will return an XML response that is described in this schema:

http://bmlt.magshare.net/stable/main_server/client_interface/xsd/GetServiceBodies.php

Dynamic Schemas

For the XML export, the XML namespace and the XML schema are linked to your server. This is because they are actually dependent upon the setup for your server. For example, if you have added your own data items, then the choices for the data_field_key parameter will be different from the default. If we used a static XML schema, then your XML would fail validation.

However, the schema document is generated dynamically, and should ensure that your XML is always valid. The schema also serves a second purpose, in giving you a simple list of the possible values for the data_field_key parameter.

This link will access the schema for the default stable server. In many browsers, the screen will show as blank. However, look at the source. It is a pure XML Schema response, and will not display on most browsers. Some browsers will display well-formed XML, so you may actually see the schema without needing to view source.

The schema for your XML dump is available in the <meetings/> element:

<meetings xmlns="http://bmlt.magshare.net" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://bmlt.magshare.net
http://bmlt.magshare.net/stable/main_server/client_interface/xsd/GetSearchResults.php">

The BMLT XML Schema is a very, very simple schema. There's not much to the XML structure, which makes it eminently usable.

We do not currently provide a JSON schema, but are considering developing one. JSON schemas are not widely used. You can use the XML schema to determine the fields for JSON. They are exactly equivalent to each other.

The CSV data is a very basic CSV format, with the first row being the column names (header row)

Schema Elements

In CSV, the header will contain the keys for the data response. All keys will be used, including empty ones. In XML and JSON, empty keys will be removed.

In XML, each row will be bounded by a <row> element. The "id" attribute of the element will be an integer, and will be the index of the row (not the meeting ID). The "id_bigint" element can also be provided.

In XML, the "root" element is called "meetings". This element establishes the namespace and schema of the response data, which is well-formed and valid XML.

The response is given meeting-by-meeting, so there is no effort to consolidate repetitive data (for example, if the search centers on New York City, every localion_municipality will be "New York." If we wanted to optimize, we could simply send back one value. However, we send back the same value for all meetings. This allows users of the response data to design simple, effecive data handlers).

Examples

Now, we'll go over a few basic examples. We'll only display portions of the responses here, but you will be able to view the full responses by following the links.

CSV Examples

Get All Meetings In the Database That Start At or After 4PM, and Before or At 7PM on Any Weekday.

URI:

http://bmlt.magshare.net/stable/main_server/client_interface/csv/?switcher=GetSearchResults&sort_key=time&StartsAfterH=16&StartsBeforeH=19

Response:

"id_bigint","worldid_mixed","shared_group_id_bigint","service_body_bigint","weekday_tinyint","start_time","duration_time","formats","lang_enum","longitude","latitude","email_contact","meeting_name","location_text","location_info","location_street","location_city_subsection","location_neighborhood","location_municipality","location_sub_province","location_province","location_postal_code_1","location_nation","comments","train_lines","bus_lines","contact_phone_2","contact_email_2","contact_name_2","contact_phone_1","contact_email_1","contact_name_1","format_B","format_BL","format_BT","format_C","format_CH","format_CL","format_CS","format_D","format_ES","format_GL","format_IL","format_IP","format_IW","format_JT","format_M","format_NC","format_O","format_Pi","format_RF","format_Rr","format_SC","format_SD","format_SG","format_SL","format_Sm","format_So","format_St","format_Ti","format_To","format_Tr","format_TW","format_W","format_WC","format_YP","format_OE","format_BK","format_NS","format_Ag","format_FD","format_AB"
"24","00014731","","1005","1","16:15:00","01:30:00","O,RF","en","-73.905834","40.838762","","Meditation on Sundays","Our Lady of Victory Church","@171st St","1512 Webster Ave","Bronx","Claremont","New York","Bronx","NY","10457","USA","","","","","","","","","","0","0","0","0","0","0","0","0","0","0","0","0","0","0","0","0","1","0","1","0","0","0","0","0","0","0","0","0","0","0","0","0","0","0","0","0","0","0","0","0"
"346","00113665","","1010","1","16:30:00","01:30:00","C,JT,WC,BK","en","-73.976946","40.724846","","Just for Today","Housing Works, Ground Floor","Btwn Aves C&D","743 E 9th St","Manhattan","East Village","New York","New York","NY","10009","USA","","","","","","","","","","0","0","0","1","0","0","0","0","0","0","0","0","0","1","0","0","0","0","0","0","0","0","0","0","0","0","0","0","0","0","0","0","1","0","0","1","0","0","0","0"
"803","00010448","","1001","1","17:00:00","02:00:00","O,D,St","en","-73.4077826142311","40.7096557895169","","Surrender On Sunday","Community Center (On East Street)","","East St. at Cedar St.","","","Amityville","Suffolk","NY","11701","USA","","","","","","","","","","0","0","0","0","0","0","0","1","0","0","0","0","0","0","0","0","1","0","0","0","0","0","0","0","0","0","1","0","0","0","0","0","0","0","0","0","0","0","0","0"
"114","00000000","","1015","1","17:00:00","01:30:00","O,ES,St","es","-73.881634","40.880458","","Un Nuevo Empezar","North Central Bronx Hosp, Rm 14B07","Btwn E 210th St & Dekalb Ave","3424 Kossuth Ave","Bronx","Williamsbridge","New York","Bronx","NY","10467","USA","","Tren 4 hasta Mosholu Pkwy","Bus Bx 10 hasta Mosholu Pkwy","","","","","","","0","0","0","0","0","0","0","0","1","0","0","0","0","0","0","0","1","0","0","0","0","0","0","0","0","0","1","0","0","0","0","0","0","0","0","0","0","0","0","0"

Note that all of the fields are returned, and that empty fields are given ("'"). This is required for valid CSV data. Also, each column is bounded by double-quotes ("). If the data contains a double-quote, that quote is escaped (\"). The first row is always a header, and contains the data item keys.

Get All Meetings In the Database That Start At or After 4PM, and Before or At 7PM on Any Weekday, and only return the town and meeting name.

URI:

http://bmlt.magshare.net/stable/main_server/client_interface/csv/?switcher=GetSearchResults&sort_key=time&StartsAfterH=16&StartsBeforeH=19 &data_field_key=location_municipality,meeting_name

Response:

"meeting_name","location_municipality"
"Meditation on Sundays","New York"
"Just for Today","New York"
"Surrender On Sunday","Amityville"
"Un Nuevo Empezar","New York"

Note that no meeting ID is returned. If you need that, you should also specify the "id_bigint" column:

Get All Meetings In the Database That Start At or After 4PM, and Before or At 7PM on Any Weekday, and only return the meeting ID, town and meeting name.

URI:

http://bmlt.magshare.net/stable/main_server/client_interface/csv/?switcher=GetSearchResults&sort_key=time&StartsAfterH=16&StartsBeforeH=19 &data_field_key=location_municipality,meeting_name,id_bigint

Response:

id_bigint","meeting_name","location_municipality"
"24","Meditation on Sundays","New York"
"346","Just for Today","New York"
"803","Surrender On Sunday","Amityville"
"114","Un Nuevo Empezar","New York"

Note also that the order in which the columns are returned is up to the server. The order in which they are specified in the URI is irrelevant.

XML Examples

Get All Meetings In the Database That Start At or After 4PM, and Before or At 7PM on Any Weekday.

URI:

http://bmlt.magshare.net/stable/main_server/client_interface/xml/?switcher=GetSearchResults&sort_key=time&StartsAfterH=16&StartsBeforeH=19

Response:

<?xml version="1.0" encoding="UTF-8"?>
<meetings xmlns="http://bmlt.magshare.net" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://bmlt.magshare.net http://bmlt.magshare.net/stable/main_server/client_interface/xsd/GetSearchResults.php">
	<row id="0">
		<id_bigint>24</id_bigint>
		<worldid_mixed>00014731</worldid_mixed>
		<service_body_bigint>1005</service_body_bigint>
		<weekday_tinyint>1</weekday_tinyint>
		<start_time>16:15:00</start_time>
		<duration_time>01:30:00</duration_time>
		<formats>O,RF</formats>
		<lang_enum>en</lang_enum>
		<longitude>-73.905834</longitude>
		<latitude>40.838762</latitude>
		<meeting_name>Meditation on Sundays</meeting_name>
		<location_text>Our Lady of Victory Church</location_text>
		<location_info>@171st St</location_info>
		<location_street>1512 Webster Ave</location_street>
		<location_city_subsection>Bronx</location_city_subsection>
		<location_neighborhood>Claremont</location_neighborhood>
		<location_municipality>New York</location_municipality>
		<location_sub_province>Bronx</location_sub_province>
		<location_province>NY</location_province>
		<location_postal_code_1>10457</location_postal_code_1>
		<location_nation>USA</location_nation>
	</row>
	<row id="1">
		<id_bigint>346</id_bigint>
		<worldid_mixed>00113665</worldid_mixed>
		<service_body_bigint>1010</service_body_bigint>
		<weekday_tinyint>1</weekday_tinyint>
		<start_time>16:30:00</start_time>
		<duration_time>01:30:00</duration_time>
		<formats>C,JT,WC,BK</formats>
		<lang_enum>en</lang_enum>
		<longitude>-73.976946</longitude>
		<latitude>40.724846</latitude>
		<meeting_name>Just for Today</meeting_name>
		<location_text>Housing Works, Ground Floor</location_text>
		<location_info>Btwn Aves C&D</location_info>
		<location_street>743 E 9th St</location_street>
		<location_city_subsection>Manhattan</location_city_subsection>
		<location_neighborhood>East Village</location_neighborhood>
		<location_municipality>New York</location_municipality>
		<location_sub_province>New York</location_sub_province>
		<location_province>NY</location_province>
		<location_postal_code_1>10009</location_postal_code_1>
		<location_nation>USA</location_nation>
	</row>
	<row id="2">
		<id_bigint>803</id_bigint>
		<worldid_mixed>00010448</worldid_mixed>
		<service_body_bigint>1001</service_body_bigint>
		<weekday_tinyint>1</weekday_tinyint>
		<start_time>17:00:00</start_time>
		<duration_time>02:00:00</duration_time>
		<formats>O,D,St</formats>
		<lang_enum>en</lang_enum>
		<longitude>-73.4077826142311</longitude>
		<latitude>40.7096557895169</latitude>
		<meeting_name>Surrender On Sunday</meeting_name>
		<location_text>Community Center (On East Street)</location_text>
		<location_street>East St. at Cedar St.</location_street>
		<location_municipality>Amityville</location_municipality>
		<location_sub_province>Suffolk</location_sub_province>
		<location_province>NY</location_province>
		<location_postal_code_1>11701</location_postal_code_1>
		<location_nation>USA</location_nation>
		<comments>Last Sunday of every month is a Step meeting.</comments>
	</row>
	<row id="3">
		<id_bigint>114</id_bigint>
		<worldid_mixed>00000000</worldid_mixed>
		<service_body_bigint>1015</service_body_bigint>
		<weekday_tinyint>1</weekday_tinyint>
		<start_time>17:00:00</start_time>
		<duration_time>01:30:00</duration_time>
		<formats>O,ES,St</formats>
		<lang_enum>es</lang_enum>
		<longitude>-73.881634</longitude>
		<latitude>40.880458</latitude>
		<meeting_name>Un Nuevo Empezar</meeting_name>
		<location_text>North Central Bronx Hosp, Rm 14B07</location_text>
		<location_info>Btwn E 210th St & Dekalb Ave</location_info>
		<location_street>3424 Kossuth Ave</location_street>
		<location_city_subsection>Bronx</location_city_subsection>
		<location_neighborhood>Williamsbridge</location_neighborhood>
		<location_municipality>New York</location_municipality>
		<location_sub_province>Bronx</location_sub_province>
		<location_province>NY</location_province>
		<location_postal_code_1>10467</location_postal_code_1>
		<location_nation>USA</location_nation>
		<train_lines>Tren 4 hasta Mosholu Pkwy</train_lines>
		<bus_lines>Bus Bx 10 hasta Mosholu Pkwy</bus_lines>
	</row>

Note that the actual response data is returned as optimized XML, which means that everything is crammed into one line. This has been formatted for your reading pleasure. Also note that not all rows have all elements. If data is not supplied for an element, the element is not provided at all, as opposed to an empty element.

Get All Meetings In the Database That Start At or After 4PM, and Before or At 7PM on Any Weekday, and only return the town and meeting name.

URI:

http://bmlt.magshare.net/stable/main_server/client_interface/xml/?switcher=GetSearchResults&sort_key=time&StartsAfterH=16&StartsBeforeH=19 &data_field_key=location_municipality,meeting_name

Response:

<?xml version="1.0" encoding="UTF-8"?>
<meetings xmlns="http://bmlt.magshare.net" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://bmlt.magshare.net http://bmlt.magshare.net/stable/main_server/client_interface/xsd/GetSearchResults.php">
	<row id="0">
		<meeting_name>Meditation on Sundays</meeting_name>
		<location_municipality>New York</location_municipality>
	</row>
	<row id="1">
		<meeting_name>Just for Today</meeting_name>
		<location_municipality>New York</location_municipality>
	</row>
	<row id="2">
		<meeting_name>Surrender On Sunday</meeting_name>
		<location_municipality>Amityville</location_municipality>
	</row>
	<row id="3">
		<meeting_name>Un Nuevo Empezar</meeting_name>
		<location_municipality>New York</location_municipality>
	</row>

Get All Meetings In the Database That Start At or After 4PM, and Before or At 7PM on Any Weekday, and only return the meeting ID, town and meeting name.

URI:

http://bmlt.magshare.net/stable/main_server/client_interface/xml/?switcher=GetSearchResults&sort_key=time&StartsAfterH=16&StartsBeforeH=19 &data_field_key=location_municipality,meeting_name,id_bigint

Response:

<?xml version="1.0" encoding="UTF-8"?>
<meetings xmlns="http://bmlt.magshare.net" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://bmlt.magshare.net http://bmlt.magshare.net/stable/main_server/client_interface/xsd/GetSearchResults.php">
	<row id="0">
		<id_bigint>24</id_bigint>
		<meeting_name>Meditation on Sundays</meeting_name>
		<location_municipality>New York</location_municipality>
	</row>
	<row id="1">
		<id_bigint>346</id_bigint>
		<meeting_name>Just for Today</meeting_name>
		<location_municipality>New York</location_municipality>
	</row>
	<row id="2">
		<id_bigint>803</id_bigint>
		<meeting_name>Surrender On Sunday</meeting_name>
		<location_municipality>Amityville</location_municipality>
	</row>
	<row id="3">
		<id_bigint>114</id_bigint>
		<meeting_name>Un Nuevo Empezar</meeting_name>
		<location_municipality>New York</location_municipality>
	</row>

JSON Examples

Get All Meetings In the Database That Start At or After 4PM, and Before or At 7PM on Any Weekday.

URI:

http://bmlt.magshare.net/stable/main_server/client_interface/json/?switcher=GetSearchResults&sort_key=time&StartsAfterH=16&StartsBeforeH=19

Response:

[
	{"id_bigint":"24","worldid_mixed":"00014731","shared_group_id_bigint":"","service_body_bigint":"1005","weekday_tinyint":"1","start_time":"16:15:00","duration_time":"01:30:00","formats":"O,RF","lang_enum":"en","longitude":"-73.905834","latitude":"40.838762","email_contact":"","meeting_name":"Meditation on Sundays","location_text":"Our Lady of Victory Church","location_info":"@171st St","location_street":"1512 Webster Ave","location_city_subsection":"Bronx","location_neighborhood":"Claremont","location_municipality":"New York","location_sub_province":"Bronx","location_province":"NY","location_postal_code_1":"10457","location_nation":"USA"}
	{"id_bigint":"346","worldid_mixed":"00113665","shared_group_id_bigint":"","service_body_bigint":"1010","weekday_tinyint":"1","start_time":"16:30:00","duration_time":"01:30:00","formats":"C,JT,WC,BK","lang_enum":"en","longitude":"-73.976946","latitude":"40.724846","email_contact":"","meeting_name":"Just for Today","location_text":"Housing Works, Ground Floor","location_info":"Btwn Aves C&D","location_street":"743 E 9th St","location_city_subsection":"Manhattan","location_neighborhood":"East Village","location_municipality":"New York","location_sub_province":"New York","location_province":"NY","location_postal_code_1":"10009","location_nation":"USA"}
	{"id_bigint":"803","worldid_mixed":"00010448","shared_group_id_bigint":"","service_body_bigint":"1001","weekday_tinyint":"1","start_time":"17:00:00","duration_time":"02:00:00","formats":"O,D,St","lang_enum":"en","longitude":"-73.4077826142311","latitude":"40.7096557895169","email_contact":"","meeting_name":"Surrender On Sunday","location_text":"Community Center (On East Street)","location_info":"","location_street":"East St. at Cedar St.","location_city_subsection":"","location_neighborhood":"","location_municipality":"Amityville","location_sub_province":"Suffolk","location_province":"NY","location_postal_code_1":"11701","location_nation":"USA","comments":"Last Sunday of every month is a Step meeting."}
	{"id_bigint":"114","worldid_mixed":"00000000","shared_group_id_bigint":"","service_body_bigint":"1015","weekday_tinyint":"1","start_time":"17:00:00","duration_time":"01:30:00","formats":"O,ES,St","lang_enum":"es","longitude":"-73.881634","latitude":"40.880458","email_contact":"","meeting_name":"Un Nuevo Empezar","location_text":"North Central Bronx Hosp, Rm 14B07","location_info":"Btwn E 210th St & Dekalb Ave","location_street":"3424 Kossuth Ave","location_city_subsection":"Bronx","location_neighborhood":"Williamsbridge","location_municipality":"New York","location_sub_province":"Bronx","location_province":"NY","location_postal_code_1":"10467","location_nation":"USA","comments":"","train_lines":"Tren 4 hasta Mosholu Pkwy","bus_lines":"Bus Bx 10 hasta Mosholu Pkwy"}

Note that the actual response data is returned as optimized JSON, which means that everything is crammed into one line. This has been formatted for your reading pleasure. The JSON response is an array, with each element being a JSON object representing one meeting, and with named data members. Also note that not all rows have all data members. If data is not supplied for a data member, the data member is not provided at all, as opposed to an empty data member.

Get All Meetings In the Database That Start At or After 4PM, and Before or At 7PM on Any Weekday, and only return the town and meeting name.

URI:

http://bmlt.magshare.net/stable/main_server/client_interface/json/?switcher=GetSearchResults&sort_key=time&StartsAfterH=16&StartsBeforeH=19 &data_field_key=location_municipality,meeting_name

Response:

[
	{"meeting_name":"Meditation on Sundays","location_municipality":"New York"},
	{"meeting_name":"Just for Today","location_municipality":"New York"},
	{"meeting_name":"Surrender On Sunday","location_municipality":"Amityville"},
	{"meeting_name":"Un Nuevo Empezar","location_municipality":"New York"}

Get All Meetings In the Database That Start At or After 4PM, and Before or At 7PM on Any Weekday, and only return the meeting ID, town and meeting name.

URI:

http://bmlt.magshare.net/stable/main_server/client_interface/json/?switcher=GetSearchResults&sort_key=time&StartsAfterH=16&StartsBeforeH=19 &data_field_key=location_municipality,meeting_name,id_bigint

Response:

[
	{"id_bigint":"24","meeting_name":"Meditation on Sundays","location_municipality":"New York"},
	{"id_bigint":"346","meeting_name":"Just for Today","location_municipality":"New York"},
	{"id_bigint":"803","meeting_name":"Surrender On Sunday","location_municipality":"Amityville"},
	{"id_bigint":"114","meeting_name":"Un Nuevo Empezar","location_municipality":"New York"}