Hermes Latest Version (v1)

Authentication
- List Methods
- Expand Methods
- POSTLogin/login
  Log in to EC. This call should ALWAYS be issued over HTTPS. A HTTP cookie will be present in the response headers, which can be captured and used to authenticate subsequent requests. The cookie will be named 'unity.jwt'
  
  Description
  Location
  Type
  Value
  Parameter
Students: CRUD
- List Methods
- Expand Methods
- GETFetch students/students
  Returns an array of active students
  
  Description
  Location
  Type
  Value
  Parameter
- POSTAdd student/students
  Adds a new student to the database
  
  Description
  Location
  Type
  Value
  Parameter
- PUTUpdate student/students/{student}
  Updates an existing student in the database.
  
  Description
  Location
  Type
  Value
  Parameter
- DELETEDelete student/students/{id}
  Marks a student as deleted in the database. The student's data is not actually deleted, but they will be treated as such by EC.
  
  Description
  Location
  Type
  Value
  Parameter
Students: Other
- List Methods
- Expand Methods
- PUTDisable a student/students/{id}/disable
  Turns off a student account. The student will not be able to log in to EC. The student will still be able to access books on their device that were already unlocked.
  
  Description
  Location
  Type
  Value
  Parameter
- PUTEnable a student/students/{id}/enable
  Turns on a student account, if it was disabled. The student will be able to log in to EC, and receive content.
  
  Description
  Location
  Type
  Value
  Parameter
- PUTSuspend a student/students/{id}/suspend
  Suspend a student account. Suspended students cannot receive content added after the moment they were suspended.
  
  Description
  Location
  Type
  Value
  Parameter
- PUTUnsuspend a student/students/{id}/unsuspend
  Unsuspend a student account.
  
  Description
  Location
  Type
  Value
  Parameter
- PUTRestrict a student/students/{id}/restrict
  Restrict a student account.
  
  Description
  Location
  Type
  Value
  Parameter
- PUTUnrestrict a student/students/{id}/unrestrict
  Unrestrict a student account.
  
  Description
  Location
  Type
  Value
  Parameter
Teachers: CRUD
- List Methods
- Expand Methods
- GETFetch teachers/teachers
  Returns an array of active teachers
  
  Description
  Location
  Type
  Value
  Parameter
- POSTAdd teacher/teachers
  Adds a new teacher to the database
  
  Description
  Location
  Type
  Value
  Parameter
- PUTUpdate teacher/teachers/{teacher}
  Updates an existing teacher in the database.
  
  Description
  Location
  Type
  Value
  Parameter
- DELETEDelete teacher/teachers/{id}
  Marks a teacher as deleted in the database. The teacher's data is not actually deleted, but they will be treated as such by EC.
  
  Description
  Location
  Type
  Value
  Parameter
Teachers: Other
- List Methods
- Expand Methods
- PUTDisable a teacher/teachers/{id}/disable
  Turns off a teacher account. The teacher will not be able to log in to EC. The teacher will still be able to access books on their device that were already unlocked.
  
  Description
  Location
  Type
  Value
  Parameter
- PUTEnable a teacher/teachers/{id}/enable
  Turns on a teacher account, if it was disabled. The teacher will be able to log in to EC, and receive content.
  
  Description
  Location
  Type
  Value
  Parameter
- GETGet teacher groups/teachers/{id}/groups
  Returns an array of {code,name} pairs corresponding to the groups linked to this teacher. This array includes custom groups.
  
  Description
  Location
  Type
  Value
  Parameter
Groups: CRUD
- List Methods
- Expand Methods
- GETFetch groups/groups
  Returns an array of public groups in the database
  
  Description
  Location
  Type
  Value
  Parameter
- POSTAdd group/groups
  Adds a new group to the database
  
  Description
  Location
  Type
  Value
  Parameter
- PUTUpdate group/groups/{code}
  Updates an existing group in the database.
  
  Description
  Location
  Type
  Value
  Parameter
- DELETEDelete group/groups/{code}
  Marks a group as deleted in the database. The group is not actually deleted, but will be treated as such by EC.
  
  Description
  Location
  Type
  Value
  Parameter
Groups: Other
- List Methods
- Expand Methods
- GETGet list of students in a group/groups/{code}/students
  Gets a list of students assigned to a group.
  
  Description
  Location
  Type
  Value
  Parameter
- PUTAdd student to group/groups/{code}/students/{id}
  Links a single student to a group.
  
  Description
  Location
  Type
  Value
  Parameter
- DELETERemove student from group/group/{code}/students/{id}
  Removes a single student from a group.
  
  Description
  Location
  Type
  Value
  Parameter
- PUTAdd teacher to group/groups/{code}/teachers/{id}
  Links a single teacher to a group.
  
  Description
  Location
  Type
  Value
  Parameter
- DELETERemove student from group/groups/{code}/teachers/{id}
  Removes a single student from a group.
  
  Description
  Location
  Type
  Value
  Parameter
- PUTAdd book to group/groups/{code}/books/{id}
  Links a single book to a group.
  
  Description
  Location
  Type
  Value
  Parameter
- DELETERemove book from group/groups/{code}/books/{id}
  Removes a single book from a group.
  
  Description
  Location
  Type
  Value
  Parameter
- POSTAdd multiple students to a group/groups/bulk/add/students
  Links one or more students to a group.
  
  Description
  Location
  Type
  Value
  Parameter
- POSTRemove multiple students from a group/groups/bulk/remove/students
  Unlinks one or more students from a group.
  
  Description
  Location
  Type
  Value
  Parameter
- POSTAdd multiple teachers to a group/groups/bulk/add/teachers
  Links one or more teachers to a group.
  
  Description
  Location
  Type
  Value
  Parameter
- POSTRemove multiple teachers from a group/groups/bulk/remove/teachers
  Unlinks one or more teachers from a group.
  
  Description
  Location
  Type
  Value
  Parameter
- POSTAdd multiple books to a group/groups/bulk/add/books
  Links one or more books to a group.
  
  Description
  Location
  Type
  Value
  Parameter
- POSTRemove multiple books from a group/groups/bulk/remove/books
  Unlinks one or more books from a group.
  
  Description
  Location
  Type
  Value
  Parameter
Books: CRUD
- List Methods
- Expand Methods
- GETFetch books/books
  Returns an array of books in the database
  
  Description
  Location
  Type
  Value
  Parameter