Details
-
Improvement
-
Resolution: Done
-
Major
-
None
-
None
-
None
-
Data Standard Sprint 29, Data Standard Sprint 30
-
1
Description
For any entity that is a Education Organization, there is an unstated implication in the Data Standard and the UDM: the inherited ID cannot be duplicated in another entity. For example, you cannot have the same number as a LocalEducationAgencyId and as a SchoolId.
Can we clarify this in the MetaEd models, using the documentation? This documentation makes it out to the API specification files (Swagger) and will be one of two ways to help anyone building an API application to understand this important point.
For example, we currently have:
Domain Entity School based on EducationOrganization [579] documentation "This entity represents an educational organization that includes staff and students who participate in classes and educational activity groups." integer SchoolId [1614] documentation "The identifier assigned to a school." renames identity property EducationOrganizationId is queryable field min value big
Perhaps we could change the documentation to "The identifier assigned to a school. Cannot duplicate the value used by any other EducationOrganization, such as a LocalEducationAgency".