CodeHub — api

Events

Get Events Create Event Get Event by ID Update Event Delete Event Get past events Get Tags Create Tag Get Tag Info Update Tag Delete Tag Get Upcoming Events Create User Get User Update user Delete User Get Event by Year & Month Event Approval List Users User Approval

Translations

Retrieve German Translations for Project Retrieve English Translations for Project

Projects

Retrieve Project by ID

Skills

Retrieve Skills

Events

Allows to track / manage / plan events

Retrieve all Events

Needed permission : events:getEvents

Retrieves all existing events.

curl

GET /v1/events

Example Request 
Example missing.
Example Response 
Example missing.

Create Event

Needed permission : events:modifyEvents

Allows to create an Event

Parameters

Name Description
title required The title of the event
description optional The description of the event, can also be used as a location note
date optional Marks the date on which the event occurs. If not set the current date will be used
start optional Marks the time when the event starts. Please use the following format (HH:mm). If not set default value is used (00:00).
duration optional THe duration is divided by 5 which means the value 1 represents a 5 minute duration. Failing to set this value results in event being 5 minutes long
tag optional Allows to categorize events
creator required The creator of this event
approved required Is user is approved or not
curl

POST /v1/events

Example Request 
Example missing.
Example Response 
Example missing.

Retrieves Event by ID

Needed permission : events:getEvents

Retrieves the event data which matches the given ID

curl

GET /v1/events/:id

Example Request 
Example missing.
Example Response 
Example missing.

Update Event

Needed permission : events:modifyEvents

Allows to update the data of an event

Parameters

Name Description
title optional The new name of Event
description optional The new description of Event
date optional The new date of Event
start optional The new start of Event
duration optional The new duration of Event
tag optional The new tag of Event
curl

PUT /v1/events/:id

Example Request 
Example missing.
Example Response 
Example missing.

Delete Event

Needed permission : events:modifyEvents

Allows to completely delete an event

curl

DELETE /v1/events/:id

Example Request 
Example missing.
Example Response 
Example missing.

Retrieve past events

Needed permission : events:getEvents

Retrieve all events that are already in the past

curl

GET /v1/events/past

Example Request 
Example missing.
Example Response 
Example missing.

Retrieve all Tags

Needed permission : events:tags

Retrieves all existing Tags

curl

GET /v1/events/tags

Example Request 
Example missing.
Example Response 
Example missing.

Create a new Tag

Needed permission : events:tags

Allows to create a new Tag

Parameters

Name Description
tag required The name of the tag, must be unique
colorHEX required The hex color value which the tag supposed to have
curl

POST /v1/events/tags

Example Request 
Example missing.
Example Response 
Example missing.

Retrieve Tag Info

Needed permission : events:tags

Retrieves Tag Info by parsing the tag value

curl

GET /v1/events/tags/:tag

Example Request 
Example missing.
Example Response 
Example missing.

Update Tag

Needed permission : events:tags

Allows to update a Tag

Parameters

Name Description
newTag optional The new Tag name
colorHEX optional The new color Hex value
curl

PUT /v1/events/tags/:tag

Example Request 
Example missing.
Example Response 
Example missing.

Delete Tag

Needed permission : events:tags

Allows to delete a Tag completely

curl

DELETE /v1/events/tags/:tag

Example Request 
Example missing.
Example Response 
Example missing.

Retrieve all upcoming Events

Needed permission : events:getEvents

Retrieves all events that are upcoming

curl

GET /v1/events/upcoming

Example Request 
Example missing.
Example Response 
Example missing.

Create a new user

Needed permission : events:modifyUsers

Allows to create a new user

Parameters

Name Description
username required The username
password required The password
email required The Email
curl

POST /v1/events/users

Example Request 
Example missing.
Example Response 
Example missing.

Retrieve User Data

Needed permission : events:getUsers

Retrieve the user data by username

curl

GET /v1/events/users/:username

Example Request 
Example missing.
Example Response 
Example missing.

Update user

Needed permission : events:modifyUsers

Allows to update a users data

Parameters

Name Description
newUsername optional The new username
password optional The new password
email optional The new email
must_change_password optional `1` need to change password, `0` does not need to change 0 by default
password optional The new Password (hashed)
curl

PUT /v1/events/users/:username

Example Request 
Example missing.
Example Response 
Example missing.

Delete User

Needed permission : events:modifyUsers

Allows to delete a user

curl

DELETE /v1/events/users/:username

Example Request 
Example missing.
Example Response 
Example missing.

Retrieve Event by year and month

Needed permission : events:getEvents

Retrieves all Event by year and month

curl

GET /v1/events/:year/:month

Example Request 
Example missing.
Example Response 
Example missing.

Approval of Events

Needed permission : events:modifyEvents

With this Endpoint you are able to approve and deny Events

Parameters

Name Description
value required 1 for appoved and 0 for denied
curl

PUT /v1/events/approval/:id

Example Request 
Example missing.
Example Response 
Example missing.

List all Users

Needed permission : events:getUsers

Retrieves all existing users

curl

GET /v1/events/users

Example Request 
Example missing.
Example Response 
Example missing.

Set Approval of User

Needed permission : events:modifyUsers

This Endpoint allows to change the approval state of a user

Parameters

Name Description
value required `1` for user is approved, `0` for otherwise
curl

PUT /v1/events/users/approval/:username

Example Request 
Example missing.
Example Response 
Example missing.

Translations

List of key value pairs which represent the translated text

Get all German Translations for a Project

Needed permission : portfolio:getTranslations

Returns of all key value pairs that are needed for the given project. Based on the given lang(Language) and pid(Project ID)

curl

GET /v1/translate/de/:pid

Example Request 
Example missing.
Example Response 
Example missing.

Get all English Translations for a Project

Needed permission : portfolio:getTranslations

Returns of all key value pairs that are needed for the given project. Based on the given lang(Language) and pid(Project ID)

curl

GET /v1/translate/en/:pid

Example Request 
Example missing.
Example Response 
Example missing.

Projects

All the data combinations which is used for the portfolio page

Get a Project based on its ID

Needed permission : portfolio:getProject

Returns the corresponding data based on the projectID that was given

curl

GET /v1/projects/:id

Example Request 
Example missing.
Example Response 
Example missing.

Skills

A list of all skills that are used across all of my projects

Get all skills

Needed permission : portfolio:getSkills

Returns all skills that are used across all of my projects

curl

GET /v1/skills

Example Request 
Example missing.
Example Response 
Example missing.