Skip to content

APIs_for_SystemAdministrators.md

Latest commit

 

History

History
81 lines (41 loc) · 2.21 KB

APIs_for_SystemAdministrators.md

File metadata and controls

81 lines (41 loc) · 2.21 KB
Raw

Project Venimus - APIs For System Administrators

The following APIs can only be called by sysadmin administrators.

POST /api/Groups

Creates a new group. The body of the request must include the following information.

  • Slug - The unique external ID for the group. _For example YorkCodeDojo

  • IsActive - Is the community currently active.

  • Name - The unique name for the group / community. For example York Code Dojo

  • Description - A description of the group in markdown

  • SlackChannelName - The name of this groups slack channel

  • LogoInBase64 - The group's logo.

Business Rules

  • The slug is required, cannot contain spaces, must be unique and no more than 100 characters.

  • The name is required, must be unique and no more than 100 characters.

  • The description is required, and should be in markdown format

  • The user must be a member of the sysadmin administrators role.

PUT /api/Groups/{slug}

Updates an existing group with the matching slug. The body of the request must include the following information.

  • Slug - The unique external ID for the group. _For example YorkCodeDojo

  • IsActive - Is the community currently active.

  • Name - The unique name for the group / community. For example York Code Dojo

  • Description - A description of the group in markdown

  • SlackChannelName - The name of this groups slack channel

  • LogoInBase64 - The group's logo.

Business Rules

  • The slug is required, cannot contain spaces, must be unique and no more than 100 characters.

  • The name is required, must be unique and no more than 100 characters.

  • The description is required, and should be in markdown format

  • The group must exist

  • The user must be a member of the sysadmin administrators role.

  • If the Slug or Name changes then the events must also be updated

DELETE /api/Groups/{groupslug}

Allows a group to be deleted if it has no events.

Business Rules

  • The user must have the System Administrator role

  • The group can not have any events

  • If the group is successfully deleted then 204 is returned.

  • If the group does not exist then 204 is returned.