다양한 형식의 응답 값

Response의 data Object 내부의 파일, Enum 등 공통으로 표현되는 응답 값에 대해서 정의합니다.

파일 Response

응답 중에 파일과 관련된 항목이 있다면 다음과 같은 응답 형식을 갖습니다.

Response Description

Name	Type	Nullable	Description
fileId	Integer		파일 ID
originFileName	String		원본 파일명
url	String		파일 URL
sortNum	Integer		순번
keyword	String		파일 키워드

Response Sample

Sample 1 - File

{
	"fileId": 19,
	"originFileName": "그림1.png",
	"url": "https://cruisia-v2-static.s3.ap-northeast-2.amazonaws.com/upload-cruisia-ship/34b28561-673a-4129-8a36-836c080a3771.png",
	"sortNum": 0
}

---

Enum Response

응답 중에 Enum의 경우 다음과 같은 응답 형식을 갖습니다.

Response Description

Name	Type	Nullable	Description
code	String		enum name 값 OTA Api에서 Object로 enum을 주고 받을 때 code 값을 사용한다.
title	String		enum 설명

Response Sample

Sample 1 - Currency List

{
	"code": "USD",
	"title": "$"
},
{
	"code": "EUR",
	"title": "€"
},
{
	"code": "KRW",
	"title": "₩"
}

Sample 2 - 여행 기간 리스트

{
	"code": "ONE_FOUR",
	"title": "1 ~ 4일"
},
{
	"code": "FIVE_EIGHT",
	"title": "5 ~ 8일"
},
{
	"code": "NINE_FOURTEEN",
	"title": "9 ~ 14일"
},
{
	"code": "MORE_THAN",
	"title": "15일 이상"
}

상기 예시 외에 code, title로 구성된 Object의 경우 서버 사이드 구현시 getCode(), getTitle()로 구성된 Interface 사용 권장