Web Service Lookup (Lookup Specification) - Revision history

Randallkinard: /* GET Request Example */

2025-11-18T20:12:53Z

GET Request Example

← Older revision		Revision as of 15:12, 18 November 2025
Line 128:		Line 128:
	# The default of the Verb property, "GET", will be used for this example.		# The default of the Verb property, "GET", will be used for this example.
	# Click the ellipsis button to the right of the URL property to open its editor.		# Click the ellipsis button to the right of the URL property to open its editor.
	# ~~Enter the~~ URL ~~that~~ will ~~start the call to your API. For~~ this example, <pre>https://api.zippopotam.us/us/@ZIP_Code</pre>~~, will be used.~~		# The following URL will be used for this example. <pre>https://api.zippopotam.us/us/@ZIP_Code</pre>
	#* Note the @variable at the end. This is a key part of the URL. This is the information (zip codes in our case) that is passed into the API and fed back to Grooper.		#* Note the @variable at the end. This is a key part of the URL. This is the information (zip codes in our case) that is passed into the API and fed back to Grooper.
	#* Since we're wanting to retrieve city and state information related to zip codes, we'll be using [https://www.zippopotam.us/ Zippopotamus].		#* Since we're wanting to retrieve city and state information related to zip codes, we'll be using [https://www.zippopotam.us/ Zippopotamus].
Line 138:		Line 138:
	# Path is an expression which selects a scalar value from the record; our Record selector "places" in this case.		# Path is an expression which selects a scalar value from the record; our Record selector "places" in this case.
	#* Thinking back to the array, "['place name']" is associated with city, and "['state']" with State respectively. Thus, these will be the paths we set up.		#* Thinking back to the array, "['place name']" is associated with city, and "['state']" with State respectively. Thus, these will be the paths we set up.
	# Set the Path property to ['place name']		# Set the Path property to ['place name'].
	# Click the drop-down for the Target Field property, and select the appropriate Data Element. For our example, select "City" from the drop-down menu.		# Click the drop-down for the Target Field property, and select the appropriate Data Element. For our example, select "City" from the drop-down menu.
	#* Notice that these fields are the same as the Data Fields in our Data Model. The Target Field is the final destination for the data retrieved through the GET request, and where it will be displayed.		#* Notice that these fields are the same as the Data Fields in our Data Model. The Target Field is the final destination for the data retrieved through the GET request, and where it will be displayed.

Randallkinard: /* GET vs POST Requests */

2025-11-18T20:11:01Z

GET vs POST Requests

← Older revision		Revision as of 15:11, 18 November 2025
Line 93:		Line 93:
	⚠		⚠
	\|		\|
	Be aware:		'''Be aware:'''
	* Whether you configure a Web Service Lookup with a GET or POST is going to be determined by the parameters set by your API endpoint.		* Whether you configure a Web Service Lookup with a GET or POST is going to be determined by the parameters set by your API endpoint.
	** Some API's will expect a GET request. Some will expect a POST request. It's entirely dependent on how the API is set up.		** Some API's will expect a GET request. Some will expect a POST request. It's entirely dependent on how the API is set up.

Randallkinard: /* Response */

2025-11-18T20:10:18Z

Response

← Older revision		Revision as of 15:10, 18 November 2025
Line 75:		Line 75:
	* '''Value Selectors''':		* '''Value Selectors''':
	** Where one or more values extracted from each record are mapped to fields in Grooper.		** Where one or more values extracted from each record are mapped to fields in Grooper.
	** These are further divided into ~~'''~~Path~~'''~~ and ~~'''~~Field''.		** These are further divided into "Path" and "Field".
	*** The Path is a JSON or XML expression that pulls a value from the response.		*** The Path is a JSON or XML expression that pulls a value from the response.
	*** The Field is the target Data Field where the value will be stored in Grooper.		*** The Field is the target Data Field where the value will be stored in Grooper.

Randallkinard: /* Getting started */

2025-11-18T20:08:53Z

Getting started

← Older revision		Revision as of 15:08, 18 November 2025
Line 24:		Line 24:
	For this overview, we'll be going over how to access the Web Service Lookup. This particular lookup will will be accessing an API through GET/POST requests and to retrieve (or submit) a zip code and its related information (city and state). Further details will be expanded upon later in this article.		For this overview, we'll be going over how to access the Web Service Lookup. This particular lookup will will be accessing an API through GET/POST requests and to retrieve (or submit) a zip code and its related information (city and state). Further details will be expanded upon later in this article.

	# Select the ~~'''~~[[Data Model]]~~'''~~.		# Select the [[Data Model]].
	# Click the ellipses to the right of ~~'''~~Lookups~~'''~~ property.		# Click the ellipses to the right of "Lookups" property.
	# This will bring up the viewing window. Click the add button.		# This will bring up the viewing window. Click the add button.
	# Select Web Service Lookup.		# Select Web Service Lookup.

Randallkinard at 15:18, 14 November 2025

2025-11-14T15:18:03Z

← Older revision		Revision as of 10:18, 14 November 2025
Line 161:		Line 161:

	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]

			== Remaining Properties overview ==
			Below is a list of Web Service Lookup properties that weren't covered (the Request and Response properties) earlier in this article.

			=== Lookup Options ===
			* '''Trigger Mode'''
			** Controls when the lookup is executed.
			** Determines the conditions under which a lookup operation is performed in Grooper. This setting allows you to control whether lookups are executed automatically, only under certain conditions, manually, or based on a custom expression. Choosing the appropriate trigger mode is essential for balancing automation, user control, and data integrity in your solution.
			* '''Miss Disposition'''
			** Specifies what happens if the lookup returns no results.
			** Determines how Grooper responds when a lookup operation does not return any matching records from the external data source. This setting controls whether errors are flagged, target fields are cleared, or no action is taken.
			* '''Conflict Disposition'''
			** Specifies what happens if the lookup returns multiple results.
			** Controls how Grooper handles situations where a lookup operation returns more than one matching record from the external data source. This setting determines whether errors are flagged, data is cleared, the first result is accepted, or no action is taken.
			* '''Field Population'''
			** Specifies how target fields are populated with the lookup results.
			** Controls whether and how the results of a lookup operation are written to the target fields in Grooper. This setting determines if lookup results will overwrite existing values, supplement only empty fields, or leave all fields unchanged.

			=== Lookup Info ===
			* '''Lookup Fields'''
			** The list of fields and variables used as lookup criteria.
			** This property displays a comma-separated list of all Data Fields and Variable Definitions that are used as input for the lookup query. These are the values that will be sent to the external data source to perform the lookup.
			* '''Target Fields'''
			** The list of fields that will be populated by the lookup operation.
			** This property displays a comma-separated list of all Data Fields that will be set or validated by the results of the lookup. These are the target fields that will receive values from the external data source.

Randallkinard: /* GET Request Example */

2025-11-13T22:13:06Z

GET Request Example

← Older revision		Revision as of 17:13, 13 November 2025
Line 128:		Line 128:
	# The default of the Verb property, "GET", will be used for this example.		# The default of the Verb property, "GET", will be used for this example.
	# Click the ellipsis button to the right of the URL property to open its editor.		# Click the ellipsis button to the right of the URL property to open its editor.
	# Enter the URL that will start the call to your API. For this example, <~~code~~>https://api.zippopotam.us/us/@ZIP_Code</~~code~~>, will be used.		# Enter the URL that will start the call to your API. For this example, <pre>https://api.zippopotam.us/us/@ZIP_Code</pre>, will be used.
	#* Note the @variable at the end. This is a key part of the URL. This is the information (zip codes in our case) that is passed into the API and fed back to Grooper.		#* Note the @variable at the end. This is a key part of the URL. This is the information (zip codes in our case) that is passed into the API and fed back to Grooper.
	#* Since we're wanting to retrieve city and state information related to zip codes, we'll be using [https://www.zippopotam.us/ Zippopotamus].		#* Since we're wanting to retrieve city and state information related to zip codes, we'll be using [https://www.zippopotam.us/ Zippopotamus].
	# Now, for the Record Selector.		# Now, for the Record Selector.
	#*Since we're passing multiple pieces of information back to Grooper (city and state name relevant to our zip code), the JSON format of our GET request parses said information into an array called "places." See here for visual representation: [https://api.zippopotam.us/us/73013 ~~ZIP~~]		#*Since we're passing multiple pieces of information back to Grooper (city and state name relevant to our zip code), the JSON format of our GET request parses said information into an array called "places." See here for visual representation: [https://api.zippopotam.us/us/73013 Zippopotamus API Endpoint]
	#* Set the Record Selector to the string "places".		#* Set the Record Selector to the string "places".
	# To set up the Value Selectors, click the ellipses to the right of the property.		# To set up the Value Selectors, click the ellipses to the right of the property.

Randallkinard at 22:09, 13 November 2025

2025-11-13T22:09:49Z

Show changes

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

2024-10-04T20:32:36Z

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

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

Randallkinard at 17:07, 28 August 2024

2024-08-28T17:07:53Z

← Older revision		Revision as of 12:07, 28 August 2024
Line 1:		Line 1:
	{{~~Migrated2023~~}}		{{Migrated}}
	{{2023:{{PAGENAME}}}}		{{2023:{{PAGENAME}}}}

Randallkinard: Randallkinard moved page Web Service Lookup to Web Service Lookup (Lookup): new naming convention

2024-04-18T17:58:56Z

Randallkinard moved page Web Service Lookup to Web Service Lookup (Lookup): new naming convention

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