[미소 클론코딩 프로젝트] 2-14. 관리자 서비스 API - 일정 관리

2023.08.12 - [초기 과업/BackEnd] - [미소 클론코딩 프로젝트] 2-13. 관리자 서비스 API 설계 - 협력업체 관리

[미소 클론코딩 프로젝트] 2-13. 관리자 서비스 API 설계 - 협력업체 관리

 

안녕하세요. 기깔나는 사람들에서 백엔드를 맡고있는 황시아입니다.

이번 시간에는 관리자 서비스 중 일정 관리 서비스 API를 설계해 보겠습니다.

 

---

일정 관리 API

 

---

일정 조회

직원만 조회 가능

 

Request

API 호출 방식

요청 URL	메서드
/api/administrators/schedule	GET

 

Request Header

Request Header에 대한 상세는 다음과 같습니다.

파라미터	타입	필수 여부	설명
Authorization	String	필수	Bearer {JWT_TOKEN} - {JWT_TOKEN} : 로그인 JWT 토큰
Content-Type	String	필수	application/json이어야 함

 

Request Elements

필드	상위 필드	타입	필수 여부	설명
from		String	선택	조회 시작일 형식 : YYYYMMDD 기본값 : 당일
to		String	선택	조회 종료일 형식 : YYYYMMDD 기본값 : 당일

 

Request Syntax

curl -X GET http://{BASE_URL}/api/administrators/schedule?from=20230801&to=20230831 \
    -H "Content-Type: application/json;charset=utf-8" \
    -H "Authorization: Bearer {JWT_TOKEN}"

 

Response

Response Elements

Response Elements에 대한 상세는 다음과 같습니다.

필드	상위 필드	타입	필수 여부	설명
statusCode		Integer	필수	API 공통 가이드 - 공통 Response 참조
message		String	필수	API 공통 가이드 - 공통 Response 참조
data		Object[]	필수	일정 목록
serviceDate	data	String	필수	서비스 일자
serviceTime	data	String	필수	서비스 시간
startTime	data	String	필수	서비스 시작 시각
location	data	String	필수	서비스 위치
memberId	data	String	필수	이용자 일련번호
vendorId	data	String	선택	업체 일련번호 예약이 성사되었을 시 리턴
process	data	String	필수	진행상황 예약 전, 진행 중, 완료 등

 

Response Syntax

{
  "statusCode": 200,
  "message": "성공",
  "data": {
    "serviceDate": "서비스 일자",
    "serviceTime": "서비스 시간",
    "startTime": "서비스 시작 시각",
    "location": "서비스 위치",
    "memberId": "이용자 일련번호",
    "vendorId": "업체 일련번호",
    "process": "진행상황"
  }
}

---

협력업체 일정 조회

협력업체 및 직원 조회 가능

 

Request

API 호출 방식

요청 URL	메서드
/api/administrators/vendors/schedule	GET

 

Request Header

Request Header에 대한 상세는 다음과 같습니다.

파라미터	타입	필수 여부	설명
Authorization	String	필수	Bearer {JWT_TOKEN} - {JWT_TOKEN} : 로그인 JWT 토큰
Content-Type	String	필수	application/json이어야 함

 

Request Elements

필드	상위 필드	타입	필수 여부	설명
vendorId		Integer	필수	협력업체 일련번호
from		String	선택	조회 시작일 형식 : YYYYMMDD 기본값 : 당일
to		String	선택	조회 종료일 형식 : YYYYMMDD 기본값 : 당일

 

Request Syntax

curl -X GET http://{BASE_URL}/api/administrators/vendors/schedule?vendorId=1&from=20230801&to=20230831 \
    -H "Content-Type: application/json;charset=utf-8" \
    -H "Authorization: Bearer {JWT_TOKEN}"

 

Response

Response Elements

Response Elements에 대한 상세는 다음과 같습니다.

필드	상위 필드	타입	필수 여부	설명
statusCode		Integer	필수	API 공통 가이드 - 공통 Response 참조
message		String	필수	API 공통 가이드 - 공통 Response 참조
data		Object[]	필수	일정 목록
serviceDate	data	String	필수	서비스 일자
serviceTime	data	String	필수	서비스 시간
startTime	data	String	필수	서비스 시작 시각
location	data	String	필수	서비스 위치
memberId	data	String	필수	이용자 일련번호
process	data	String	필수	진행상황 예약 전, 진행 중, 완료 등

 

Response Syntax

{
  "statusCode": 200,
  "message": "성공",
  "data": {
    "serviceDate": "서비스 일자",
    "serviceTime": "서비스 시간",
    "startTime": "서비스 시작 시각",
    "location": "서비스 위치",
    "memberId": "이용자 일련번호",
    "process": "진행상황"
  }
}