Skip to content

API Doumentation Update #14

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

API Doumentation Update #14

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
95f49b1
Update README.md
p-schaefer Apr 22, 2025
2371c98
Update README.md
p-schaefer Apr 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ OData accepts certain query parameters. The ones supported by this API are:
- RegionId Values (these values are subject to change):
- Partner Hubs: `hub.{atlantic,greatlakes,lakewinnipeg,mackenzie,pacific}`
- Countries: `admin.2.{ca}`
- Provinces/Territories/States: `admin.4.ca.{ab,bc,mb,nb,nl,ns,nt,nu.on,pe,,qc,sk,yt}`
- Provinces/Territories/States: `admin.4.ca.{ab,bc,mb,nb,nl,ns,nt,nu,on,pe,qc,sk,yt}`
- Bounding box `$filter=LongitudeNormalized gt '-102.01' and LongitudeNormalized lt '-88.99' and LatitudeNormalized gt '49' and LatitudeNormalized lt '60'`
<!-- - Functions: `$filter=contains(DOI, 'xxxx')`, `$filter=startwith(DOI, 'xxxx')`, `$filter=endswith(DOI, 'xxxx-xxxx')` -->
- **$top**
Expand All @@ -98,6 +98,7 @@ OData accepts certain query parameters. The ones supported by this API are:
- Return only the count for the request. When the value is large enough it becomes an estimate (~0.0005% accurate)
- Example: `$count=true`
- Default: `false`
- *Note: Unlike raw data retrieval, `$count=true` is not paginated and will not automatically iterate over locations. This can result in 408 or 413 error codes for large queries. Lowering `$top` will not resolve these errors. Instead, add narrower filters (e.g., LocationId, CharacteristicName, ActivityStartYear)*
<!--
- **$orderby**
- Fields to order by are entered comma delimited.
Expand Down