API Dictionary - Revision history

Dave at 16:22, 22 December 2023

2023-12-22T16:22:39Z

← Older revision		Revision as of 16:22, 22 December 2023
Line 1:		Line 1:
	This endpoint is used to list of all the dictionaries tied to your account along with their unique "Dictionary_no", which you will need as the {id} for using the [[API_Data\|Data]] endpoint.		This endpoint is used to list of all the dictionaries tied to your account along with their unique "Dictionary_no", which you will need as the {id} for using the [[API_Data\|Data]] endpoint.

	'''curl -X GET -H "Content-Type: application/json" -H "authorization: <api_key>" "https://api.thedog.io/dictionary"'''		'''curl -X GET -H "Content-Type: application/json" -H "authorization: <api_key>" "<nowiki>https://api.thedog.io/dictionary</nowiki>"'''

	Each response from the API will be in the following JSON format:		Each response from the API will be in the following JSON format:

Dave at 16:19, 22 December 2023

2023-12-22T16:19:37Z

← Older revision		Revision as of 16:19, 22 December 2023
Line 14:		Line 14:

	"message" will either be "Successful" or an error message. "skip" is how many records into the query we skipped, "limit" is how many objects we returned. "total" is the total amount of objects that are available. And "data" is an array of objects containing the results.		"message" will either be "Successful" or an error message. "skip" is how many records into the query we skipped, "limit" is how many objects we returned. "total" is the total amount of objects that are available. And "data" is an array of objects containing the results.

	~~==== Pagination ====~~

	By default, the results will be paginated in pages of 10 results. To change the amount of results per page (the limit) or the amount of records to skip (the skip) you would add additional URL parameters, beginning with a $ (or %24 when URL encoded)

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

	or

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

	~~This will grab two records starting on the 7th record.~~

	~~==== Sorting ====~~

	~~You can also sort the records by one of the field names by using the following format:~~

	~~$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"'''~~

	or

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

	~~You can either use "asc" or "desc" for the direction of the sort.~~

	~~==== Filtering Results ====~~

	~~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~~

	~~'''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"'''~~
	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"'''

	~~You can also use greater than, greater than or equal to, less than, etc~~

	~~Dictionary_no[$gte]=55~~
	~~Dictionary_no[$lt]=43~~
	~~Dictionary_no[$eq]=55~~
	~~Dictionary_no[$ne]=55~~
	~~etc~~

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

Dave at 16:16, 22 December 2023

2023-12-22T16:16:16Z

← Older revision		Revision as of 16:16, 22 December 2023
Line 45:		Line 45:
	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

	'''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>" "https://api.thedog.io/dictionary?Display_Name[$in][]=A&Display_Name[$in][]=I,B&Display_Name[$in][]=R"'''

Dave at 16:15, 22 December 2023

2023-12-22T16:15:27Z

← Older revision		Revision as of 16:15, 22 December 2023
Line 40:		Line 40:

	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.

			==== Filtering Results ====

			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

			'''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"'''
			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"'''

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

			Dictionary_no[$gte]=55
			Dictionary_no[$lt]=43
			Dictionary_no[$eq]=55
			Dictionary_no[$ne]=55
			etc

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

Dave at 16:10, 22 December 2023

2023-12-22T16:10:59Z

← Older revision		Revision as of 16:10, 22 December 2023
Line 14:		Line 14:

	"message" will either be "Successful" or an error message. "skip" is how many records into the query we skipped, "limit" is how many objects we returned. "total" is the total amount of objects that are available. And "data" is an array of objects containing the results.		"message" will either be "Successful" or an error message. "skip" is how many records into the query we skipped, "limit" is how many objects we returned. "total" is the total amount of objects that are available. And "data" is an array of objects containing the results.


	==== Pagination ====		==== Pagination ====

Dave at 16:10, 22 December 2023

2023-12-22T16:10:48Z

← Older revision		Revision as of 16:10, 22 December 2023
Line 14:		Line 14:

	"message" will either be "Successful" or an error message. "skip" is how many records into the query we skipped, "limit" is how many objects we returned. "total" is the total amount of objects that are available. And "data" is an array of objects containing the results.		"message" will either be "Successful" or an error message. "skip" is how many records into the query we skipped, "limit" is how many objects we returned. "total" is the total amount of objects that are available. And "data" is an array of objects containing the results.


	==== Pagination ====		==== Pagination ====
Line 26:		Line 27:

	This will grab two records starting on the 7th record.		This will grab two records starting on the 7th record.

			==== Sorting ====

	You can also sort the records by one of the field names by using the following format:		You can also sort the records by one of the field names by using the following format:
Line 38:		Line 41:

	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.

	~~Once you have the Dictionary_no you want to pull the data from you can use the [[API_Data\|Data]] endpoint to pull the data~~

Dave at 16:09, 22 December 2023

2023-12-22T16:09:56Z

← Older revision		Revision as of 16:09, 22 December 2023
Line 14:		Line 14:

	"message" will either be "Successful" or an error message. "skip" is how many records into the query we skipped, "limit" is how many objects we returned. "total" is the total amount of objects that are available. And "data" is an array of objects containing the results.		"message" will either be "Successful" or an error message. "skip" is how many records into the query we skipped, "limit" is how many objects we returned. "total" is the total amount of objects that are available. And "data" is an array of objects containing the results.

			==== Pagination ====

	By default, the results will be paginated in pages of 10 results. To change the amount of results per page (the limit) or the amount of records to skip (the skip) you would add additional URL parameters, beginning with a $ (or %24 when URL encoded)		By default, the results will be paginated in pages of 10 results. To change the amount of results per page (the limit) or the amount of records to skip (the skip) you would add additional URL parameters, beginning with a $ (or %24 when URL encoded)

Dave at 16:09, 22 December 2023

2023-12-22T16:09:19Z

← Older revision		Revision as of 16:09, 22 December 2023
Line 1:		Line 1:
	This endpoint is used to list of all the dictionaries tied to your account along with their unique "Dictionary_no", which you will need as the {id} for using the Data endpoint.		This endpoint is used to list of all the dictionaries tied to your account along with their unique "Dictionary_no", which you will need as the {id} for using the [[API_Data\|Data]] endpoint.

	'''curl -X GET -H "Content-Type: application/json" -H "authorization: <api_key>" "https://api.thedog.io/dictionary"'''		'''curl -X GET -H "Content-Type: application/json" -H "authorization: <api_key>" "https://api.thedog.io/dictionary"'''
Line 37:		Line 37:
	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.

	Once you have the Dictionary_no you want to pull the data from you can use the Data endpoint to pull the data		Once you have the Dictionary_no you want to pull the data from you can use the [[API_Data\|Data]] endpoint to pull the data

Dave at 16:06, 22 December 2023

2023-12-22T16:06:42Z

← Older revision		Revision as of 16:06, 22 December 2023
Line 17:		Line 17:
	By default, the results will be paginated in pages of 10 results. To change the amount of results per page (the limit) or the amount of records to skip (the skip) you would add additional URL parameters, beginning with a $ (or %24 when URL encoded)		By default, the results will be paginated in pages of 10 results. To change the amount of results per page (the limit) or the amount of records to skip (the skip) you would add additional URL parameters, beginning with a $ (or %24 when URL encoded)

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

	or~~<br>~~		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>" "https://api.thedog.io/dictionary?%24limit=2&%24skip=6"'''
Line 29:		Line 29:
	$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"'''~~<br>~~		'''curl -X GET -H "Content-Type: application/json" -H "authorization: <api_key>" "https://api.thedog.io/dictionary?$sort[CreatedOn]=asc"'''

	or~~<br>~~		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>" "https://api.thedog.io/dictionary?%24sort%5BCreatedOn%5D=asc"'''

Dave at 16:06, 22 December 2023

2023-12-22T16:06:23Z

← Older revision		Revision as of 16:06, 22 December 2023
Line 17:		Line 17:
	By default, the results will be paginated in pages of 10 results. To change the amount of results per page (the limit) or the amount of records to skip (the skip) you would add additional URL parameters, beginning with a $ (or %24 when URL encoded)		By default, the results will be paginated in pages of 10 results. To change the amount of results per page (the limit) or the amount of records to skip (the skip) you would add additional URL parameters, beginning with a $ (or %24 when URL encoded)

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

	or<br>		or<br>

	'''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>" "https://api.thedog.io/dictionary?%24limit=2&%24skip=6"'''

	This will grab two records starting on the 7th record.		This will grab two records starting on the 7th record.
Line 29:		Line 29:
	$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"'''<br>		'''curl -X GET -H "Content-Type: application/json" -H "authorization: <api_key>" "https://api.thedog.io/dictionary?$sort[CreatedOn]=asc"'''<br>

	or<br>		or<br>

	'''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>" "https://api.thedog.io/dictionary?%24sort%5BCreatedOn%5D=asc"'''

	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.

	Once you have the Dictionary_no you want to pull the data from you can use the Data endpoint to pull the data		Once you have the Dictionary_no you want to pull the data from you can use the Data endpoint to pull the data