Skip to main content

인증서 다건조회

다건 조회 (GET)

인증서 목록을 조회합니다.

  • Method: GET

  • URL: /achievements

  • Query Parameters:

    파라미터타입필수설명
    pagenumberNo조회할 페이지 번호 (기본: 1)
    pageSizenumberNo페이지 당 항목 수 (기본: 15)
    searchstringNo사용자 이름, 이메일, 인증서 폼 이름 대상 검색어
    startDatestring (ISO8601)No조회 시작일
    endDatestring (ISO8601)No조회 종료일

Response

{
"statusCode": 200,
"message": "인증서 목록이 조회되었습니다.",
"achievements": [인증서 데이터 객체],
"totalPages": 1
}

achievements (object[])

필드명타입설명
idnumber인증서의 고유 ID
certificate_numberstring인증서 고유 번호
expiration_datestring | null (ISO8601)인증서 만료일 (없다면 영구 유효)
is_receivedboolean사용자가 인증서를 수령했는지 여부
issuance_method"EMAIL" | "PHONE"발급 방식
created_atstring (ISO8601)인증서 발급일
updated_atstring (ISO8601)인증서 마지막 수정일
useruser (object)유저정보
achievementFormachievementForm (object)인증서 양식 정보

achievement.user (object)

필드명타입설명
emailstring사용자 이메일
namestring사용자 이름
avatarstring[]아바타 이미지 URL 배열
deleted_atstring | null계정 삭제 날짜 (null이면 가입 완료된 상태)
imagestring | null프로필 이미지 URL (직접 업로드한 이미지)
profileImageType"avatar" | "profile"프로필 이미지 타입

achievement.achievementForm (object[])

필드명타입설명
idnumber인증서 양식의 고유 ID
namestring인증서 제목
achievementBadgeDesignachievementBadgeDesign (object)

achievement.achievementForm.achievementBadgeDesign (object)

필드명타입설명
idnumberbadge 디자인의 고유 ID
namestring디자인 이름
main_colorstring | null메인 색상
sub_colorstring | null서브 색상
extra_color_1string | null보조 색상1
extra_color_2string | null보조 색상2
layout_jsonobject[]인증서 이미지 생성을 위한 디자인 JSON 배열
template_typestring사용된 템플릿 종류
created_atstring (ISO8601)디자인 생성일
updated_atstring (ISO8601)디자인 수정일

오류 코드

상태 코드에러메시지상세 설명
400BadRequestPage must be a positive number페이지 번호가 양의 정수가 아닌 경우
400BadRequestPage must not be less than 1페이지 번호가 1보다 작을 경우
400BadRequestPageSize must be a positive number페이즈 사이즈가 양의 정수가 아닌 경우
400BadRequestPageSize must not be less than 1페이지 사이즈가 1보다 작을 경우
400BadRequestPage size cannot exceed 15페이지 사이즈가 15를 초과했을 경우
400InvalidDateFormatstartDate이 유효한 날짜 형식이 아닙니다. (예: YYYY-MM-DD)날짜 타입이 올바르지 않은 경우
401UnauthorizedInvalid token인증 정보가 올바르지 않은 경우
404AchievementsNotFound해당 인증서를 찾을 수 없습니다.인증서 목록 조회에 실패했을 경우
500InternalServerError예기치 않은 오류가 발생했습니다.서버 에러

Request Sample

String url = "https://${baseURL}/open-api/achievements";

HttpResponse<String> response = Unirest.get(url + queryParams)
.header("Content-Type", "application/json")
.header("Accept", "application/json")
.header("Authorization", "Bearer " + apiKey)
.asString();

System.out.println("Status: " + response.getStatus());
System.out.println("Response: " + response.getBody());