API 문서

Group

• 그룹 생성

  그룹 생성

  ---

  그룹을 생성합니다.

  • URL:/api/groups

   

  • Method:Post

   

  • URL Params

  None

  • Data Params

   

  Authorization : Bearer Token

  value	type
  token	String

   

  body

  value	type
  groupname	String
  password	String

   

  • Success Response:Code: 200

  {
  	"groupname":"example",
  	"groupcode":"example"
  }

  • Error Response:Code:

  • Sample Call:

  {
  	"groupname":"example",
  	"password":"example"
  }

   

  ---

   

• 유저의 그룹리스트 조회

  유저의 그룹리스트 조회

  ---

  유저의 그룹리스트를 조회합니다.

  • URL:/api/groups?useremail={useremail}

   

  • Method:Get

   

  • URL Params

    value	type
    useremail	String

  • Data Params

   

  Authorization : Bearer Token

  value	type
  token	String

   

  • Success Response:Code: 200

  {
  	"data":
  		[{
  		"groupname":"example1",
  		"groupcode":"example1"
  		},
  		{
  		"groupname":"example2",
  		"groupcode":"example2"
  		},
  		{
  		"groupname":"example3",
  		"groupcode":"example3"
  		}]
  
  }

  • Error Response:Code:

   

  • Sample Call:

  ---

• 그룹 참여

  그룹 참여

  ---

  그룹에 참여합니다.

  • URL:/api/group?useremail={useremail}

   

  • Method:Post

   

  • URL ParamsNone
  •  

  • Data Params

   

  Authorization : Bearer Token

  value	type
  token	String

  body

  value	type
  groupcode	String
  password	String

  • Success Response:Code: 200

  {
  	"groupname":"example",
  	"groupcode":"example"
  }

  • Error Response:Code:
  •  

  • Sample Call:

    {
    	"groupcode":"example",
    	"password":"example"
    }

  ---

• 그룹의 멤버조회

  그룹의 멤버조회

  ---

  그룹코드를 이용하여 해당 그룹의 멤버를 조회합니다.

  • URL:/api/groups/{groupcode}?useremail={useremail}

   

  • Method:Get

   

  • URL Params

    value	type
    groupcode	String

  • Data Params

   

  Authorization : Bearer Token

  value	type
  token	String

  • Success Response:Code: 200

  {
  	"data":
  		[{
  		"nickname":"example1",
  		"email":"example1"
  		},
  		{
  		"nickname":"example2",
  		"email":"example2"
  		},
  		{
  		"nickname":"example3",
  		"email":"example3"
  		}]
  }

  • Error Response:Code:

   

  • Sample Call:
    
    

    ---

• 그룹나가기

  그룹 나가기

  ---

  그룹코드를 이용하여 로그인사용자를 그룹에서 나가게 합니다.

  • URL:/api/group/{groupcode}?useremail={useremail}

   

  • Method:Delete

   

  • URL Params

    value	type
    groupcode	String

  • Data Params

   

  Authorization : Bearer Token

  value	type
  token	String

  • Success Response:Code: 200

  {
  	"groupname":"example",
  	"groupcode":"example"
  }

  • Error Response:Code:

   

  • Sample Call:
    
    

    ---

 

Plan

• 개인일정 생성

  개인일정 생성

  ---

  개인일정을 생성합니다.

  • URL:/api/schedule

   

  • Method:Post

   

  • URL ParamsNone
  •  

  • Data Params

  Authorization : Bearer Token

  value	type
  token	String

  body

  value	type
  creator_email	String
  name	String
  content	String
  time_start	Long
  time_end	Long
  category	String

  • Success Response:Code: 200

  {
  	"name":"example",
  	"content":"example",
  	"time_start":"202302091820",
  	"time_end":"202302141920",
  	"creator_nickname":"example",
  	"modifier_nickname":"example",
  	"group_code":"0",
  	"schedule_code":"example",
  	"category":"example"
  }

  • Error Response:Code:

   

  • Sample Call:

    {
    	"creator_email":"example",
    	"name":"example",
    	"content":"example",
    	"time_start":"202302091820",
    	"time_end":"202302141920",
    	"category":"example"
    }

    
    

    ---

• 개인일정 날짜별 조회

  개인일정 날짜별 조회

  ---

  개인일정을 날짜별로 조회합니다.

  • URL:/api/schedule-date/{date}

   

  • Method:Get

   

  • URL Params

    value	type
    date	Long(8) ex.20230101

  • Data Params

  Authorization : Bearer Token

  value	type
  token	String

  • Success Response:Code: 200

  {
  	"data":
  		[{
  		"name":"example1",
  		"content":"example1",
  		"time_start":"202302091820",
  		"time_end":"202302141920",
  		"creator_nickname":"example1",
  		"modifier_nickname":"example1",
  		"group_code":"0",
  		"schedule_code":"example1",
  		"category":"example1"
  		},
  		{
  		"name":"example2",
  		"content":"example2",
  		"time_start":"202302091820",
  		"time_end":"202302141920",
  		"creator_nickname":"example2",
  		"modifier_nickname":"example2",
  		"group_code":"0",
  		"schedule_code":"example2",
  		"category":"example2"
  		}]
  }

  • Error Response:Code:

   

  • Sample Call:
    
    

    ---

• 개인일정 수정

  개인일정 수정

  ---

  개인일정을 수정합니다.

   

  • URL:/api/schedule

   

  • Method:Put

   

  • URL ParamsNone
  •  

  • Data Params

  Authorization : Bearer Token

  value	type
  token	String

  body

  value	type
  schedule_code	String
  name	String
  content	String
  category	String

  • Success Response:Code: 200

  {
  	"name":"example",
  	"content":"example",
  	"time_start":"202302091820",
  	"time_end":"202302141920",
  	"creator_nickname":"example",
  	"modifier_nickname":"example",
  	"group_code":"0",
  	"schedule_code":"example",
  	"category":"example"
  }

  • Error Response:Code:

   

  • Sample Call:

    {
    	"schedule_code":"example",
    	"name":"example",
    	"content":"example",
    	"category":"example"
    	"time_start":"202302091820",
    	"time_end":"202302141920"
    }

    
    

    ---

• 개인일정 삭제

  개인일정 삭제

  ---

  개인일정을 삭제합니다.

  • URL:/api/schedule/{schedulecode}

   

  • Method:Delete

   

  • URL Params

  value	type
  schedulecode	String

  • Data Params

  Authorization : Bearer Token

  value	type
  token	String

  • Success Response:Code: 200

  {
  	"name":"example",
  	"content":"example",
  	"time_start":"202302091820",
  	"time_end":"202302141920",
  	"creator_nickname":"example",
  	"modifier_nickname":"example",
  	"group_code":"0",
  	"schedule_code":"example",
  	"category":"example"
  }

  • Error Response:Code:

   

  • Sample Call:
    
    

    ---

• 개인의 모든 일정조회하기

  개인의 모든 일정조회하기

  ---

  개인의 모든 일정을 조회합니다.

  • URL:/api/schedules

   

  • Method:Get

   

  • URL ParamsNone
  •  

  • Data Params

  Authorization : Bearer Token

  value	type
  token	String

  • Success Response:Code: 200

  {
  	"data":
  		"[{
  		"name":"example1",
  		"content":"example1",
  		"time_start":"202302091820",
  		"time_end":"202302141920",
  		"creator_nickname":"example1",
  		"modifier_nickname":"example1",
  		"group_code":"0",
  		"schedule_code":"example1",
  		"category":"example1"
  		},
  		{
  		"name":"example2",
  		"content":"example2",
  		"time_start":"202302091820",
  		"time_end":"202302141920",
  		"creator_nickname":"example2",
  		"modifier_nickname":"example2",
  		"group_code":"0",
  		"schedule_code":"example2",
  		"category":"example2"
  		}]"
  }

  • Error Response:Code:

   

  • Sample Call:
    
    

    ---

 

• 그룹일정 생성

  그룹일정 생성

  ---

  그룹일정을 생성합니다.

  • URL:/api/group-schedule/{groupcode}

   

  • Method:Post

   

  • URL Params

    value	type
    groupcode	String

  • Data Params

  Authorization : Bearer Token

  value	type
  token	String

  body

  value	type
  creator_email	String
  name	String
  content	String
  time_start	Long
  time_end	Long
  category	String

  • Success Response:Code: 200

  {
  	"name":"example",
  	"content":"example",
  	"time_start":"202302091820",
  	"time_end":"202302141920",
  	"creator_nickname":"example",
  	"modifier_nickname":"example",
  	"group_code":"example",
  	"schedule_code":"example",
  	"category":"example"
  }

  • Error Response:Code:

   

  • Sample Call:

    {
    	"creator_email":"example",
    	"name":"example",
    	"content":"example",
    	"time_start":"202302091820",
    	"time_end":"202302141920",
    	"category":"example"
    }

    
    

    ---

• 그룹일정 날짜별 조회

  그룹일정 날짜별 조회

  ---

  그룹일정을 날짜별로 조회합니다.

  • URL:/api/group-schedule-date/{groupcode}/{date}

   

  • Method:Get

   

  • URL Params

    value	type
    group	String
    date	Long(8)

  • Data Params

  Authorization : Bearer Token

  value	type
  token	String

  • Success Response:Code: 200

  {
  	"data":
  		"[{
  		"name":"example1",
  		"content":"example1",
  		"time_start":"202302091820",
  		"time_end":"202302141920",
  		"creator_nickname":"example1",
  		"modifier_nickname":"example1",
  		"group_code":"example1",
  		"schedule_code":"example1",
  		"category":"example1"
  		},
  		{
  		"name":"example2",
  		"content":"example2",
  		"time_start":"202302091820",
  		"time_end":"202302141920",
  		"creator_nickname":"example2",
  		"modifier_nickname":"example2",
  		"group_code":"example2",
  		"schedule_code":"example2",
  		"category":"example2"
  		}]"
  }

  • Error Response:Code:

   

  • Sample Call:
    
    

    ---

• 그룹일정 수정

  그룹일정 수정

  ---

  그룹 일정을 수정합니다.

   

  • URL:/api/group-schedule

   

  • Method:Put

   

  • URL ParamsNone
  •  

  • Data Params

  Authorization : Bearer Token

  value	type
  token	String

  body

  value	type
  schedule_code	String
  name	String
  content	String
  category	String

  • Success Response:Code: 200

  {
  	"name":"example",
  	"content":"example",
  	"time_start":"202302091820",
  	"time_end":"202302141920",
  	"creator_nickname":"example",
  	"modifier_nickname":"example",
  	"group_code":"example",
  	"schedule_code":"example",
  	"category":"example"
  }

  • Error Response:Code:

   

  • Sample Call:

    {
    	"schedule_code":"example",
    	"name":"example",
    	"content":"example",
    	"category":"example"
    	"time_start":"202302091820",
    	"time_end":"202302141920"
    }

    
    

    ---

• 그룹일정 삭제

  그룹일정 삭제

  ---

  그룹일정을 삭제합니다.

  • URL:/api/group-schedule/{schedulecode}

   

  • Method:Delete

   

  • URL Params

    value	type
    schedulecode	String

  • Data Params

  Authorization : Bearer Token

  value	type
  token	String

  • Success Response:Code: 200

  {
  	"name":"example",
  	"content":"example",
  	"time_start":"202302091820",
  	"time_end":"202302141920",
  	"creator_nickname":"example",
  	"modifier_nickname":"example",
  	"group_code":"example",
  	"schedule_code":"example",
  	"category":"example"
  }

  • Error Response:Code:

   

  • Sample Call:
    
    

    ---

• 그룹의 모든 일정조회하기

  그룹의 모든 일정조회하기

  ---

  그룹의 모든일정을 조회합니다.

  • URL:/api/group-schedules/{groupcode}

   

  • Method:Get

   

  • URL Params

    value	type
    groupcode	String

  • Data Params

  Authorization : Bearer Token

  value	type
  token	String

  • Success Response:Code: 200

  {
  	"data":
  		"[{
  		"name":"example1",
  		"content":"example1",
  		"time_start":"202302091820",
  		"time_end":"202302141920",
  		"creator_nickname":"example1",
  		"modifier_nickname":"example1",
  		"group_code":"example1",
  		"schedule_code":"example1",
  		"category":"example1"
  		},
  		{
  		"name":"example2",
  		"content":"example2",
  		"time_start":"202302091820",
  		"time_end":"202302141920",
  		"creator_nickname":"example2",
  		"modifier_nickname":"example2",
  		"group_code":"example2",
  		"schedule_code":"example2",
  		"category":"example2"
  		}]"
  }

  • Error Response:Code:

   

  • Sample Call:
    
    

    ---

 

• 스케줄코드로 일정조회하기

  스케줄코드로 일정조회하기

  ---

  스케줄코드로 일정을 조회합니다.

  개인일정,그룹일정 구분을 하지 않습니다.

  • URL:/api/schedule/{schedulecode}

   

  • Method:Get

   

  • URL Params

    value	type
    schedulecode	String

  • Data Params

  Authorization : Bearer Token

  value	type
  token	String

  • Success Response:

  • Code: 200

  {
  	"name":"example",
  	"content":"example",
  	"time_start":"202302091820",
  	"time_end":"202302141920",
  	"creator_nickname":"example",
  	"modifier_nickname":"example",
  	"group_code":"example",
  	"schedule_code":"example",
  	"category":"example"
  }

  • Error Response:Code:

   

  • Sample Call:
    
    

    ---

• 월별일정조회 -개인,그룹통합

  월별일정조회-개인,그룹통합

  ---

  월별로 일정을 조회합니다. 유저의 일정, 유저가 속한 모든 그룹의 일정을 가져옵니다.

  • URL:/api/schedule-month/{month}

   

  • Method:Get

   

  • URL Params

    value	type
    month	Long(8) ex.20230202

  • Data Params

  Authorization : Bearer Token

  value	type
  token	String

  • Success Response:

  • Code: 200

  {"data": [
          {
              "name": "examplegroup",
              "content": "example",
              "time_start": 202302061820,
              "time_end": 202302161920,
              "creator_nickname": null,
              "modifier_nickname": null,
              "group_code": "ukcQGiunFlN",
              "schedule_code": "V06GN47VifC",
              "category": "example"
          },
          {
              "name": "examplegroup",
              "content": "example",
              "time_start": 202302061820,
              "time_end": 202302161920,
              "creator_nickname": null,
              "modifier_nickname": null,
              "group_code": "ukcQGiunFlN",
              "schedule_code": "4qY95EM3IN8",
              "category": "example"
          }]
  }

  • Error Response:Code:

   

  • Sample Call:
    
    

    ---

• 다가오는일정조회-개인,그룹통합

  다가오는 일정조회-개인,그룹통합

  ---

  todaydate를 기준으로 이후의 일정들을 정렬된 상태로 불러옵니다.

  일정의 기간중 오늘이 포함되어있다면 해당 일정도 포함합니다. 유저의 일정, 유저가 속한 모든 그룹의 일정을 가져옵니다.

  • URL:/api/schedule-comming/{todaydate}

   

  • Method:Get

   

  • URL Params

    value	type
    today	Long(8) ex.20231222

  • Data Params

  Authorization : Bearer Token

  value	type
  token	String

  • Success Response:

  • Code: 200

  {"data": [
          {
              "name": "examplegroup",
              "content": "example",
              "time_start": 202302061820,
              "time_end": 202302161920,
              "creator_nickname": null,
              "modifier_nickname": null,
              "group_code": "ukcQGiunFlN",
              "schedule_code": "V06GN47VifC",
              "category": "example"
          },
          {
              "name": "examplegroup",
              "content": "example",
              "time_start": 202302061820,
              "time_end": 202302161920,
              "creator_nickname": null,
              "modifier_nickname": null,
              "group_code": "ukcQGiunFlN",
              "schedule_code": "4qY95EM3IN8",
              "category": "example"
          }]
  }

  • Error Response:Code:

   

  • Sample Call:
    
    

    ---

• 날짜별일정조회-개인,그룹통합

  날짜별일정조회-개인,그룹통합

  ---

  날짜별로 일정을 조회합니다. 유저의 일정, 유저가 속한 모든 그룹의 일정을 가져옵니다.

  • URL:/api/all-schedule-date/{date}

   

  • Method:Get

   

  • URL Params

    value	type
    date	Long(8) ex.20230101

  • Data Params

  Authorization : Bearer Token

  value	type
  token	String

  • Success Response:

  • Code: 200

  {"data": [
          {
              "name": "example",
              "content": "example",
              "time_start": 202302091820,
              "time_end": 202302141920,
              "creator_nickname": null,
              "modifier_nickname": null,
              "group_code": "0",
              "schedule_code": "Qh0vtc5dOzW",
              "category": "example"
          },
          {
              "name": "examplegroup",
              "content": "example",
              "time_start": 202302061820,
              "time_end": 202302161920,
              "creator_nickname": null,
              "modifier_nickname": null,
              "group_code": "dsadsad",
              "schedule_code": "Q8ZD825N72c",
              "category": "example"
          }
      ]
  }

  • Error Response:Code:

   

  • Sample Call:
    
    

    ---