-
Notifications
You must be signed in to change notification settings - Fork 1
checkmate API Document
name | method | uri |
---|---|---|
๋ก๊ทธ์ธ | POST | /auth/login |
์ ์ฒด ๊ทผ๋ฌด์ง ์กฐํํ๊ธฐ | GET | /user/{userId}/work |
๋จ์ผ ๊ทผ๋ฌด์ง ์ถ๊ฐํ๊ธฐ | POST | /user/{userId}/work |
๋จ์ผ ๊ทผ๋ฌด์ง ์กฐํํ๊ธฐ | GET | /user/{userId}/work/{workId} |
๋จ์ผ ๊ทผ๋ฌด์ง ์์ ํ๊ธฐ | PUT | /user/{userId}/work/{workId} |
๋จ์ผ ๊ทผ๋ฌด์ง ์ญ์ ํ๊ธฐ | DELETE | /user/{userId}/work/{workId} |
๋ฉ์ธ ํ๋ฉด ์กฐํํ๊ธฐ | GET | /user/{userId}/work/{workId}/main |
๊ทผ๋ฌด ์๊ฐ ๊ธฐ๋กํ๊ธฐ | POST | /user/{userId}/work/{workId}/main |
์ด๋ฒ๋ฌ ์๊ธ ์ ๋ณด ์์ธํ ์กฐํํ๊ธฐ | GET | /user/{userId}/work/{workId}/main/detail |
๋ฌ๋ ฅ ํ๋ฉด ์กฐํํ๊ธฐ | GET | /user/{userId}/work/{workId}/main/calendar/{year}/{month} |
๋ฌ๋ ฅ์์ ์ผ์๋ณ ์กฐํํ๊ธฐ | GET | /user/{userId}/work/{workId}/main/calendar/{year}/{month}/{day} |
URI
POST /auth/login
REQUEST
{
"id": "889870181",
"nickname": "ํ๊ธธ๋",
"email": "qwerty@gmail.com",
"thumbnail_image": "thumbnail_image_url@kakako.com"
}
RESPONSE
200 : OK
{
"code": 200,
"message": "OK"
}
404 : NOT FOUND
๋ฏธ๊ตฌํ
500 : INTERNAL SERVER ERROR
{
"code": 500,
"message": "INTERNAL SERVER ERROR"
}
DESCRIPTION OF THE FIELD To Top
key | type | description |
---|---|---|
id | string | ์ฌ์ฉ์์ ์นด์นด์คํก ๊ณ ์ id |
nickname | string | ์ฌ์ฉ์์ ์นด์นด์คํก ๋๋ค์ |
string | ์ฌ์ฉ์์ ์นด์นด์คํก ๊ณ์ ์ด๋ฉ์ผ | |
thumbnail_image | string | ์ฌ์ฉ์์ ์นด์นด์คํก ํ๋กํ ์ด๋ฏธ์ง ์ธ๋ค์ผ url |
URI
GET /user/{userId}/work
REQUEST
body ์์
RESPONSE
[
{
"id": "workId0001",
"user_id": "123456789",
"name": "๋งฅ๋๋ ๋",
"address": "์์ธํน๋ณ์ ์ฑ๋ถ๊ตฌ ๋ด์ ๋ 1๊ฐ",
"latitude": 10.21593,
"longitude": 43.87534,
"hourly_wage": 7530,
"probation": 2,
"recess": 1,
"recess_state": 0,
"pay_day": 25,
"tax": 3.3,
"five_state": 0,
"working_day": "1010100"
},
{
"id": "workId0002",
"user_id": "123456789",
"name": "๋กฏ๋ฐ๋ฆฌ์",
"address": "์์ธํน๋ณ์ ์ฑ๋ถ๊ตฌ ๋ด์ ๋ 2๊ฐ",
"latitude": 43.87534,
"longitude": 10.21593,
"hourly_wage": 8000,
"probation": 1,
"recess": 2,
"recess_state": 1,
"pay_day": 15,
"tax": 8.5,
"five_state": 1,
"working_day": "1111100"
}
]
DESCRIPTION OF THE FIELD To Top
key | type | description |
---|---|---|
id | string | ๊ทผ๋ฌด์ง ์๋ณ์ id |
user_id | string | ์ ์ id |
name | string | ๊ทผ๋ฌด์ง๋ช |
address | string | ๊ทผ๋ฌด์ง ์ฃผ์ |
latitude | double | ๊ทผ๋ฌด์ง ์๋ |
longitude | double | ๊ทผ๋ฌด์ง ๊ฒฝ๋ |
hourly_wage | int | ์๊ธ |
probation | int | ์์ต๊ธฐ๊ฐ(์๋จ์) |
recess | int | ํด๊ฒ์๊ฐ(์๊ฐ๋จ์) |
recess_state | int | ํด๊ฒ์๊ฐ ์ ๋ฌด๊ธ ์ฌ๋ถ(๋ฌด๊ธ-0/์ ๊ธ-1) |
pay_day | int | ๊ธ์ฌ์ผ(์ผ๋จ์) |
tax | double | ์ธ๊ธ ์ ์ฉ ๋น์จ(8.5/3.3) |
five_state | int | ์์๊ทผ๋ก์ 5์ธ ์ด์ ์ฌ์ ์ฅ ์ฌ๋ถ(๋ฏธ๋ง-0/์ด์-1) |
working_day | string | ๊ทผ๋ฌด์ผ(ํด์ผ-0/๊ทผ๋ฌด์ผ-1) |
URI
POST /user/{userId}/work
REQUEST
{
"name": "๋งฅ๋๋ ๋",
"address": "์์ธํน๋ณ์ ์ฑ๋ถ๊ตฌ ๋ด์ ๋ 1๊ฐ",
"latitude": 10.21593,
"longitude": 43.87534,
"hourly_wage": 7530,
"probation": 2,
"recess": 1,
"recess_state": 0,
"pay_day": 25,
"tax": 3.3,
"five_state": 0,
"working_day": "1010100"
}
RESPONSE
200 : OK
{
"code": 200,
"message": "OK"
}
404 : NOT FOUND
๋ฏธ๊ตฌํ
500 : INTERNAL SERVER ERROR
{
"code": 500,
"message": "INTERNAL SERVER ERROR"
}
DESCRIPTION OF THE FIELD To Top
key | type | description |
---|---|---|
name | string | ๊ทผ๋ฌด์ง๋ช |
address | string | ๊ทผ๋ฌด์ง ์ฃผ์ |
latitude | double | ๊ทผ๋ฌด์ง ์๋ |
longitude | double | ๊ทผ๋ฌด์ง ๊ฒฝ๋ |
hourly_wage | int | ์๊ธ |
probation | int | ์์ต๊ธฐ๊ฐ(์๋จ์) |
recess | int | ํด๊ฒ์๊ฐ(์๊ฐ๋จ์) |
recess_state | int | ํด๊ฒ์๊ฐ ์ ๋ฌด๊ธ ์ฌ๋ถ(๋ฌด๊ธ-0/์ ๊ธ-1) |
pay_day | int | ๊ธ์ฌ์ผ(์ผ๋จ์) |
tax | double | ์ธ๊ธ ์ ์ฉ ๋น์จ(8.5/3.3) |
five_state | int | ์์๊ทผ๋ก์ 5์ธ ์ด์ ์ฌ์ ์ฅ ์ฌ๋ถ(๋ฏธ๋ง-0/์ด์-1) |
working_day | string | ๊ทผ๋ฌด์ผ(ํด์ผ-0/๊ทผ๋ฌด์ผ-1) |
URI
GET /user/{userId}/work/{workId}
REQUEST
body ์์
RESPONSE
{
"id": "workId0001",
"user_id": "123456789",
"name": "๋งฅ๋๋ ๋",
"address": "์์ธํน๋ณ์ ์ฑ๋ถ๊ตฌ ๋ด์ ๋ 1๊ฐ",
"latitude": 10.21593,
"longitude": 43.87534,
"hourly_wage": 7530,
"probation": 2,
"recess": 1,
"recess_state": 0,
"pay_day": 25,
"tax": 3.3,
"five_state": 0,
"working_day": "1010100"
}
DESCRIPTION OF THE FIELD To Top
key | type | description |
---|---|---|
id | string | ๊ทผ๋ฌด์ง id |
user_id | string | ์ ์ id |
name | string | ๊ทผ๋ฌด์ง๋ช |
address | string | ๊ทผ๋ฌด์ง ์ฃผ์ |
latitude | double | ๊ทผ๋ฌด์ง ์๋ |
longitude | double | ๊ทผ๋ฌด์ง ๊ฒฝ๋ |
hourly_wage | int | ์๊ธ |
probation | int | ์์ต๊ธฐ๊ฐ(์๋จ์) |
recess | int | ํด๊ฒ์๊ฐ(์๊ฐ๋จ์) |
recess_state | int | ํด๊ฒ์๊ฐ ์ ๋ฌด๊ธ ์ฌ๋ถ(๋ฌด๊ธ-0/์ ๊ธ-1) |
pay_day | int | ๊ธ์ฌ์ผ(์ผ๋จ์) |
tax | double | ์ธ๊ธ ์ ์ฉ ๋น์จ(8.5/3.3) |
five_state | int | ์์๊ทผ๋ก์ 5์ธ ์ด์ ์ฌ์ ์ฅ ์ฌ๋ถ(๋ฏธ๋ง-0/์ด์-1) |
working_day | string | ๊ทผ๋ฌด์ผ(ํด์ผ-0/๊ทผ๋ฌด์ผ-1) |
URI
PUT /user/{userId}/work/{workId}
REQUEST
{
"name": "๋งฅ๋๋ ๋",
"address": "์์ธํน๋ณ์ ์ฑ๋ถ๊ตฌ ๋ด์ ๋ 1๊ฐ",
"latitude": 10.21593,
"longitude": 43.87534,
"hourly_wage": 7530,
"probation": 2,
"recess": 1,
"recess_state": 0,
"pay_day": 25,
"tax": 3.3,
"five_state": 0,
"working_day": "1010100"
}
RESPONSE
200 : OK
{
"code": 200,
"message": "OK"
}
404 : NOT FOUND
๋ฏธ๊ตฌํ
500 : INTERNAL SERVER ERROR
{
"code": 500,
"message": "INTERNAL SERVER ERROR"
}
DESCRIPTION OF THE FIELD To Top
key | type | description |
---|---|---|
name | string | ๊ทผ๋ฌด์ง๋ช |
address | string | ๊ทผ๋ฌด์ง ์ฃผ์ |
latitude | double | ๊ทผ๋ฌด์ง ์๋ |
longitude | double | ๊ทผ๋ฌด์ง ๊ฒฝ๋ |
hourly_wage | int | ์๊ธ |
probation | int | ์์ต๊ธฐ๊ฐ(์๋จ์) |
recess | int | ํด๊ฒ์๊ฐ(์๊ฐ๋จ์) |
recess_state | int | ํด๊ฒ์๊ฐ ์ ๋ฌด๊ธ ์ฌ๋ถ(๋ฌด๊ธ-0/์ ๊ธ-1) |
pay_day | int | ๊ธ์ฌ์ผ(์ผ๋จ์) |
tax | double | ์ธ๊ธ ์ ์ฉ ๋น์จ(8.5/3.3) |
five_state | int | ์์๊ทผ๋ก์ 5์ธ ์ด์ ์ฌ์ ์ฅ ์ฌ๋ถ(๋ฏธ๋ง-0/์ด์-1) |
working_day | string | ๊ทผ๋ฌด์ผ(ํด์ผ-0/๊ทผ๋ฌด์ผ-1) |
URI
DELETE /user/{userId}/work/{workId}
REQUEST
body ์์
RESPONSE
200 : OK
{
"code": 200,
"message": "OK"
}
404 : NOT FOUND
๋ฏธ๊ตฌํ
500 : INTERNAL SERVER ERROR
{
"code": 500,
"message": "INTERNAL SERVER ERROR"
}
DESCRIPTION OF THE FIELD To Top
key | type | description |
---|---|---|
code | int | http ์ํ์ฝ๋ |
message | string | ๋ฉ์ธ์ง |
URI
GET /user/{userId}/work/{workId}/main
REQUEST
body ์์
RESPONSE
{
"base_day": 31,
"total_day": 25,
"total_money": 691200,
"total_hour": 72,
"hourly_wage": 8000
}
DESCRIPTION OF THE FIELD To Top
key | type | description |
---|---|---|
base_day | int | ์ด์ ๋ฌ ์๊ธ์ผ๊ณผ ์ด๋ฒ๋ฌ ์๊ธ์ผ์ ์ฐจ์ด |
total_day | int | ์ด์ ์๊ธ์ผ ๋ค์๋ ๋ถํฐ ํ์ฌ๊น์ง ์ผ์ |
total_money | int | ํ์ฌ๊น์ง ์ด๋ฒ๋ฌ ๋ฒ ๋ |
total_hour | int | ์ด๋ฒ๋ฌ ์ผํ ์๊ฐ |
hourly_wage | int | ์๊ธ |
URI
POST /user/{userId}/work/{workId}/main
REQUEST
{
"working_state": 1
}
RESPONSE
200 : OK
{
"code": 200,
"message": "OK"
}
404 : NOT FOUND
๋ฏธ๊ตฌํ
500 : INTERNAL SERVER ERROR
{
"code": 500,
"message": "INTERNAL SERVER ERROR"
}
DESCRIPTION OF THE FIELD To Top
key | type | description |
---|---|---|
working_state | int | 1(On)/0(Off) |
URI
GET /user/{userId}/work/{workId}/main/detail
REQUEST
body ์์
RESPONSE
{
"total_money": 518400,
"total_hour": 72,
"hourly_wage": 8000,
"weekly_holiday_allowance": 50000,
"night_allowance": 30000,
"holiday_allowance": 0,
"overtime_pay": 0
}
DESCRIPTION OF THE FIELD To Top
key | type | description |
---|---|---|
total_money | int | ํ์ฌ๊น์ง ์ด๋ฒ๋ฌ ๋ฒ ๋ |
total_hour | int | ํ์ฌ๊น์ง ์ด๋ฒ๋ฌ ์ผํ ์๊ฐ |
hourly_wage | int | ์๊ธ |
weekly_holiday_allowance | int | ํ์ฌ๊น์ง ์ด๋ฒ๋ฌ ์ฃผํด์๋น |
night_allowance | int | ํ์ฌ๊น์ง ์ด๋ฒ๋ฌ ์ผ๊ฐ๊ทผ๋ก์๋น |
holiday_allowance | int | ํ์ฌ๊น์ง ์ด๋ฒ๋ฌ ํด์ผ๊ทผ๋ก์๋น |
overtime_pay | int | ํ์ฌ๊น์ง ์ด๋ฒ๋ฌ ์ฐ์ฅ๊ทผ๋ก์๋น |
URI
GET /user/{userId}/work/{workId}/main/calendar/{year}/{month}
REQUEST
body ์์
RESPONSE
[
{
"date": "18-08-20",
"daily_wage": 72000
},
{
"date": "18-08-22",
"daily_wage": 75040
}
]
DESCRIPTION OF THE FIELD To Top
key | type | description |
---|---|---|
date | int | ๊ทผ๋ฌดํ ์ผ์ |
daily_wage | int | ๊ทธ๋ ๋ฒ ๋ |
URI
GET /user/{userId}/work/{workId}/main/calendar/{year}/{month}/{day}
REQUEST
body ์์
RESPONSE
{
"daily_wage": 80000,
"hourly_wage": 7350,
"working_hour": 5,
"time": [
{
"timestamp": "18-08-04 11:00:00"
},
{
"timestamp": "18-08-04 13:00:00"
},
{
"timestamp": "18-08-04 14:00:00"
},
{
"timestamp": "18-08-04 17:00:00"
}
],
"night_allowance": 30000,
"holiday_allowance": 0,
"overtime_pay": 0,
"weekly_holiday_allowance": 50000,
}
DESCRIPTION OF THE FIELD To Top
key | type | description |
---|---|---|
daily_wage | int | ๋น์ผ ๋ฒ ๋ |
hourly_wage | int | ์๊ธ |
working_hour | int | ๋น์ผ ์ผํ ์๊ฐ |
time | array | ๋น์ผ ๊ทผ๋ฌด ์๊ฐ ๊ธฐ๋ก ์ ๋ณด |
timestamp | string | ๋น์ผ ๊ทผ๋ฌด ์๊ฐ ๊ธฐ๋ก(YY-MM-DD HH:MM:SS) |
night_allowance | int | ๋น์ผ ์ผ๊ฐ๊ทผ๋ก์๋น |
holiday_allowance | int | ๋น์ผ ํด์ผ๊ทผ๋ก์๋น |
overtime_pay | int | ๋น์ผ ์ฐ์ฅ๊ทผ๋ก์๋น |
weekly_holiday_allowance | int | ์ฃผํด์๋น |