Skip to content

doc(API): wrong endpoint #3

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
s-en-o wants to merge 1 commit into
base: master
Choose a base branch
from
Open

doc(API): wrong endpoint #3

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@ The prefix for web resource endpoints is `https://catalogue.data.govt.nz/api/act

|Resource Functions | Description |
|---|---|
|`/package_metadata_show?id={package id}`|Gets the metadata of a dataset and all of its data resources. All of the data resources' download link, last updated date, etc. can be retrieved here.|
|`/resource_metadata_show?id={resource id}`|Gets the metadata of a specific data resource. This function is a subset of `package_metadata_show` as it would have listed all of its data resources. The data resource download link, last updated date, etc. can be retrieved here.|
|`/package_show?id={package id}`|Gets the metadata of a dataset and all of its data resources. All of the data resources' download link, last updated date, etc. can be retrieved here.|
|`/resource_show?id={resource id}`|Gets the metadata of a specific data resource. This function is a subset of `package_metadata_show` as it would have listed all of its data resources. The data resource download link, last updated date, etc. can be retrieved here.|

[CKAN provides full API documentation](http://docs.ckan.org/en/latest/api/index.html) with further endpoints and actions that can be called.

Expand All @@ -29,7 +29,7 @@ Code examples to get started are provided below (feel free to suggest further co

- Identify the appropriate web resource method to use: package_metadata_show
- Identify the dataset you want and retrieve it's ID, for instance: new-zealand-public-sector-websites
- Create POST HTTP call to: `https://catalogue.data.govt.nz/api/action/package_metadata_show?id=new-zealand-public-sector-websites`.
- Create POST HTTP call to: `https://catalogue.data.govt.nz/api/action/package_show?id=new-zealand-public-sector-websites`.
- You will receive a JSON response containing the metadata for this dataset. After parsing the JSON response into an object, check if the request was successful by ensuring that the `response-json-object.success` value evaluates to true before proceeding.

The following example shows how you can use Python to retrieve dataset information from the site:
Expand Down