2023:Web Service Lookup (Lookup Specification) - Revision history

Randallkinard at 15:47, 22 November 2024

2024-11-22T15:47:19Z

← Older revision		Revision as of 10:47, 22 November 2024
Line 323:		Line 323:

	For more information on how XML differs from JSON and the benefits it may provide, click here: [https://www.geeksforgeeks.org/difference-between-json-and-xml/ GeeksforGeeks]		For more information on how XML differs from JSON and the benefits it may provide, click here: [https://www.geeksforgeeks.org/difference-between-json-and-xml/ GeeksforGeeks]

	~~== Glossary ==~~
	~~<u><big>'''Behavior'''</big></u>: {{#lst:Glossary\|Behavior}}~~

	~~<u><big>'''Content Model'''</big></u>: {{#lst:Glossary\|Content Model}}~~

	~~<u><big>'''Data Field'''</big></u>: {{#lst:Glossary\|Data Field}}~~

	~~<u><big>'''Data Model'''</big></u>: {{#lst:Glossary\|Data Model}}~~

	~~<u><big>'''Lookup'''</big></u>: {{#lst:Glossary\|Lookup}}~~

	~~<u><big>'''Project'''</big></u>: {{#lst:Glossary\|Project}}~~

	~~<u><big>'''Service'''</big></u>: {{#lst:Glossary\|Service}}~~

	~~<u><big>'''Web Service Lookup'''</big></u>: {{#lst:Glossary\|Web Service Lookup}}~~

Dgreenwood: Dgreenwood moved page 2023:Web Service Lookup (Lookup) to 2023:Web Service Lookup (Lookup Specification) without leaving a redirect

2024-10-04T20:32:24Z

Dgreenwood moved page 2023:Web Service Lookup (Lookup) to 2023:Web Service Lookup (Lookup Specification) without leaving a redirect

← Older revision	Revision as of 15:32, 4 October 2024
(No difference)

Randallkinard at 15:29, 27 August 2024

2024-08-27T15:29:20Z

@@ Line 10: / Line 10: @@
 * [[Media:2023 Wiki Web-Service-Lookup Project.zip]]
 |}
 == About ==
@@ Line 339: / Line 323: @@
 For more information on how XML differs from JSON and the benefits it may provide, click here: [https://www.geeksforgeeks.org/difference-between-json-and-xml/ GeeksforGeeks]

Randallkinard at 18:50, 10 May 2024

2024-05-10T18:50:53Z

@@ Line 10: / Line 10: @@
 * [[Media:2023 Wiki Web-Service-Lookup Project.zip]]
 |}
 == About ==
 '''''Web Service Lookup''''' is a new data lookup method in Grooper 2023.  It allows Grooper to collect and validate data by calling a web service.  The '''''Web Service Lookup''''' issues an HTTP GET or POST request and parses one or more records from the response.  For example, you could use the '''''Web Service Lookup''''' to validate mailing addresses using the USPS Web Tools API.  The '''''Web Service Lookup''''' would pass '''Data Field''' values Grooper collects in the request parameters and receive various values from the API from the web call.  If you passed a Grooper extracted zip code in the web request, you could return the city and state from the API.
 * For GET requests, parameters may be passed in the URL using "@variables" to replace a portion of the URL with a '''Data Field's''' value.

Randallkinard at 15:58, 29 April 2024

2024-04-29T15:58:33Z

← Older revision		Revision as of 10:58, 29 April 2024
Line 1:		Line 1:
	{{AutoVersion}}		{{AutoVersion}}
	~~<section begin="glossary" />~~
	<blockquote>		<blockquote>{{#lst:Glossary\|Web Service Lookup}}</blockquote>
	~~'''''~~Web Service Lookup~~''''' is a type of '''''Lookup''''' that can be performed in Grooper. It looks up external data at an API (Application Programing Interface) endpoint by calling a web service.~~
	</blockquote>
	~~<section end="glossary" /~~>

	{\|class="download-box"		{\|class="download-box"

Randallkinard: Randallkinard moved page 2023:Web Service Lookup to 2023:Web Service Lookup (Lookup) without leaving a redirect: new naming convention

2024-04-18T17:58:45Z

Randallkinard moved page 2023:Web Service Lookup to 2023:Web Service Lookup (Lookup) without leaving a redirect: new naming convention

← Older revision	Revision as of 12:58, 18 April 2024
(No difference)

Dgreenwood: /* About */

2024-04-04T18:29:15Z

About

← Older revision		Revision as of 13:29, 4 April 2024
Line 5:		Line 5:
	</blockquote>		</blockquote>
	<section end="glossary" />		<section end="glossary" />

	~~== About ==~~

	{\|class="download-box"		{\|class="download-box"
Line 13:		Line 11:
	\|		\|
	You may download and import the files below into your own Grooper environment (version 2023). This contains a '''Project''' with the '''Content Models''' used as examples throughout this article.		You may download and import the files below into your own Grooper environment (version 2023). This contains a '''Project''' with the '''Content Models''' used as examples throughout this article.
	* [[Media:2023 ~~Project -~~ Wiki - ~~Web~~ Service Lookup.zip]]		* [[Media:2023 Wiki Web-Service-Lookup Project.zip]]
	\|}		\|}
			== About ==

	'''''Web Service Lookup''''' is a new data lookup method in Grooper 2023. It allows Grooper to collect and validate data by calling a web service. The '''''Web Service Lookup''''' issues an HTTP GET or POST request and parses one or more records from the response. For example, you could use the '''''Web Service Lookup''''' to validate mailing addresses using the USPS Web Tools API. The '''''Web Service Lookup''''' would pass '''Data Field''' values Grooper collects in the request parameters and receive various values from the API from the web call. If you passed a Grooper extracted zip code in the web request, you could return the city and state from the API.		'''''Web Service Lookup''''' is a new data lookup method in Grooper 2023. It allows Grooper to collect and validate data by calling a web service. The '''''Web Service Lookup''''' issues an HTTP GET or POST request and parses one or more records from the response. For example, you could use the '''''Web Service Lookup''''' to validate mailing addresses using the USPS Web Tools API. The '''''Web Service Lookup''''' would pass '''Data Field''' values Grooper collects in the request parameters and receive various values from the API from the web call. If you passed a Grooper extracted zip code in the web request, you could return the city and state from the API.

Dgreenwood: /* JSON vs XML */

2024-02-26T22:21:59Z

JSON vs XML

← Older revision		Revision as of 17:21, 26 February 2024
Line 314:		Line 314:

	=== JSON vs XML ===		=== JSON vs XML ===
	Grooper offers the option to choose between JSON or XML formatting when creating your lookup. The chosen Message Format depends ~~on your preferences as well as~~ the type of data you're working with. The differences between the two are highlighted briefly below.		Grooper offers the option to choose between JSON or XML formatting when creating your lookup. The chosen Message Format depends the type of data you're working with and what format the destination API uses. The differences between the two are highlighted briefly below.

	For more information on JSON and XML, please click the following link: [https://appmaster.io/blog/json-vs-xml AppMaster]		For more information on JSON and XML, please click the following link: [https://appmaster.io/blog/json-vs-xml AppMaster]

Dgreenwood: /* POST Request */

2024-02-26T22:17:13Z

POST Request

← Older revision		Revision as of 17:17, 26 February 2024
Line 227:		Line 227:
	</tabs>		</tabs>

	==== POST Request ====		==== POST Request Example ====

	POST requests send, or post, data to a requested server. The data is included in the URL path and uploaded for storage, making a change on that server. POST requests are not cached and do not remain in browser history, making them ideal for more sensitive data as opposed to GET requests.		POST requests send, or post, data to a requested server. The data is included in the URL path and uploaded for storage, making a change on that server. POST requests are not cached and do not remain in browser history, making them ideal for more sensitive data as opposed to GET requests.

			'''''Please note: This is just one example. You will need to know specifics about the API endpoint you're calling, such as if the request requires any HTML headers, to successfully configure any Web Service Lookup. You will need to refer to the the endpoint API's documentation for this information.'''''

	<tabs style="margin:20px">		<tabs style="margin:20px">
	<tab name ="Add Lookup" style="margin:20px">		<tab name ="Add Lookup" style="margin:20px">

Dgreenwood: /* GET Request */

2024-02-26T22:16:48Z

GET Request

← Older revision		Revision as of 17:16, 26 February 2024
Line 145:		Line 145:
	** Be aware! the message format depends on each individual API. Be sure to read the API's documentation to know if the API supports XML or JSON requests.		** Be aware! the message format depends on each individual API. Be sure to read the API's documentation to know if the API supports XML or JSON requests.

	==== GET Request ====		==== GET Request Example ====

			'''''Please note: This is just one example. You will need to know specifics about the API endpoint you're calling, such as if the request requires any HTML headers, to successfully configure any Web Service Lookup. You will need to refer to the the endpoint API's documentation for this information.'''''

	<tabs style="margin:20px">		<tabs style="margin:20px">
	<tab name="Add Lookup" style="margin:20px">		<tab name="Add Lookup" style="margin:20px">

← Older revision		Revision as of 10:47, 22 November 2024
Line 323:		Line 323:

	For more information on how XML differs from JSON and the benefits it may provide, click here: [https://www.geeksforgeeks.org/difference-between-json-and-xml/ GeeksforGeeks]		For more information on how XML differs from JSON and the benefits it may provide, click here: [https://www.geeksforgeeks.org/difference-between-json-and-xml/ GeeksforGeeks]

	~~== Glossary ==~~
	~~<u><big>'''Behavior'''</big></u>: {{#lst:Glossary\|Behavior}}~~

	~~<u><big>'''Content Model'''</big></u>: {{#lst:Glossary\|Content Model}}~~

	~~<u><big>'''Data Field'''</big></u>: {{#lst:Glossary\|Data Field}}~~

	~~<u><big>'''Data Model'''</big></u>: {{#lst:Glossary\|Data Model}}~~

	~~<u><big>'''Lookup'''</big></u>: {{#lst:Glossary\|Lookup}}~~

	~~<u><big>'''Project'''</big></u>: {{#lst:Glossary\|Project}}~~

	~~<u><big>'''Service'''</big></u>: {{#lst:Glossary\|Service}}~~

	~~<u><big>'''Web Service Lookup'''</big></u>: {{#lst:Glossary\|Web Service Lookup}}~~