API Responses - Revision history

Dave: /* Microsoft Azure */

2023-12-22T16:37:16Z

Microsoft Azure

← Older revision		Revision as of 16:37, 22 December 2023
Line 64:		Line 64:
	==== Microsoft Azure ====		==== Microsoft Azure ====

	When integrating the API with Microsoft Azure data pipelines there is an additional parameter that can be of assistance. ~~In the API standard we utilize the~~ response from ~~out~~ API is a JSON object with a key called "data" which contains an array of objects. Azure instead wants the response to simply be that array of objects only. So in order to force the Golden Retriever API to return the data in the format expected by Azure add the URL parameter $azure=1		When integrating the API with Microsoft Azure data pipelines there is an additional parameter that can be of assistance. The response from our API is a JSON object with a key called "data" which contains an array of objects. Azure instead wants the response to simply be that array of objects only. So in order to force the Golden Retriever API to return the data in the format expected by Azure add the URL parameter $azure=1

	For example:		For example:

Dave at 16:36, 22 December 2023

2023-12-22T16:36:24Z

← Older revision		Revision as of 16:36, 22 December 2023
Line 61:		Line 61:
	or		or
	'''curl -X GET -H "Content-Type: application/json" -H "authorization: <api_key>" "<nowiki>https://api.thedog.io/dictionary?%24or%5BDisplay_Name%5D%5B%24search%5D=5L37&%24or%5BDisplay_Name%5D%5B%24search%5D=5L38</nowiki>"'''		'''curl -X GET -H "Content-Type: application/json" -H "authorization: <api_key>" "<nowiki>https://api.thedog.io/dictionary?%24or%5BDisplay_Name%5D%5B%24search%5D=5L37&%24or%5BDisplay_Name%5D%5B%24search%5D=5L38</nowiki>"'''

			==== Microsoft Azure ====

			When integrating the API with Microsoft Azure data pipelines there is an additional parameter that can be of assistance. In the API standard we utilize the response from out API is a JSON object with a key called "data" which contains an array of objects. Azure instead wants the response to simply be that array of objects only. So in order to force the Golden Retriever API to return the data in the format expected by Azure add the URL parameter $azure=1

			For example:

			'''curl -X GET -H "Content-Type: application/json" -H "authorization: <api_key>" "<nowiki>https://api.thedog.io/dictionary?$azure=1</nowiki>"'''
			or
			'''curl -X GET -H "Content-Type: application/json" -H "authorization: <api_key>" "<nowiki>https://api.thedog.io/dictionary?%24azure=1</nowiki>"'''

Dave: /* Filtering Results */

2023-12-22T16:31:27Z

Filtering Results

← Older revision		Revision as of 16:31, 22 December 2023
Line 31:		Line 31:
	Display_Name[$in][]=A&Display_Name[$in][]=I,B&Display_Name[$in][]=R		Display_Name[$in][]=A&Display_Name[$in][]=I,B&Display_Name[$in][]=R

	For ~~Example~~:		For example:
	'''curl -X GET -H "Content-Type: application/json" -H "authorization: <api_key>" "<nowiki>https://api.thedog.io/dictionary?Display_Name[$in][]=A&Display_Name[$in][]=I,B&Display_Name[$in][]=R</nowiki>"'''		'''curl -X GET -H "Content-Type: application/json" -H "authorization: <api_key>" "<nowiki>https://api.thedog.io/dictionary?Display_Name[$in][]=A&Display_Name[$in][]=I,B&Display_Name[$in][]=R</nowiki>"'''
	or		or
Line 44:		Line 44:
	etc		etc

	For ~~Example~~:		For example:
	'''curl -X GET -H "Content-Type: application/json" -H "authorization: <api_key>" "<nowiki>https://api.thedog.io/dictionary?Dictionary_no[$lt]=43</nowiki>"'''		'''curl -X GET -H "Content-Type: application/json" -H "authorization: <api_key>" "<nowiki>https://api.thedog.io/dictionary?Dictionary_no[$lt]=43</nowiki>"'''
	or		or

Dave: /* Filtering Results */

2023-12-22T16:31:15Z

Filtering Results

← Older revision		Revision as of 16:31, 22 December 2023
Line 44:		Line 44:
	etc		etc

			For Example:
	'''curl -X GET -H "Content-Type: application/json" -H "authorization: <api_key>" "<nowiki>https://api.thedog.io/dictionary?Dictionary_no[$lt]=43</nowiki>"'''		'''curl -X GET -H "Content-Type: application/json" -H "authorization: <api_key>" "<nowiki>https://api.thedog.io/dictionary?Dictionary_no[$lt]=43</nowiki>"'''
	or		or

Dave: /* Filtering Results */

2023-12-22T16:30:49Z

Filtering Results

← Older revision		Revision as of 16:30, 22 December 2023
Line 29:		Line 29:
	If you wish to restrict to multiple values you can use the special term "$in" or "$nin" (not in) like so:		If you wish to restrict to multiple values you can use the special term "$in" or "$nin" (not in) like so:

	Display_Name[$in][]=A&Display_Name[$in][]=I,B&Display_Name[$in][]=R		Display_Name[$in][]=A&Display_Name[$in][]=I,B&Display_Name[$in][]=R

			For Example:
	'''curl -X GET -H "Content-Type: application/json" -H "authorization: <api_key>" "<nowiki>https://api.thedog.io/dictionary?Display_Name[$in][]=A&Display_Name[$in][]=I,B&Display_Name[$in][]=R</nowiki>"'''		'''curl -X GET -H "Content-Type: application/json" -H "authorization: <api_key>" "<nowiki>https://api.thedog.io/dictionary?Display_Name[$in][]=A&Display_Name[$in][]=I,B&Display_Name[$in][]=R</nowiki>"'''
	or		or

Dave: /* Search */

2023-12-22T16:30:32Z

← Older revision		Revision as of 16:30, 22 December 2023
Line 51:		Line 51:
	Lastly we also have the ability to search for a substring in a field:		Lastly we also have the ability to search for a substring in a field:

	$or[Display_Name][$search]=5L37		$or[Display_Name][$search]=5L37
	$or[Display_Name][$search]=5L38		$or[Display_Name][$search]=5L38

			For example:

	'''curl -X GET -H "Content-Type: application/json" -H "authorization: <api_key>" "<nowiki>https://api.thedog.io/dictionary?$or[Display_Name][$search]=5L37&$or[Display_Name][$search]=5L38</nowiki>"'''		'''curl -X GET -H "Content-Type: application/json" -H "authorization: <api_key>" "<nowiki>https://api.thedog.io/dictionary?$or[Display_Name][$search]=5L37&$or[Display_Name][$search]=5L38</nowiki>"'''
	or		or
	'''curl -X GET -H "Content-Type: application/json" -H "authorization: <api_key>" "<nowiki>https://api.thedog.io/dictionary?%24or%5BDisplay_Name%5D%5B%24search%5D=5L37&%24or%5BDisplay_Name%5D%5B%24search%5D=5L38</nowiki>"'''		'''curl -X GET -H "Content-Type: application/json" -H "authorization: <api_key>" "<nowiki>https://api.thedog.io/dictionary?%24or%5BDisplay_Name%5D%5B%24search%5D=5L37&%24or%5BDisplay_Name%5D%5B%24search%5D=5L38</nowiki>"'''

Dave: /* Search */

2023-12-22T16:30:03Z

← Older revision		Revision as of 16:30, 22 December 2023
Line 49:		Line 49:
	==== Search ====		==== Search ====

	Lastly we also ~~currently~~ have the ability to search for a substring in a field:		Lastly we also have the ability to search for a substring in a field:

	$or[Display_Name][$search]=5L37		$or[Display_Name][$search]=5L37

Dave at 16:29, 22 December 2023

2023-12-22T16:29:47Z

← Older revision		Revision as of 16:29, 22 December 2023
Line 54:		Line 54:
	$or[Display_Name][$search]=5L38		$or[Display_Name][$search]=5L38

	'''curl -X GET -H "Content-Type: application/json" -H "authorization: <api_key>" "https://api.thedog.io/dictionary?$or[Display_Name][$search]=5L37&$or[Display_Name][$search]=5L38"'''		'''curl -X GET -H "Content-Type: application/json" -H "authorization: <api_key>" "<nowiki>https://api.thedog.io/dictionary?$or[Display_Name][$search]=5L37&$or[Display_Name][$search]=5L38</nowiki>"'''
	or		or
	'''curl -X GET -H "Content-Type: application/json" -H "authorization: <api_key>" "https://api.thedog.io/dictionary?%24or%5BDisplay_Name%5D%5B%24search%5D=5L37&%24or%5BDisplay_Name%5D%5B%24search%5D=5L38"'''		'''curl -X GET -H "Content-Type: application/json" -H "authorization: <api_key>" "<nowiki>https://api.thedog.io/dictionary?%24or%5BDisplay_Name%5D%5B%24search%5D=5L37&%24or%5BDisplay_Name%5D%5B%24search%5D=5L38</nowiki>"'''

Dave at 16:29, 22 December 2023

2023-12-22T16:29:08Z

← Older revision		Revision as of 16:29, 22 December 2023
Line 46:		Line 46:
	or		or
	'''curl -X GET -H "Content-Type: application/json" -H "authorization: <api_key>" "<nowiki>https://api.thedog.io/dictionary?Dictionary_no%5B%24lt%5D=43</nowiki>"'''		'''curl -X GET -H "Content-Type: application/json" -H "authorization: <api_key>" "<nowiki>https://api.thedog.io/dictionary?Dictionary_no%5B%24lt%5D=43</nowiki>"'''

			==== Search ====

			Lastly we also currently have the ability to search for a substring in a field:

			$or[Display_Name][$search]=5L37
			$or[Display_Name][$search]=5L38

			'''curl -X GET -H "Content-Type: application/json" -H "authorization: <api_key>" "https://api.thedog.io/dictionary?$or[Display_Name][$search]=5L37&$or[Display_Name][$search]=5L38"'''
			or
			'''curl -X GET -H "Content-Type: application/json" -H "authorization: <api_key>" "https://api.thedog.io/dictionary?%24or%5BDisplay_Name%5D%5B%24search%5D=5L37&%24or%5BDisplay_Name%5D%5B%24search%5D=5L38"'''

Dave at 16:21, 22 December 2023

2023-12-22T16:21:57Z

← Older revision		Revision as of 16:21, 22 December 2023
Line 7:		Line 7:
	or		or

	'''curl -X GET -H "Content-Type: application/json" -H "authorization: <api_key>" "https://api.thedog.io/dictionary?%24limit=2&%24skip=6"'''		'''curl -X GET -H "Content-Type: application/json" -H "authorization: <api_key>" "<nowiki>https://api.thedog.io/dictionary?%24limit=2&%24skip=6</nowiki>"'''

	This will grab two records starting on the 7th record.		This will grab two records starting on the 7th record.
Line 17:		Line 17:
	$sort[CreatedOn]=asc (or when URL encoded: %24sort%5BCreatedOn%5D=asc)		$sort[CreatedOn]=asc (or when URL encoded: %24sort%5BCreatedOn%5D=asc)

	'''curl -X GET -H "Content-Type: application/json" -H "authorization: <api_key>" "https://api.thedog.io/dictionary?$sort[CreatedOn]=asc"'''		'''curl -X GET -H "Content-Type: application/json" -H "authorization: <api_key>" "<nowiki>https://api.thedog.io/dictionary?$sort[CreatedOn]=asc</nowiki>"'''

	or		or

	'''curl -X GET -H "Content-Type: application/json" -H "authorization: <api_key>" "https://api.thedog.io/dictionary?%24sort%5BCreatedOn%5D=asc"'''		'''curl -X GET -H "Content-Type: application/json" -H "authorization: <api_key>" "<nowiki>https://api.thedog.io/dictionary?%24sort%5BCreatedOn%5D=asc</nowiki>"'''

	You can either use "asc" or "desc" for the direction of the sort.		You can either use "asc" or "desc" for the direction of the sort.
Line 31:		Line 31:
	Display_Name[$in][]=A&Display_Name[$in][]=I,B&Display_Name[$in][]=R		Display_Name[$in][]=A&Display_Name[$in][]=I,B&Display_Name[$in][]=R

	'''curl -X GET -H "Content-Type: application/json" -H "authorization: <api_key>" "https://api.thedog.io/dictionary?Display_Name[$in][]=A&Display_Name[$in][]=I,B&Display_Name[$in][]=R"'''		'''curl -X GET -H "Content-Type: application/json" -H "authorization: <api_key>" "<nowiki>https://api.thedog.io/dictionary?Display_Name[$in][]=A&Display_Name[$in][]=I,B&Display_Name[$in][]=R</nowiki>"'''
	or		or
	'''curl -X GET -H "Content-Type: application/json" -H "authorization: <api_key>" "https://api.thedog.io/dictionary?Display_Name%5B%24in%5D%5B%5D=A&Display_Name%5B%24in%5D%5B%5D=I,B&Display_Name%5B%24in%5D%5B%5D=R"'''		'''curl -X GET -H "Content-Type: application/json" -H "authorization: <api_key>" "<nowiki>https://api.thedog.io/dictionary?Display_Name%5B%24in%5D%5B%5D=A&Display_Name%5B%24in%5D%5B%5D=I,B&Display_Name%5B%24in%5D%5B%5D=R</nowiki>"'''

	You can also use greater than, greater than or equal to, less than, etc		You can also use greater than, greater than or equal to, less than, etc
Line 43:		Line 43:
	etc		etc

	'''curl -X GET -H "Content-Type: application/json" -H "authorization: <api_key>" "https://api.thedog.io/dictionary?Dictionary_no[$lt]=43"'''		'''curl -X GET -H "Content-Type: application/json" -H "authorization: <api_key>" "<nowiki>https://api.thedog.io/dictionary?Dictionary_no[$lt]=43</nowiki>"'''
	or		or
	'''curl -X GET -H "Content-Type: application/json" -H "authorization: <api_key>" "https://api.thedog.io/dictionary?Dictionary_no%5B%24lt%5D=43"'''		'''curl -X GET -H "Content-Type: application/json" -H "authorization: <api_key>" "<nowiki>https://api.thedog.io/dictionary?Dictionary_no%5B%24lt%5D=43</nowiki>"'''