신체 기본 정보 API

개요

성별, 키, 체중 등 신체 기본 정보에 관한 API 입니다

사전 준비 사항

회원 가입
로그인
1. 로그인 시 발행되는 access token key를 헤더에 Authorization: Bearer {ACCESS_TOKEN} 값을 설정
API 요청

신체 기본 정보 API 레퍼런스

신체 기본 정보 리스트 조회

설명

신체 기본 정보 리스트 조회 API 입니다.

요청 URL

HTTP 메서드	URL
GET	api.energyboostlab.com/body/info/

파라미터

파라미터	타입	필수여부	설명
없음

Request Example

GET /body/info/ HTTP/1.1
Host: api.energyboostlab.com
Content-Type: application/json
Authorization: Bearer {ACCESS_TOKEN}
{}

Response Example

[
    {
        "id": 1,
        ...
        "gender": "male",
        "height": 170.0,
        "date_of_birth": "1990-01-01",
        "recode_date": "2023-10-02T06:00:00"
    },
    {
        "id": 2,
        ...
        "gender": "male",
        "height": 175.0,
        "date_of_birth": "1990-01-01",
        "recode_date": "2023-10-15T18:00:00"
    }
]

Return Code

구분	코드	내용	설명
성공	200	성공	OK
실패	401	권한 없음	API 사용 권한이 없습니다
	403	비정상 접근	잘못된 요청입니다
	404	존재하지 않은 요청	존재하지 않은 요청입니다
	500	시스템 에러	테스트

신체 기본 정보 상세 조회

설명

신체 기본 정보 상세 조회 API 입니다.

요청 URL

HTTP 메서드	URL
GET	api.energyboostlab.com/body/info/{ID}/

파라미터

파라미터	타입	필수여부	설명
없음

Request Example

GET /body/info/{ID}/ HTTP/1.1
Host: api.energyboostlab.com
Content-Type: application/json
Authorization: Bearer {ACCESS_TOKEN}
{}

Response Example

{
    "id": 1,
    "user": {
    ...
    },
    "update_date": "2023-10-18T00:18:45.793671",
    "create_date": "2023-10-18T00:13:26.310449",
    "gender": "male",
    "height": 170.0,
    "date_of_birth": "1990-01-01",
    "recode_date": "2023-10-02T06:00:00"
}

Return Code

구분	코드	내용	설명
성공	200	성공	OK
실패	401	권한 없음	API 사용 권한이 없습니다
	403	비정상 접근	잘못된 요청입니다
	404	존재하지 않은 요청	존재하지 않은 요청입니다
	500	시스템 에러	테스트

신체 기본 정보 생성

설명

신체 기본 정보 생성 API 입니다.

요청 URL

HTTP 메서드	URL
POST	api.energyboostlab.com/body/info/

파라미터

파라미터	타입	필수여부	설명
user	string	Y	사용자번호
height	integer	Y	키
recode_date	string	Y	등록일(YYYY-MM-DD HH:MM:SS)

Request Example

POST /body/info/ HTTP/1.1
Host: api.energyboostlab.com
Content-Type: application/json
Authorization: Bearer {ACCESS_TOKEN}
{
    "user": 2,
    "height": 170,
    "recode_date": "2023-10-01 12:00:00"
}

Response Example

{
    "id": 1,
    "user": {
    ...
    },
    "update_date": "2023-10-18T00:13:26.310416",
    "create_date": "2023-10-18T00:13:26.310449",
    "gender": "male",
    "height": 170.0,
    "date_of_birth": "1990-01-01",
    "recode_date": "2023-09-26T20:14:17"
}

Return Code

구분	코드	내용	설명
성공	201	성공	OK
실패	401	권한 없음	API 사용 권한이 없습니다
	403	비정상 접근	잘못된 요청입니다
	404	존재하지 않은 요청	존재하지 않은 요청입니다
	500	시스템 에러	테스트

신체 기본 정보 수정

설명

신체 기본 정보 수정 API 입니다.

요청 URL

HTTP 메서드	URL
PUT	api.energyboostlab.com/body/info/{ID}/

파라미터

파라미터	타입	필수여부	설명
user	string	Y	사용자번호
height	integer	Y	키
recode_date	string	Y	등록일(YYYY-MM-DD HH:MM:SS)

Request Example

PUT /body/info/{ID}/ HTTP/1.1
Host: api.energyboostlab.com
Content-Type: application/json
Authorization: Bearer {ACCESS_TOKEN}
{
    "user": 2,
    "height": 170,
    "recode_date": "2023-10-02 06:00:00"
}

Response Example

{
    "id": 1,
    "user": {
        "id": 2,
        "email": "guest@energyboostlab.com",
        "name": "guest",
        "mobile": "01012345678",
        "date_of_birth": "1987-11-18",
        "gender": "MALE",
        "is_active": true,
        "is_staff": false,
        "is_admin": false,
        "is_superuser": false,
        "created_at": "2023-10-14T10:46:15.098731",
        "updated_at": "2023-10-14T10:46:15.505233",
        "last_login": "2023-10-14T10:46:15.515621",
        "groups": [],
        "user_permissions": []
    },
    "update_date": "2023-10-18T00:18:45.793671",
    "create_date": "2023-10-18T00:13:26.310449",
    "gender": "male",
    "height": 170.0,
    "date_of_birth": "1990-01-01",
    "recode_date": "2023-10-02T06:00:00"
}

Return Code

구분	코드	내용	설명
성공	200	성공	OK
실패	401	권한 없음	API 사용 권한이 없습니다
	403	비정상 접근	잘못된 요청입니다
	404	존재하지 않은 요청	존재하지 않은 요청입니다
	500	시스템 에러	테스트

신체 기본 정보 삭제

설명

신체 기본 정보 리스트 조회 API 입니다.

요청 URL

HTTP 메서드	URL
DELETE	api.energyboostlab.com/body/info/{ID}/

파라미터

파라미터	타입	필수여부	설명
테스트	테스트	Y	테스트

Request Example

DELETE /body/info/{ID}/ HTTP/1.1
Host: api.energyboostlab.com
Content-Type: application/json
Authorization: Bearer {ACCESS_TOKEN}
{}

Response Example

{}

Return Code

구분	코드	내용	설명
성공	204	성공	OK
실패	401	권한 없음	API 사용 권한이 없습니다
	403	비정상 접근	잘못된 요청입니다
	404	존재하지 않은 요청	존재하지 않은 요청입니다
	500	시스템 에러	테스트