id , 검색어(query)로 모델을 조회 합니다.
모델명에 특정 키워드가 포함되는 모델 정보를 조회할 수 있습니다.
참고사항
기본조건인 모델명 일치 조건 modelNameMatch 가 true 인 경우 전체 모델명 일치하는 결과 있을 경우에만 성공으로 응답됩니다.
modelNameMatch 가 false 인 경우 검색어 조회 결과 목록을 조회합니다. 하지만 모호한 검색어로 모델명 조회시 error가 발생합니다.
요청
GET /v1/gift/models/search?page={pageNo}&size={size}&id={id}&query={query}
&modelNameMatch={modelNameMatch}
<요청 파라미터 설명>
필드명 | 타입 | 필수여부 | 설명 |
id | int | 선택 | 모델 아이디 |
query | String | 선택 | 검색어 |
page | int | 필수 | 페이지 번호 (default : 0) |
size | int | 필수 | 사이즈 ( default : 20) |
modelNameMatch | int | 선택 | 모델명 전체 일치 여부 (default : true) |
응답
요청이 성공하면 응답 바디에 모델 목록이 조회 된다.
조회 조건에 해당하지 않는 경우 빈 contents 에 빈 목록이 조회 됩니다.
<응답 바디>
필드명 | 타입 | 설명 |
totalCount | String | 전체 수 |
contents | Array |
모델 목록 id: 모델ID modelName: 모델명 manufacturer: 제조사명 |
<응답 바디 샘플>
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
{
"totalCount": 3,
"contents": [
{
"id": "A5096288585",
"modelName": "플라잉전신키링 라이언 [FRPBRYFBK0001]",
"manufacturer": "카카오프렌즈"
},
{
"id": "D5096602055",
"modelName": "카카오리틀프랜즈 2단 스텐 가방 도시락 라이언",
"manufacturer": "카카오프렌즈"
},
{
"id": "C5092909891",
"modelName": "라이언 FRPBRYHMD8001",
"manufacturer": "카카오프렌즈"
}
]
}