그리팅 API는 다음과 같은 공통 응답 객체를 사용하여 결과 값을 제공합니다.
필드 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
success | Boolean |
| API 호출 실행 결과입니다.
|
data | Object |
| API 호출에 따른 결과값입니다. (API 호출 성공시 제공합니다) |
message | String |
| API 호출 결과에 따른 메시지 값입니다. |
errorCode | String |
| API 호출 오류 상황을 구분하는 코드입니다. (API 호출 실패시 제공합니다) |
요청한 정보가 페이지네이션 형태의 반환값을 제공할 경우 다음과 같은 공통 응답 객체를 사용하여 결과 값을 제공합니다.
필드 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
page | Integer |
| 요청한 페이지 번호입니다. |
pageSize | Integer |
| 요청한 페이지 당 데이터 갯수입니다. |
totalCount | Integer |
| 반환 가능한 데이터의 전체 갯수입니다. |
totalPage | Integer |
| 요청 가능한 최대 페이지 수입니다. |
hasPrev | Boolean |
| 이전 페이지가 존재하는지 여부입니다. |
hasNext | Boolean |
| 다음 페이지가 존재하는지 여부입니다. |
datas | List<Object> |
| 요청한 데이터입니다. |