open-education-api/specification

[Change request]: consider adding two organizations paths

Opened this issue · 1 comments

Organization

SURF

Project

No response

Contact Details

No response

Short description

There are several paths in OOAPI v5 that you can use to request entities that are somehow related to an Organization. Such as:

  • GET /organizations/{organizationId}
  • GET /organizations/{organizationId}/programs
  • GET /organizations/{organizationId}/courses
  • GET /organizations/{organizationId}/components
  • GET /organizations/{organizationId}/offerings
    etc.

However, Organizations can also have a relation to Person and other Organizations. Should we add:

  • GET /organizations/{organizationId}/persons
  • GET /organizations/{organizationId}/organizations

Version

v5

Usecase

This would allow a client to request the persons that are part of an organization and/or request organizational units that are nested under a certain organization.

Which institutions support this change?

No response

Proposed solution

Add calls for:

  • GET /organizations/{organizationId}/persons
  • GET /organizations/{organizationId}/organizations

Requests and responses

No response

What is your question for the OOAPI work group?

No response

It seems that /organizations/{organizationId}/organizations is logical to add. We should discuss this and also whether adding /organizations/{organizationId}/persons is a sensible idea or whether another mechanism is needed for relating persons to organizations.