Skip to content

The backend for the SCCI 24' mobile application, created by MC committe.

Notifications You must be signed in to change notification settings

MahmoudMNael/SCCI-BackEnd

Repository files navigation

SCCI'24 MC Back-End API Documentation

Announcements

POST "/app/24/api/announcements/(announcementType)"

Replace (announcementType) with one of the following: General, Appsplash, Techsolve, Investeneur, Devology or Markative

Request Body

{
	"announcementMessage": "The body of the announcement",
}

Response Body

Successful 200

{
	message:  'Announcement Added!',
}

Failed 500

Check the error message and debug


GET "/app/24/api/announcements/(announcementType)"

Replace (announcementType) with one of the following: General, Appsplash, Techsolve, Investeneur, Devology or Markative

Response Body

Successful 200

{

	"data":  [

				{

					"announcementID":  4,

					"authorName":  "Mahmoud Nael",

					"announcementMessage":  "this is a new announcement",

					"announcementDate":  "11 Feb 2024, 7:39 pm"

				},

				{

					"announcementID":  3,

					"authorName":  "Mahmoud Nael",

					"announcementMessage":  "Wussup\nmy name is mahmoud❤😂🦇",

					"announcementDate":  "11 Feb 2024, 5:57 am"

				},

				{

					"announcementID":  2,

					"authorName":  "Mahmoud Nael",

					"announcementMessage":  "Wussup\nmy name is mahmoud",

					"announcementDate":  "11 Feb 2024, 5:54 am"

				}

			]
}

Failed 500

Check the error message and debug

Failed 404

There is no announcements there


DELETE "/app/24/api/announcements/(announcementID)"

Replace (announcementID) with the id of the desired announcement

Response Body

Successful 200

{
	"message": "announcement deleted!"
}

Failed 500

Check the error message and debug


PUT "/app/24/api/announcements/(announcementID)"

Replace (announcementID) with the id of the desired announcement

Request Body

{
	"announcementMessage": "This is the body of the announcement",
}

Response Body

Successful 200

{
	"message": "announcement updated!"
}

Failed 500

Check the error message and debug


GET "/app/24/api/announcements/one/(announcementID)"

Replace (announcementID) with the id of the desired announcement

Response Body

Successful 200

{

	"data":	{

				"announcementID":  4,
				"authorName":  "Mahmoud Nael",
				"announcementMessage":  "this is a new announcement",
				"announcementDate":  "11 Feb 2024, 7:39 pm"
			},
}

Failed 500

Check the error message and debug

Failed 404

There is no announcements there

Tasks

POST "/app/24/api/tasks/(taskWorkshop)"

Replace (taskWorkshop) with one of the following: Appsplash, Techsolve, Investeneur, Devology or Markative

Request Body

{
	"taskMessage": "The body of the task",
	"taskDeadline": DateObject.toString(),
}

Response Body

Successful 200

{
	message:  'task Added!',
}

Failed 500

Check the error message and debug


GET "/app/24/api/tasks/(taskWorkshop)"

Replace (taskWorkshop) with one of the following: Appsplash, Techsolve, Investeneur, Devology* or *Markative*

Response Body

Successful 200

{

	"data":  [

				{

					"taskID":  4,

					"authorName":  "Mahmoud Nael",

					"taskMessage":  "this is a new announcement",

					"taskDate":  "11 Feb 2024, 7:39 pm",

					"taskDeadline": "11 Feb 2024, 7:39 pm",

				},

			]
}

Failed 500

Check the error message and debug

Failed 404

There is no announcements there


DELETE "/app/24/api/tasks/(taskID)"

Replace (taskID) with the id of the desired task

Response Body

Successful 200

{
	"message": "task deleted!"
}

Failed 500

Check the error message and debug


GET "/app/24/api/tasks/one/(taskID)"

Replace (taskID) with the id of the desired task

Response Body

Successful 200

{

	"data":	{

				"taskID":  4,
				"authorName":  "Mahmoud Nael",
				"taskMessage":  "this is a new announcement",
				"taskDate":  "11 Feb 2024, 7:39 pm",
				"taskDeadline": "11 Feb 2024, 7:39 pm",
			},
}

Failed 500

Check the error message and debug

Failed 404

There is no tasks there

Task Submissions

POST "/app/24/api/tasks/(taskID)/submissions"

Replace (taskID) with id of the desired task

Request Body

{
	"taskMessage": "The link of the submission (Google Drive)",
}

Response Body

Successful 200

{
	"message":  'Submission Added!',
}

Failed 500

Check the error message and debug


GET "/app/24/api/tasks/(taskID)/submissions"

Replace (taskID) with id of the desired task

Response Body

Successful 200

{

	"data":  [

				{

					"submissionID":  4,

					"authorName":  "Mahmoud Nael",

					"submissionMessage":  "this is a new announcement",

					"submissionDate":  "11 Feb 2024, 7:39 pm"

				},

			]
}

Failed 500

Check the error message and debug

Failed 404

There is no announcements there


DELETE "/app/24/api/tasks/(taskID)/(submissionID)"
  • Replace (taskID) with the id of the desired task
  • Replace (submissionID) with the id of the desired submission

Response Body

Successful 200

{
	"message": "submission deleted!"
}

Failed 500

Check the error message and debug


GET "/app/24/api/tasks/(taskID)/submissions/user"
  • Replace (taskID) with the id of the desired task

Response Body

Successful 200

{
	"data": {

					"submissionID":  4,

					"authorName":  "Mahmoud Nael",

					"submissionMessage":  "this is a new announcement",

					"submissionDate":  "11 Feb 2024, 7:39 pm"

				},
}

Failed 500

Check the error message and debug

About

The backend for the SCCI 24' mobile application, created by MC committe.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published