/* All CSS here will be loaded for users of the Timeless skin */
.mw-wiki-logo.timeless-logo img {
display: none !important;
}
#mw-related-navigation {
display: none !important;
}
#p-navigation{
display: none !important;
}
#mw-site-navigation #site-tools {
display: none !important;
}

MediaWiki:Timeless.css

2025-07-22T15:20:42Z

Dave:

MediaWiki:Timeless.css

2025-07-22T15:19:48Z

Dave:

2025-01-13T21:18:07Z

Dave:

mygeodata.cloud home page

API Photos

2024-10-31T21:17:25Z

Dave:

Each data object returned from the [[API_Data|Data]] endpoint will contain a comma separated list as the value for the key "Photos". These are the ids of the photos.

You can download a photo from a dictionary using the following example:

'''curl -X GET -H "Content-Type: application/json" -H "authorization: <api_key>" "<nowiki>https://api.thedog.io/photo/{Dictionary_no}/{Photo_no}</nowiki>" -o photo.jpg'''

The response will be the file '''photo.jpg'''

API Photos

2024-10-31T21:17:17Z

Dave:

API Photos

2023-12-22T16:48:08Z

Dave: Created page with "Each data object returned from the Data endpoint will contain a comma separated list as the value for the key "Photos". These are the ids of the photos. You can download a photo from a dictionary using the following example: '''curl -X GET -H "Content-Type: application/json" -H "authorization: <api_key>" "<nowiki>https://api.thedog.io/photo/{Dictionary_no}/{Photo_no}</nowiki>" -o photo.jpg''' The response will be the file '''photo.jpg'''"

API Data

2023-12-22T16:42:43Z

Dave:

Once you have the Dictionary_no you wish to pull the data from (Use the [[API_Dictionary|Dictionary]] endpoint to find the Dictionary_no) you can use the following format to pull the data.

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

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

{
"message": "Successful",
"skip": 0,
"limit": 10,
"total": 15,
"data": []
}

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

API Data

2023-12-22T16:42:06Z

Dave: Created page with "Once you have the Dictionary_no you wish to pull the data from (Use the Dictionary endpoint to find the Dictionary_no ) you can use the following format to pull the data. '''curl -X GET -H "Content-Type: application/json" -H "authorization: <api_key>" "<nowiki>https://api.thedog.io/data/{Dictionary_no}</nowiki>"''' Each response from the API will be in the following JSON format: { "message": "Successful", "skip": 0, "limit": 10,..."

Once you have the Dictionary_no you wish to pull the data from (Use the [[API_Dictionary|Dictionary]] endpoint to find the Dictionary_no ) you can use the following format to pull the data.

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

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

{
"message": "Successful",
"skip": 0,
"limit": 10,
"total": 15,
"data": []
}

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

API Responses

2023-12-22T16:37:16Z

Dave: /* Microsoft Azure */

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

or

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

==== 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>" "<nowiki>https://api.thedog.io/dictionary?$sort[CreatedOn]=asc</nowiki>"'''

or

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

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

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

Dictionary_no[$gte]=55
Dictionary_no[$lt]=43
Dictionary_no[$eq]=55
Dictionary_no[$ne]=55
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>"'''
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>"'''

==== Search ====

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

$or[Display_Name][$search]=5L37
$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>"'''
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>"'''

==== Microsoft Azure ====

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:

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

API Responses

2023-12-22T16:36:24Z

Dave:

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

or

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

==== 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>" "<nowiki>https://api.thedog.io/dictionary?$sort[CreatedOn]=asc</nowiki>"'''

or

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

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

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

Dictionary_no[$gte]=55
Dictionary_no[$lt]=43
Dictionary_no[$eq]=55
Dictionary_no[$ne]=55
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>"'''
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>"'''

==== Search ====

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

$or[Display_Name][$search]=5L37
$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>"'''
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>"'''

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

2023-12-22T16:29:08Z

Dave:

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

or

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

==== 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>" "<nowiki>https://api.thedog.io/dictionary?$sort[CreatedOn]=asc</nowiki>"'''

or

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

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

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>" "<nowiki>https://api.thedog.io/dictionary?Dictionary_no[$lt]=43</nowiki>"'''
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>"'''

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

API Dictionary

2023-12-22T16:22:39Z

Dave:

API Authentication

2023-12-22T16:22:10Z

Dave:

In order to use the API you will need to generate an API Key from within the Admin Portal. Once logged into the Admin portal use the side menu to open the "My Profile" page.

[[File:API Menu.png|thumb|center]]

Near the bottom of the page you will find a section where you can generate an API Key. Click on the "Generate API Key" button to generate a new API Key.

[[File:Generate API KEY.png|thumb|center]]

Once you have generated an API Key it will show up in the list. You will also be able to delete the key.

[[File:Generated API Key.png|thumb|center]]

When using any of the API endpoints you will be required to pass a valid API Key as a header in the following format:

'''authorization: CgHxb18BvJu4IMSnGDrNXsfWHJISjT227JJFB2gwVDrCrKc7koY3wARyK4BiBvR7'''

For Example:

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

API Responses

2023-12-22T16:21:57Z

Dave:

API Responses

2023-12-22T16:21:08Z

Dave:

API Responses

2023-12-22T16:19:49Z

Dave: Created page with "==== 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 "aut..."

2023-12-22T16:15:27Z

Dave:

API Dictionary

2023-12-22T16:10:59Z

Dave: