-
Notifications
You must be signed in to change notification settings - Fork 4
API Reference
์ค์งํ edited this page Sep 22, 2021
·
18 revisions
| ๋ฉ์๋ | ์์ฒญ URL | ์ค๋ช |
|---|---|---|
| GET | /user | Handover ํ์ ์กฐํ |
| ๋ณ์๋ช | ํ์ | ํ์์ฌ๋ถ | ๊ธฐ๋ณธ ๊ฐ |
|---|---|---|---|
| serviceNumber | String | N | ์ฌ์ฉ์ ๊ตฐ๋ฒ |
| name | String | N | ์ฌ์ฉ์ ์ด๋ฆ |
| groupName | String | N | ์ฌ์ฉ์๊ฐ ์์๋ ๊ทธ๋ฃน ์ด๋ฆ |
| ํ๋ | ํ์ | ์ค๋ช |
|---|---|---|
| name | String | ์ฌ์ฉ์ ์ด๋ฆ |
| rank | String | ์ฌ์ฉ์ ๊ณ๊ธ |
| title | String | ์ฌ์ฉ์ ์ง์ |
| group | String | ์ฌ์ฉ์๊ฐ ์ํ ๋ถ์ |
| String | ์ฌ์ฉ์ ์ด๋ฉ์ผ | |
| tel | String | ์ฌ์ฉ์ ์ ํ๋ฒํธ |
| HTTP ์ฝ๋ | ์๋ฌ ๋ฉ์ธ์ง | ์กฐ์น๋ฐฉ์ |
|---|---|---|
| 401 | Authentication Failed: ์ธ์ฆ์ ์คํจํ์ต๋๋ค. | ๋ก๊ทธ์ธ ์ธ์ ์ ํ์ธํด์ฃผ์ธ์. |
| 403 | Forbidden: ๊ถํ์ด ์์ต๋๋ค. | |
| 404 | Not Found: ๊ฒ์ ๊ฒฐ๊ณผ๊ฐ ์์ต๋๋ค. | |
| 500 | Interner Server Error: ๋ฐ์ดํฐ๋ฒ ์ด์ค ์ค๋ฅ์ ๋๋ค. |
| ๋ฉ์๋ | ์์ฒญ URL | ์ค๋ช |
|---|---|---|
| POST | /user | Handover ์ฌ์ฉ์ ์์ฑ |
| ๋ณ์๋ช | ํ์ | ํ์์ฌ๋ถ | ๊ธฐ๋ณธ ๊ฐ |
|---|---|---|---|
| serviceNumber | String | Y | ์ฌ์ฉ์ ๊ตฐ๋ฒ |
| password | String | Y | ์ฌ์ฉ์ ๋น๋ฐ๋ฒํธ |
| name | String | Y | ์ฌ์ฉ์ ์ด๋ฆ |
| rank | String | Y | ์ฌ์ฉ์ ๊ณ๊ธ |
| title | String | Y | ์ฌ์ฉ์ ์ง์ |
| groupId | String | Y | ์ฌ์ฉ์ ์์ ๋ถ์ |
| String | Y | ์ฌ์ฉ์ ์ด๋ฉ์ผ | |
| tel | String | Y | ์ฌ์ฉ์ ์ ํ๋ฒํธ |
์ถ๋ ฅ๊ฒฐ๊ณผ๋ ๋ณ๋๋ก ์์ผ๋ฉฐ, ์์ฑ์ด ์๋ฃ๋ ๊ฒฝ์ฐ HTTP ์ฝ๋๊ฐ 201๋ก ๋ฐํ๋ฉ๋๋ค.
| HTTP ์ฝ๋ | ์๋ฌ ๋ฉ์ธ์ง | ์กฐ์น๋ฐฉ์ |
|---|---|---|
| 400 | ์๋ชป๋ ์์ฒญ | ํ์ ์์ฒญ ๋ณ์๋ค์ ๋ชจ๋ ์ ๋ ฅํ๋์ง ํ์ธํด์ฃผ์ธ์. |
| 400 | Duplicated Key Error: serviceNumber is already exists. | |
| 500 | Interner Server Error | ์๋ฒ ๋ด๋ถ ์ค๋ฅ์ ๋๋ค. ๊ฐ๋ฐ์์๊ฒ ๋ฌธ์ํด์ฃผ์ธ์. |
| ๋ฉ์๋ | ์์ฒญ URL | ์ค๋ช |
|---|---|---|
| UPDATE | /user | Handover ์ฌ์ฉ์ ์ ๋ณด ๊ฐฑ์ |
| ๋ณ์๋ช | ํ์ | ํ์์ฌ๋ถ | ๊ธฐ๋ณธ ๊ฐ |
|---|---|---|---|
| serviceNumber | String | Y | ์ฌ์ฉ์ ๊ตฐ๋ฒ |
| password | String | N | ์ฌ์ฉ์ ๋น๋ฐ๋ฒํธ |
| name | String | N | ์ฌ์ฉ์ ์ด๋ฆ |
| rank | String | N | ์ฌ์ฉ์ ๊ณ๊ธ |
| title | String | N | ์ฌ์ฉ์ ์ง์ |
| groupId | String | N | ์ฌ์ฉ์ ์์ ๋ถ์ |
| String | N | ์ฌ์ฉ์ ์ด๋ฉ์ผ | |
| tel | String | N | ์ฌ์ฉ์ ์ ํ๋ฒํธ |
์ถ๋ ฅ๊ฒฐ๊ณผ๋ ๋ณ๋๋ก ์์ผ๋ฉฐ, ๋ณ๊ฒฝ์ด ์๋ฃ๋ ๊ฒฝ์ฐ HTTP ์ฝ๋๊ฐ 204๋ก ๋ฐํ๋ฉ๋๋ค.
| HTTP ์ฝ๋ | ์๋ฌ ๋ฉ์ธ์ง | ์กฐ์น๋ฐฉ์ |
|---|---|---|
| 400 | ์๋ชป๋ ์์ฒญ | ํ์ ์์ฒญ ๋ณ์๋ค์ ๋ชจ๋ ์ ๋ ฅํ๋์ง ํ์ธํด์ฃผ์ธ์. |
| 401 | Authentication Failed: ์ธ์ฆ์ ์คํจํ์ต๋๋ค. | ๋ก๊ทธ์ธ ์ธ์ ์ ํ์ธํด์ฃผ์ธ์. |
| 403 | Forbidden: ๊ถํ์ด ์์ต๋๋ค. | |
| 404 | Not Found: ์์ฒญํ ๊ตฐ๋ฒ์ ์ฐพ์ ์ ์์ต๋๋ค. | |
| 500 | Interner Server Error | ์๋ฒ ๋ด๋ถ ์ค๋ฅ์ ๋๋ค. ๊ฐ๋ฐ์์๊ฒ ๋ฌธ์ํด์ฃผ์ธ์. |
| ๋ฉ์๋ | ์์ฒญ URL | ์ค๋ช |
|---|---|---|
| DELETE | /user | Handover ์ฌ์ฉ์ ์ญ์ |
| ๋ณ์๋ช | ํ์ | ํ์์ฌ๋ถ | ๊ธฐ๋ณธ ๊ฐ |
|---|---|---|---|
| serviceNumber | String | Y | ์ฌ์ฉ์ ๊ตฐ๋ฒ |
์ถ๋ ฅ๊ฒฐ๊ณผ๋ ๋ณ๋๋ก ์์ผ๋ฉฐ, ๋ณ๊ฒฝ์ด ์๋ฃ๋ ๊ฒฝ์ฐ HTTP ์ฝ๋๊ฐ 204๋ก ๋ฐํ๋ฉ๋๋ค.
| HTTP ์ฝ๋ | ์๋ฌ ๋ฉ์ธ์ง | ์กฐ์น๋ฐฉ์ |
|---|---|---|
| 400 | ์๋ชป๋ ์์ฒญ | ํ์ ์์ฒญ ๋ณ์๋ค์ ๋ชจ๋ ์ ๋ ฅํ๋์ง ํ์ธํด์ฃผ์ธ์. |
| 401 | Authentication Failed: ์ธ์ฆ์ ์คํจํ์ต๋๋ค. | ๋ก๊ทธ์ธ ์ธ์ ์ ํ์ธํด์ฃผ์ธ์. |
| 403 | Forbidden: ๊ถํ์ด ์์ต๋๋ค. | |
| 404 | Not Found: ์์ฒญํ ๊ตฐ๋ฒ์ ์ฐพ์ ์ ์์ต๋๋ค. | |
| 500 | Interner Server Error | ์๋ฒ ๋ด๋ถ ์ค๋ฅ์ ๋๋ค. ๊ฐ๋ฐ์์๊ฒ ๋ฌธ์ํด์ฃผ์ธ์. |