Skip to content

Schedule

SaranratR edited this page Nov 27, 2022 · 6 revisions

Using for Schedule’s module

this path goes under /schedule/

Reference from Google Calendar API https://developers.google.com/calendar/api/v3/reference ACL = access control list

Schedule Homepage

This is the schedule homepage which we call ‘calendar page’

URL

GET /

REQUEST BODY

Parameter Type Description
calendar_id String calendar for every user (each user will each have a calendar id)
event_id String the event that show up for today date (today’s event)
isSelect boolean use to if user click select the date. The default is False.

Example

{
“calendar_id”: “cid1628911”
“event_id”: “ev11288910”
“isSelect”: “False”,
}

Timetable

This page is show event of the one day

URL

GET /

REQUEST BODY

Parameter Type Description
table_id String The timetable of each day
event_id String Events are shown on the selected date
isSelect_date boolean Use to if user click select the date. The default is False
isSelect_event boolean Use to if user click select the event. The default is False
Example

{
“table_id”: “tid1628911”
“event_id”: “ev11288910”
“isSelect_date”: “False”
“isSelect_event”: “False”
}

Add event

user create new event

URL

POST/addnewevent

REQUEST BODY

Parameter Type Description
name String Event’s name
description String Event’ description
starttime DateTime Event start time
endtime DateTime Event end time
completeForm Boolean User has completed the form to add event

Example

{
name: “Shortest path”
description: “Find shortest path”
startTime: “11:00”,
endTime: “23:59”
"completeForm":true
}

Success

Response

Status Code

201 Add event success

Parameter Type Description
name String Event’s name
description String Event’ description
starttime DateTime Event start time
endtime DateTime Event end time
status Object Status of request
code int Http code of request
message int Response of request

Example

{
    “showevent|:[
         {
            “name”: “Tum boon”
            “Description”:”Wan Pra”
            “starttime”:”06:00”
            “endtime”:”07:00”
         }
      ],
{ 
	“status”:{
	    “code”:201,
	    “message”: “Add event success”
   }
}

Fail

Response

Status Code

400 Failed to add event

Parameter Type Description
status object Status of request
code int Http code of request
message String Response message

Example

{
   “status”:{
     “code”:400,
     “message”: “failed to add event”
    }
}

Edit event

user edit event

URL

POST/edit

REQUEST BODY

Parameter Type Description
name String Event’s name
description String Event’ description
starttime DateTime Event start time
endtime DateTime Event end time

Example

{
name: “Shortest path”
description: “Find shortest path”
startTime: “11:00”,
endTime: “23:59”
}

Success

Response

Status Code

201 Edit event success

Parameter Type Description
name String Event’s name
description String Event’ description
starttime DateTime Event start time
endtime DateTime Event end time
status Object Status of request
code int Http code of request
message int Response of request

Example

{
    “showevent|:[
         {
            “name”: “Tum boon”
            “Description”:”Wan Pra”
            “starttime”:”06:00”
            “endtime”:”07:00”
         }
      ],
{ 
	“status”:{
	    “code”:201,
	    “message”: “Edit event success”
   }
}

Fail

Response

Status Code

400 Failed to edit event

Parameter Type Description
status object Status of request
code int Http code of request
message String Response message

Example

{
   “status”:{
     “code”:400,
     “message”: “failed to edit event”
    }
}

Show Event

get event that user create

URL

GET/ showevent

REQUEST BODY

No request body

Success

Response

Status code

200 Show event success

Parameter Type Description
name String event name
description String event description
Starttime DateTime event’s start time
Endtime DateTime event’s end time
status Object Status of request
message String Response message

Example

{
    “showevent|:[
         {
            “name”: “Tum boon”
            “Description”:”Wan Pra”
            “starttime”:”06:00”
            “endtime”:”07:00”
         }
      ],
      “status”:{
      “code”: 200,
      “message”:”Show event success”
      }
}

Fail

Response

Status Code

404 Event not found

Parameter Type Description
status object Status of request
code int Http code of request
message String Response message

Example

{
   “status”:{
     “code”:404,
     “message”: “Event not found.”
    }
}

Delete event

delete the selected event

URL

‘DELETE/ event”

Request Body

Parameter Type Description
isDeleted Boolean Set the value to True

Example { "isDeleted":true }

Success

Response

Status Code

‘200’ delete event success

Parameter Type Description
status Object Status of request
message String Response message

Example { “status”:{ “code”: 200, “message”:”Delete event success” }

Fail

‘404’ selected event not found

Parameter Type Description
status object Status of request
code int Http code of request
message String Response message

Example { “status”:{ “code”:400, “message”: “Selected event not found.” } }

Clone this wiki locally