On 1 Dec 2022, ROR plans to release changes to the API, UI and data dump in order to support cases where an organization has ceased to operate, merged with another organization, was added to ROR in error.
These changes were developed in consultation with the ROR community; a draft proposal was open for public comment 15 Jun-15 Jul 2022 and a "final" proposal was shared in Aug 2022. The specifications for these changes were based on the final proposal.
These changes are non-breaking and are compatible with the current ROR schema, but we're making them available in development environments prior to production release to ensure that integrators have an opportunity to test and adapt their applications as needed.
New values allowed in status field:
- inactive: Organization no longer operates as described in its ROR record. For example, it has split into multiple organizations, merged with 1 or more organizations or has otherwise ceased to operate.
- withdrawn: Organization whose ROR record was created in error. For example, the organization already existed in ROR under a different name or the organization is not in scope for ROR and should not have been added.
New values allowed in relationships.type field:
- Successor: An active organization that continues the work of a given organization after it has become inactive
- Predecessor: An inactive organization that previously carried out the work of a given organization
Note: Unlike Parent/Child relationships in ROR, Successor/Predecessor relationships are not always added in pairs. In other works, each Successor relationship does not necessarily have a corresponding Predecessor relationship.
See ROR data structure for more information about status and relationships.
- Returns active records only by default; use parameter
?all_statusto return all records. ?
?all_status=falseare also supported. This is true for listing organizations using
/organizations, querying using either
?query.advancedand matching affiliation strings using
- When retrieving a record by its ROR ID, the record will be returned regardless of its status and whether
?filterparameters are present.
- New filter parameter value
statusis available, ex
?all_statusparameter is ignored.
- New status and relationship type values are available in fielded searches using query.advanced, ex
?query.advanced=status:inactive. If a fielded search includes status field,
?all_statusparameter is ignored.
- New aggregation
statusesin meta section of responses
- Data dump file includes all records with all statuses. No changes, except that records may contain new values in status and relationships.type fields.
- Returns active records only by default
- Results can be filtered by status (note: work on status filter is still in progress)
We have deployed several records with the new statuses and relationship types to our development environment and created a sample data dump with the same records. Access these resources at:
- API : https://api.dev.ror.org
- Data dump : org-status-beta-test-2022-10-14-ror-data.zip. Also available in the Zenodo sandbox environment https://sandbox.zenodo.org/record/1123387 (note that Zenodo sandbox DOIs do not resolve)
- Search UI : https://dev.ror.org/search (note: work on status filter is still in progress)
Records with inactive/withdrawn statuses are:
- https://ror.org/03y81da23 (inactive)
- https://ror.org/01br3aa17 (inactive)
- https://ror.org/05s7dz794 (inactive)
- https://ror.org/02zbz4g27 (withdrawn)
- https://ror.org/03ybx0x41 (withdrawn)
- Records in the dev environment use the production domain "ror.org" in their id field, but they are retrieved in the web search interface using the dev domain "dev.ror.org".
- The dev environment is actively used for development purposes, so you may see changes deployed here during the beta testing period (particularly in the web search interface). We would typically use the staging environment for beta testing, but, staging is tightly integrated into ROR's curation workflow, so using it for testing changes would block curation activities.
- To report any issues you find in testing, please add comments to the request for feedback on the ROR Community Roadmap GitHub Discussion forum.
- Note that the metadata approach for handling organization status changes and successors/predecessors have already been through several rounds of community feedback. At this point, we are primarily interested in feedback on the technical implementation, especially any bug/issues.
Note: Request above returns same results as
Can be repeated, for example to retrieve organizations with a status of inactive OR withdrawn
Can be combined with other filters (see list of available filters and values)
Can be combined with ?query or ?query.advanced searches.
Note: Filters cannot be used with ?affiliation searches.
Note: if a fielded search includes status field, ?all_status is not needed in order to return records with statuses other than active.
Updated 5 days ago