search

ror-community / ror-roadmap

Central information about what is happening at ROR and how to contribute feedback
10 stars 2 forks source link

[FEATURE] Supply related classifications in the data dump and as an API endpoint #209

Open CopyCat73 opened 9 months ago

CopyCat73 commented 9 months ago

I am loading ROR organizations in Pure (CRIS system), and need to create the relevant classification schemes in Pure, e.g. the organization type, country code/name, relationship types, external id types. I need to have them present in Pure before I can load the organizations.

Describe the solution you'd like A separate list of classifications in the datadump, e.g. :

[ classifications [{"type": [ ...], organizations: [{ "id": "https://ror.org/01sf06y89", "name": "Macquarie University", "types": [ "Education"

Plus endpoints in the api to query classifications; http://api.ror.org/v1/classifications/types, http://api.ror.org/v1/classifications/relationship-types

This would benefit IT minded people who want to adopt ROR in CRIS systems for instance.

amandafrench commented 9 months ago

@CopyCat73 Thanks for this! Just to clarify, what would you expect to be returned by an endpoint like http://api.ror.org/v1/classifications/types ? Would it be the list of allowable types in ROR records (Education, Healthcare, Company etc.)?

CopyCat73 commented 9 months ago

Yes, and also list of relation types (related, child, parent), types of id, link types. Basically everything that's a type :)

amandafrench commented 9 months ago

Got it! Makes sense. We'll discuss internally.

amandafrench commented 9 months ago

@CopyCat73 Can you tell us more about what you mean by "a separate list of classifications in the data dump"? Would it be sufficient for your needs if we included a separate schema file with every data dump?

I'm sure you've seen all the documentation at https://ror.readme.io/docs/ror-data-structure : that has the lists of organization types, relationship types, and external id types. It doesn't list all the country codes, but of course anything in the ISO standard is valid.