Skip to content
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.

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

Extend the REST API to support query of Categorisation by TargetCategory #14

Closed
sosna opened this issue Aug 29, 2014 · 1 comment
Closed
Milestone

Comments

@sosna
Copy link
Member

@sosna sosna commented Aug 29, 2014

Currently SOAP supports Categorisation query parameters on the Categorisation TargetCategory via the CategorisationWhere type but REST does not. This feature would allow a REST API consumer to benefit from the power of the Categorisation in SDMX. Many times the CategoryScheme is used as a base discovery structure and from a chosen member category the navigation will branch to a search. In REST this is not possible. This is a major limitation, as it impacts the clients willing to browse data, using a category scheme.

A path parameter could be added to the metadata queries of the RESTful API. This parameter would accept the id of the item, in an item scheme, to be returned.

For example, currently, the following syntax can be used to retrieve a category scheme:

https://ws-entry-point/categoryscheme/AGENCY_ID/SCHEME_ID/VERSION

In order to retrieve only a particular category (e.g.: ID = XYZ), the following syntax could be used:

https://ws-entry-point/categoryscheme/AGENCY_ID/SCHEME_ID/VERSION/XYZ

Nested ids should be supported:

https://ws-entry-point/categoryscheme/AGENCY_ID/SCHEME_ID/VERSION/XYZ.A.B

When the references parameter is not used, the returned item scheme should only contain the matching item (including the parents in case a nested id is used). The isPartial attribute should be used and its value should be true.

When the references parameter is used, artefacts using/used by the matching item should be returned.

For example, the following would retrieve, along with the matching categoryscheme/category, all the categorisations categorising the matching category:

https://ws-entry-point/categoryscheme/AGENCY_ID/SCHEME_ID/VERSION/XYZ?references=categorisation

As another example, the following would allow to retrieve all the DSDs referencing the supplied concept:
https://ws-entry-point/conceptscheme/SDMX/CROSS_DOMAIN_CONCEPTS/1.0/FREQ?references=datastructure

@sosna
Copy link
Member Author

@sosna sosna commented Aug 29, 2014

Solution should apply to all item schemes but not to hierarchical codelists.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

1 participant
You can’t perform that action at this time.