This is a wiki for the standard API for Groups, Subjects, Permissions
This is a RESTful API which is initially focused on HTTP/JSON.
Standards
- Fields can be marked as
- Mandatory: implementors must implement this field
- Default: when requesting the resource, these fields will be returned. Other fields can be retrieved if they are requested
- Request/response wrapper. Requests and response are wrapper in an object wrapper. Responses have a responseMeta field which has the following fields:
- success: true/false
- serviceRootUrl: is the URL of the service up to the first resource. e.g. if this is where the groups are: https://groups.school.edu/groupsService/standardApi/groups
, then the serviceRootUrl is:
Versioning
The version of the API is an integer which is sent in the URL. If the API is changed in a backwards compatible way (e.g. extra fields which do not change names or structure), then the version number doesn't change. However, there is also a dot version number which includes another integer for the revision number which is changed whenever the API is changed in a backwards compatible way. The server dot version is sent in the response metadata.