API Reference

User

• 로그인
• 사용자 검색
• 사용자 생성
• 사용자 정보 갱신
• 사용자 삭제

---

User > 로그인

1. API 기본 정보

메서드	요청 URL	설명
POST	/login	Handover 로그인

2. 요청변수

변수명	타입	필수여부	설명
serviceNumber	String	Y	사용자 군번
password	String	Y	사용자 비밀번호

3. 출력결과

필드	타입	설명
result	String
token	String	JWT 토큰

4. 에러코드

HTTP 코드	에러 메세지	조치방안
401	Authentication Failed: 인증에 실패했습니다.	로그인 세션을 확인해주세요.
500	Interner Server Error	서버 내부 오류입니다. 개발자에게 문의하세요.

---

User > 사용자 검색

1. API 기본 정보

메서드	요청 URL	설명
GET	/user	Handover 회원 조회

2. 요청변수

변수명	타입	필수여부	설명
serviceNumber	String	N	사용자 군번
name	String	N	사용자 이름
groupName	String	N	사용자가 소속된 그룹 이름

3. 출력결과

필드	타입	설명
name	String	사용자 이름
rank	String	사용자 계급
title	String	사용자 직위
group	String	사용자가 속한 부서
email	String	사용자 이메일
tel	String	사용자 전화번호

4. 에러코드

HTTP 코드	에러 메세지	조치방안
401	Authentication Failed: 인증에 실패했습니다.	로그인 세션을 확인해주세요.
403	Forbidden: 권한이 없습니다.
404	Not Found: 검색 결과가 없습니다.
500	Interner Server Error: 데이터베이스 오류입니다.

---

User > 사용자 생성

1. API 기본 정보

메서드	요청 URL	설명
POST	/user	Handover 사용자 생성

2. 요청변수

변수명	타입	필수여부	설명
serviceNumber	String	Y	사용자 군번
password	String	Y	사용자 비밀번호
name	String	Y	사용자 이름
rank	String	Y	사용자 계급
title	String	Y	사용자 직위
groupId	String	Y	사용자 소속 부서
email	String	Y	사용자 이메일
tel	String	Y	사용자 전화번호

3. 출력결과

출력결과는 별도로 없으며, 생성이 완료된 경우 HTTP 코드가 201로 반환됩니다.

4. 에러코드

HTTP 코드	에러 메세지	조치방안
400	잘못된 요청	필수 요청 변수들을 모두 입력했는지 확인해주세요.
400	Duplicated Key Error: serviceNumber is already exists.
500	Interner Server Error	서버 내부 오류입니다. 개발자에게 문의해주세요.

---

User > 사용자 정보 갱신

1. API 기본 정보

메서드	요청 URL	설명
UPDATE	/user	Handover 사용자 정보 갱신

2. 요청변수

변수명	타입	필수여부	설명
serviceNumber	String	Y	사용자 군번
password	String	N	사용자 비밀번호
name	String	N	사용자 이름
rank	String	N	사용자 계급
title	String	N	사용자 직위
groupId	String	N	사용자 소속 부서
email	String	N	사용자 이메일
tel	String	N	사용자 전화번호

3. 출력결과

출력결과는 별도로 없으며, 변경이 완료된 경우 HTTP 코드가 204로 반환됩니다.

4. 에러코드

HTTP 코드	에러 메세지	조치방안
400	잘못된 요청	필수 요청 변수들을 모두 입력했는지 확인해주세요.
401	Authentication Failed: 인증에 실패했습니다.	로그인 세션을 확인해주세요.
403	Forbidden: 권한이 없습니다.
404	Not Found: 요청한 군번을 찾을 수 없습니다.
500	Interner Server Error	서버 내부 오류입니다. 개발자에게 문의해주세요.

---

User > 사용자 삭제

1. API 기본 정보

메서드	요청 URL	설명
DELETE	/user	Handover 사용자 삭제

2. 요청변수

변수명	타입	필수여부	설명
serviceNumber	String	Y	사용자 군번

3. 출력결과

출력결과는 별도로 없으며, 삭제가 완료된 경우 HTTP 코드가 204로 반환됩니다.

4. 에러코드

HTTP 코드	에러 메세지	조치방안
400	잘못된 요청	필수 요청 변수들을 모두 입력했는지 확인해주세요.
401	Authentication Failed: 인증에 실패했습니다.	로그인 세션을 확인해주세요.
403	Forbidden: 권한이 없습니다.
404	Not Found: 요청한 군번을 찾을 수 없습니다.
500	Interner Server Error	서버 내부 오류입니다. 개발자에게 문의해주세요.

---

Item

• 서랍 검색
• 서랍 생성
• 문서 생성

---

Item > 서랍 검색

1. API 기본 정보

메서드	요청 URL	설명
GET	/item	Handover 서랍 조회

2. 요청변수

변수명	타입	필수여부	설명
id	String	N	서랍 ID

3. 출력결과

필드	타입	설명
title	String	서랍 이름
content	String	서랍 내용
ownerServiceNumber	Object	소유자
contributors	[ Object, ]	기여자들
accessGroups	{ read, edit }	접근 권한 그룹들
history	[ Object, ]	수정 기록
lastModified	String	최종 수정 일시
status	String	상태 { draft: 임시저장, archived: 보관, published: 게시 }
inspection	Object	보안 검수 결과
comments	[ Object, ]	댓글들
tags	[ String, ]	태그들

4. 출력예시

요청변수 미 입력시

[
    {
        title: "서랍01",
        owner: {
            name: "조나단",
            rank: "대위",
            groupName: "해군 군수사령부"
        },
        contibutors: [
            { name: "오지환", rank: "중사", groupName: "해군 군수사령부" }
        ],
        accessGroups: {
            read: [ "해군 군수사령부", "해군 군수사령부 정보통신전대" ],
            edit: [ "해군 군수사령부" ]
        },
        lastModified: "2021-09-14 14:00:00",
        status: "published",
        inspection: {
            result: "true",
            by: { name: "박현준", "rank": "중령", groupName: "해군 군수사령부" },
            date: "2021-09-14 14:00:00"
        },
        tags: [ "인수인계" ]
    },
    {
        title: "서랍02",
        ...
    }
]

요청변수 입력시

{
    title: "서랍01",
    content: "서랍은 문서들을 담을 수 있는 공간입니다.",
    owner: {
        name: "조나단",
        rank: "대위",
        groupName: "해군 군수사령부"
    },
    contibutors: [
        { name: "오지환", rank: "중사", groupName: "해군 군수사령부" }
    ],
    accessGroups: {
        read: [ "해군 군수사령부", "해군 군수사령부 정보통신전대" ],
        edit: [ "해군 군수사령부" ]
    },
    history: {
        { date: "2021-08-31 10:00:00", user: { name: "조나단", rank: "대위", groupName: "해군 군수사령부" } }
    },
    status: "published",
    inspection: {
        result: "true",
        by: { name: "박현준", "rank": "중령", groupName: "해군 군수사령부" },
        date: "2021-09-14 14:00:00"
    },
    comments: [
        { content: "댓글입니다.", user: { name: "오지환", rank: "중사", groupName: "해군 군수사령부" } }
    ],
    tags: [ "인수인계" ]
}

5. 에러코드

HTTP 코드	에러 메세지	조치방안
401	Authentication Failed: 인증에 실패했습니다.	로그인 세션을 확인해주세요.
404	Not Found: 검색 결과가 없습니다.
500	Interner Server Error: 데이터베이스 오류입니다.

---

Item > 서랍 생성

1. API 기본 정보

메서드	요청 URL	설명
POST	/item	Handover 서랍 생성

2. 요청변수

필드	타입	필수여부	설명
title	String	Y	서랍 이름
content	String	N	서랍 내용
accessGroups	{ read, edit }	N	값 미지정시 소속부대로 설정
status	String	Y	상태 { draft: 임시저장, archived: 보관, published: 게시 }
tags	[ String, ]	N	태그들

3. 요청예제

{
    title: "우리부서 서랍",
    content: "서랍을 만들고 관리할 수 있어요.",
    accessGroups: {
        read: [ groupId ],
    },
    status: "draft",
    tags: [ "우리부대", "화이팅" ]
}

4. 출력결과

출력결과는 별도로 없으며, 생성이 완료된 경우 HTTP 코드가 201로 반환됩니다.

5. 에러코드

HTTP 코드	에러 메세지	조치방안
400	잘못된 요청	필수 요청 변수들을 모두 입력했는지 확인해주세요.
401	Authentication Failed: 인증에 실패했습니다.	로그인 세션을 확인해주세요.
500	Interner Server Error: 데이터베이스 오류입니다.

---

Item > 서랍 정보 갱신

1. API 기본 정보

메서드	요청 URL	설명
UPDATE	/item/:{서랍ID}	Handover 서랍 정보 갱신

---

Item > 서랍 삭제

1. API 기본 정보

메서드	요청 URL	설명
DELETE	/item/:{서랍ID}	Handover 서랍 삭제

---

Item > 문서 생성

1. API 기본 정보

메서드	요청 URL	설명
POST	/item/:{서랍ID}	Handover 문서 생성