API Responses: Difference between revisions
From Golden Retriever Wiki
No edit summary |
No edit summary |
||
| 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>"''' | ||
Revision as of 16:21, 22 December 2023
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"
