Additional Examples - Revision history

Andrea at 20:12, 21 September 2022

2022-09-21T20:12:03Z

← Older revision		Revision as of 15:12, 21 September 2022
Line 28:		Line 28:
	* /i4a/api/json/view.ams_contactinformation_corptype/corptype=Regular:isActive=1/<authkey> - This example's only purpose is to show how you could filter for a specific member type using this view. In this specific view, the member type field is called corptype. The search string "Regular" should be replaced by the name of a member type that exists in the database you are querying. Returns a json packet that contains all active database records where the member type is Regular.		* /i4a/api/json/view.ams_contactinformation_corptype/corptype=Regular:isActive=1/<authkey> - This example's only purpose is to show how you could filter for a specific member type using this view. In this specific view, the member type field is called corptype. The search string "Regular" should be replaced by the name of a member type that exists in the database you are querying. Returns a json packet that contains all active database records where the member type is Regular.

	'''[[I4A ~~api guide~~]]'''		'''[[I4A API Guide]]'''


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

Laura at 19:20, 8 November 2016

2016-11-08T19:20:08Z

← Older revision		Revision as of 14:20, 8 November 2016
Line 29:		Line 29:

	'''[[I4A api guide]]'''		'''[[I4A api guide]]'''


			[[Category:api]]

Laura: /* Organizational Database Model Examples */

2016-11-08T19:19:18Z

Organizational Database Model Examples

← Older revision		Revision as of 14:19, 8 November 2016
Line 28:		Line 28:
	* /i4a/api/json/view.ams_contactinformation_corptype/corptype=Regular:isActive=1/<authkey> - This example's only purpose is to show how you could filter for a specific member type using this view. In this specific view, the member type field is called corptype. The search string "Regular" should be replaced by the name of a member type that exists in the database you are querying. Returns a json packet that contains all active database records where the member type is Regular.		* /i4a/api/json/view.ams_contactinformation_corptype/corptype=Regular:isActive=1/<authkey> - This example's only purpose is to show how you could filter for a specific member type using this view. In this specific view, the member type field is called corptype. The search string "Regular" should be replaced by the name of a member type that exists in the database you are querying. Returns a json packet that contains all active database records where the member type is Regular.

	'''[[~~Return to API Guide \| I4A_api_guide~~]]'''		'''[[I4A api guide]]'''

Laura: /* Organizational Database Model Examples */

2016-11-08T19:17:30Z

Organizational Database Model Examples

← Older revision		Revision as of 14:17, 8 November 2016
Line 28:		Line 28:
	* /i4a/api/json/view.ams_contactinformation_corptype/corptype=Regular:isActive=1/<authkey> - This example's only purpose is to show how you could filter for a specific member type using this view. In this specific view, the member type field is called corptype. The search string "Regular" should be replaced by the name of a member type that exists in the database you are querying. Returns a json packet that contains all active database records where the member type is Regular.		* /i4a/api/json/view.ams_contactinformation_corptype/corptype=Regular:isActive=1/<authkey> - This example's only purpose is to show how you could filter for a specific member type using this view. In this specific view, the member type field is called corptype. The search string "Regular" should be replaced by the name of a member type that exists in the database you are querying. Returns a json packet that contains all active database records where the member type is Regular.

	'''[[Return to API Guide I4A_api_guide]]'''		'''[[Return to API Guide \| I4A_api_guide]]'''

Laura: /* Organizational Database Model Examples */

2016-11-08T19:17:17Z

Organizational Database Model Examples

← Older revision		Revision as of 14:17, 8 November 2016
Line 27:		Line 27:

	* /i4a/api/json/view.ams_contactinformation_corptype/corptype=Regular:isActive=1/<authkey> - This example's only purpose is to show how you could filter for a specific member type using this view. In this specific view, the member type field is called corptype. The search string "Regular" should be replaced by the name of a member type that exists in the database you are querying. Returns a json packet that contains all active database records where the member type is Regular.		* /i4a/api/json/view.ams_contactinformation_corptype/corptype=Regular:isActive=1/<authkey> - This example's only purpose is to show how you could filter for a specific member type using this view. In this specific view, the member type field is called corptype. The search string "Regular" should be replaced by the name of a member type that exists in the database you are querying. Returns a json packet that contains all active database records where the member type is Regular.

			'''[[Return to API Guide I4A_api_guide]]'''

Laura: /* Selecting a Data Source to use with the API */

2016-11-08T19:04:06Z

Selecting a Data Source to use with the API

← Older revision		Revision as of 14:04, 8 November 2016
Line 5:		Line 5:
	===Selecting a Data Source to use with the API===		===Selecting a Data Source to use with the API===

	Here are two views that can be used with the API~~, and contain membership information. This is not a complete list of all available views~~. Contact i4a for support if you are not able to get what you need using ~~the~~ views or tables in the examples provided.		Here are the two main views that can be used with the API. Contact i4a for support if you are not able to get what you need using these views, or from the tables in the examples provided.

	* '''ams_contactinformation_membertype''' - Includes the "membertype" field which contains the record's Member Type if it is populated. The "paidthru" field contains the record's Expiration Date. Records with a member type and a future expiration date are current members. '''''Use this with the individual database model only.'''''		* '''ams_contactinformation_membertype''' - Includes the "membertype" field which contains the record's Member Type if it is populated. The "paidthru" field contains the record's Expiration Date. Records with a member type and a future expiration date are current members. '''''Use this with the individual database model only.'''''

Laura: /* Filtering on Member Type and Expiration Date using the API */

2016-11-08T18:58:14Z

Filtering on Member Type and Expiration Date using the API

← Older revision		Revision as of 13:58, 8 November 2016
Line 10:		Line 10:

	* '''ams_contactinformation_corptype''' - Includes the "corptype" field which contains the record's Member Type if it is populated. The "corpexpiration" field contains the record's Expiration Date. Records with a member type and a future expiration date are current members. '''''Use this with the organizational database model only.'''''		* '''ams_contactinformation_corptype''' - Includes the "corptype" field which contains the record's Member Type if it is populated. The "corpexpiration" field contains the record's Expiration Date. Records with a member type and a future expiration date are current members. '''''Use this with the organizational database model only.'''''


	Below are some examples specific to each database model:		Below are some examples specific to each database model:

Laura at 18:57, 8 November 2016

2016-11-08T18:57:40Z

← Older revision		Revision as of 13:57, 8 November 2016
Line 2:		Line 2:

	The i4a system can be configured to use the Individual Database Model or the Organizational Database Model. The simplest way to determine the database model is to check for the presence of Manage Organizations on the Membership dropdown menu in the i4a system. If it is present, the system is configured to use the Organizational Database Model, and if it is absent, it is using the Individual Database Model.		The i4a system can be configured to use the Individual Database Model or the Organizational Database Model. The simplest way to determine the database model is to check for the presence of Manage Organizations on the Membership dropdown menu in the i4a system. If it is present, the system is configured to use the Organizational Database Model, and if it is absent, it is using the Individual Database Model.

			===Selecting a Data Source to use with the API===

			Here are two views that can be used with the API, and contain membership information. This is not a complete list of all available views. Contact i4a for support if you are not able to get what you need using the views or tables in the examples provided.

			* '''ams_contactinformation_membertype''' - Includes the "membertype" field which contains the record's Member Type if it is populated. The "paidthru" field contains the record's Expiration Date. Records with a member type and a future expiration date are current members. '''''Use this with the individual database model only.'''''

			* '''ams_contactinformation_corptype''' - Includes the "corptype" field which contains the record's Member Type if it is populated. The "corpexpiration" field contains the record's Expiration Date. Records with a member type and a future expiration date are current members. '''''Use this with the organizational database model only.'''''

	Below are some examples specific to each database model:		Below are some examples specific to each database model:

Laura: /* Organizational Database Model Examples */

2016-11-08T18:36:04Z

Organizational Database Model Examples

← Older revision		Revision as of 13:36, 8 November 2016
Line 14:		Line 14:

	===Organizational Database Model Examples===		===Organizational Database Model Examples===

			The following example uses the view ams_contactinformation_corptype. This view should only be used with the i4a Organizational Database Model.

	* /i4a/api/json/view.ams_contactinformation_corptype/corptype=Regular:isActive=1/<authkey> - This example's only purpose is to show how you could filter for a specific member type using this view. In this specific view, the member type field is called corptype. The search string "Regular" should be replaced by the name of a member type that exists in the database you are querying. Returns a json packet that contains all active database records where the member type is Regular.		* /i4a/api/json/view.ams_contactinformation_corptype/corptype=Regular:isActive=1/<authkey> - This example's only purpose is to show how you could filter for a specific member type using this view. In this specific view, the member type field is called corptype. The search string "Regular" should be replaced by the name of a member type that exists in the database you are querying. Returns a json packet that contains all active database records where the member type is Regular.

Laura: /* Organizational Database Model Examples */

2016-11-08T18:14:33Z

Organizational Database Model Examples

← Older revision		Revision as of 13:14, 8 November 2016
Line 15:		Line 15:
	===Organizational Database Model Examples===		===Organizational Database Model Examples===

	* /i4a/api/json/view.ams_contactinformation_corptype/corptype=Regular/<authkey> - This example's only purpose is to show how you could filter for a specific member type using this view. In this specific view, the member type field is called corptype. The search string "Regular" should be replaced by the name of a member type that exists in the database you are querying. Returns a json packet that contains all ~~matching~~ records where the member type is Regular.		* /i4a/api/json/view.ams_contactinformation_corptype/corptype=Regular:isActive=1/<authkey> - This example's only purpose is to show how you could filter for a specific member type using this view. In this specific view, the member type field is called corptype. The search string "Regular" should be replaced by the name of a member type that exists in the database you are querying. Returns a json packet that contains all active database records where the member type is Regular.