API Return Format - Revision history

Andrea: Andrea moved page Api return format to API Return Format

2022-09-21T20:19:29Z

Andrea moved page Api return format to API Return Format

← Older revision	Revision as of 15:19, 21 September 2022
(No difference)

Andrea at 20:19, 21 September 2022

2022-09-21T20:19:15Z

← Older revision		Revision as of 15:19, 21 September 2022
Line 5:		Line 5:

	== Usage ==		== Usage ==
	Simply put the return format in the ~~url~~ string right after the /i4a/api/ part of the ~~url~~. By default each format will set the content-type in the HTML header. This is known to cause problems with some browsers and frameworks. If you are experiencing issues you can append _noheader to the format name and the data will be returned to you "RAW" with no headers being set. For instance you can could pass:		Simply put the return format in the URL string right after the /i4a/api/ part of the URL. By default each format will set the content-type in the HTML header. This is known to cause problems with some browsers and frameworks. If you are experiencing issues you can append _noheader to the format name and the data will be returned to you "RAW" with no headers being set. For instance you can could pass:

	/i4a/api/json_noheader/membership.contact/24228 and it would return the same json data, but would not populate the HEADER that is returned to the calling page.		/i4a/api/json_noheader/membership.contact/24228 and it would return the same json data, but would not populate the HEADER that is returned to the calling page.
Line 16:		Line 16:

	=== wddx ===		=== wddx ===
	Wddx is nothing more than a specialized XML packet. It has a defined ~~stucture~~ in how the XML is organized, but otherwise it is identical to an XML document.		Wddx is nothing more than a specialized XML packet. It has a defined structure in how the XML is organized, but otherwise it is identical to an XML document.

	=== Links ===		=== Links ===

Andrea at 20:18, 21 September 2022

2022-09-21T20:18:46Z

← Older revision		Revision as of 15:18, 21 September 2022
Line 1:		Line 1:
	[[~~I4A_api_guide~~]]		[[I4A API Guide]]

	== Description ==		== Description ==

Andrea at 20:12, 21 September 2022

2022-09-21T20:12:22Z

← Older revision		Revision as of 15:12, 21 September 2022
Line 25:		Line 25:


	[[Category:~~api~~]]		[[Category:API]]

Andrea: /* Links */

2022-09-21T19:24:27Z

Links

← Older revision		Revision as of 14:24, 21 September 2022
Line 19:		Line 19:

	=== Links ===		=== Links ===
	* ~~http~~://www.json.org/ - The source for information on json format		* https://www.json.org/ - The source for information on json format
	* ~~http~~://en.wikipedia.org/wiki/JSON - Wikipedia article on json format		* https://en.wikipedia.org/wiki/JSON - Wikipedia article on json format
	* ~~http~~://en.wikipedia.org/wiki/XML - Wikipedia article on xml format		* https://en.wikipedia.org/wiki/XML - Wikipedia article on xml format
	* ~~http~~://en.wikipedia.org/wiki/Wddx - Wikipedia article on wddx format		* https://en.wikipedia.org/wiki/Wddx - Wikipedia article on wddx format


	[[Category:api]]		[[Category:api]]

Langhorne: Created page with "I4A_api_guide == Description == The API uses the REST methodology and can return data back to the sender in a number of formats. They are: == Usage == Simply put the retur..."

2011-04-05T19:05:12Z

Created page with "I4A_api_guide == Description == The API uses the REST methodology and can return data back to the sender in a number of formats. They are: == Usage == Simply put the retur..."

New page

[[I4A_api_guide]]

== Description ==
The API uses the REST methodology and can return data back to the sender in a number of formats. They are:

== Usage ==
Simply put the return format in the url string right after the /i4a/api/ part of the url. By default each format will set the content-type in the HTML header. This is known to cause problems with some browsers and frameworks. If you are experiencing issues you can append _noheader to the format name and the data will be returned to you "RAW" with no headers being set. For instance you can could pass:

/i4a/api/json_noheader/membership.contact/24228 and it would return the same json data, but would not populate the HEADER that is returned to the calling page.

=== json ===
Json is a compact text based format, that at first glance looks somewhat like a traditional CSV file. It is becoming very popular with Web 2.0 and is used most often with AJAX.

=== xml ===

=== wddx ===
Wddx is nothing more than a specialized XML packet. It has a defined stucture in how the XML is organized, but otherwise it is identical to an XML document.

=== Links ===
* http://www.json.org/ - The source for information on json format
* http://en.wikipedia.org/wiki/JSON - Wikipedia article on json format
* http://en.wikipedia.org/wiki/XML - Wikipedia article on xml format
* http://en.wikipedia.org/wiki/Wddx - Wikipedia article on wddx format

[[Category:api]]