약관 조회

약관을 조회한다.

약관 조회 API는 GET 메소드로 호출되며, 상세 스펙 및 호출 예제는 아래와 같습니다.

요청메시지 URL
요청메시지 URL 표
HTTP URL/api/oris/v1/terms
HTTP MethodGET
요청 메시지 명세
요청 메시지 명세
HTTP항목TYPE(길이)필수값설명
Parameter[inquery] termTypestring(50)N개인정보수집이용약관 유형 이름
응답 메시지 명세
요청 메시지 명세
HTTP항목TYPE(길이)필수값설명
Bodyid

string(26)

Y

01JPPEG5B48T1JFNJ895GHJZRZ

약관 ID
type

object

Y

-

약관 유형 응답
type.name

string(50)

Y

ORIS 이용약관

약관 유형 이름
type.targetType

string("USER" | "AGENCY" | "MEMBER" | "ADMIN")

Y

USER

약관 대상 유형
type.isRequired

boolean

Y

true

약관 필수 여부
type.isActive

boolean

Y

true

약관 활성화 여부
type.description

string(300)

N

ORIS 이용약관에 대한 설명입니다.

약관 설명
version

string(12)

Y

V2023100101

약관 버전
contents[]

array<object>

Y

-

약관 내용
contents[].locale

string("KO_KR" | "EN_US" | "JA_JP" | "ZH_CN")

Y

KO_KR

약관 내용 언어 코드
contents[].title

string(200)

Y

ORIS 이용약관

약관 제목
contents[].content

string(10000)

Y

ORIS 이용약관에 대한 내용입니다.

약관 내용(DB : TEXT)
contents[].htmlContent

string(10000)

Y

<p>ORIS 이용약관에 대한 내용입니다.</p>

약관 HTML 내용(DB : TEXT)
initiatedAt

string(date-time)

N

-

약관 게시일(적용 시작 일시)
createdAt

string(date-time)

N

-

약관 생성일시
modifiedAt

string(date-time)

N

-

약관 수정일시
응답 메시지 형태
[
  {
    "id": "01JPPEG5B48T1JFNJ895GHJZRZ",
    "type": {
      "name": "ORIS 이용약관",
      "targetType": "USER",
      "isRequired": true,
      "isActive": true,
      "description": "ORIS 이용약관에 대한 설명입니다."
    },
    "version": "V2023100101",
    "contents": [
      {
        "locale": "KO_KR",
        "title": "ORIS 이용약관",
        "content": "ORIS 이용약관에 대한 내용입니다.",
        "htmlContent": "<p>ORIS 이용약관에 대한 내용입니다.</p>"
      }
    ],
    "initiatedAt": "string",
    "createdAt": "string",
    "modifiedAt": "string"
  }
]
에러인 경우 응답 메시지 명세
요청 메시지 명세
HTTP항목TYPE(길이)필수값설명
Bodymessage

string

N

요청에 실패했습니다.

오류 메시지
code

string("ERROR" | "BAD_REQUEST" | "INVALID_REQUEST" | "UNAUTHORIZED" | "FORBIDDEN" | "ACCESS_TOKEN_REQUIRED" | "ACCESS_TOKEN_EXPIRED" | "ACCESS_TOKEN_INVALID" | "ACCESS_TOKEN_NOT_ENOUGH_PERMISSION" | "AGENCY_NOT_FOUND" | "AGENCY_NOT_ACTIVE" | "AGENCY_NOT_APPROVED" | "AGENCY_NOT_MATCH" | "AGENCY_ACCESS_DENIED" | "AGENCY_CODE_DUPLICATED" | "MEMBER_NOT_FOUND" | "MEMBER_NOT_ACTIVE" | "MEMBER_NOT_MATCH" | "MEMBER_PASSWORD_NOT_MATCH" | "MEMBER_EMAIL_DUPLICATED" | "MEMBER_PASSWORD_RESET" | "MEMBER_PASSWORD_RESET_WITH_OLD" | "MEMBER_PASSWORD_INVALID_FORMAT" | "MEMBER_PASSWORD_FAIL_LIMIT_EXCEEDED" | "MEMBER_PASSWORD_EXPIRED" | "MEMBER_ACCOUNT_LOCKED" | "MEMBER_PASSWORD_REUSED" | "MEMBER_ACCESS_DENIED" | "API_KEY_NOT_FOUND" | "USER_NOT_FOUND" | "USER_NOT_ACTIVE" | "ACCOUNT_NOT_FOUND" | "REMITTANCE_NOT_FOUND" | "REMITTANCE_ALREADY_EXISTS" | "REMITTANCE_ALREADY_CANCELED" | "REMITTANCE_ACCOUNT_YEAR_MISMATCH" | "THREAD_NOT_FOUND" | "THREAD_ACCESS_DENIED" | "POST_NOT_FOUND" | "POST_ACCESS_DENIED" | "COMMENT_NOT_FOUND" | "COMMENT_ACCESS_DENIED" | "FILE_NOT_FOUND" | "FILE_ACCESS_DENIED" | "FILE_ALREADY_ATTACHED" | "FILE_DELETE_FAILED" | "TERM_NOT_FOUND" | "TERM_CANNOT_UPDATE" | "TERM_CANNOT_DELETE" | "TERM_CANNOT_SET_INITIATION_DATE" | "TERM_CANNOT_WITHDRAW_INITIATION_DATE" | "TERM_TYPE_NOT_FOUND" | "CONSENT_REQUIRED" | "CONSENT_NOT_FOUND" | "CONSENT_NOT_MATCH" | "GROUP_NOT_FOUND" | "GROUP_UPDATE_FORBIDDEN" | "GROUP_DELETE_FORBIDDEN" | "BATCH_NOT_FOUND" | "BATCH_CHUNK_NOT_FOUND")

N

ERROR

오류 코드
요청값이 제약 조건에 위반되는 경우 응답 메시지 형태(400)
{
  "code": "BAD_REQUEST",
  "message": "Failed to convert value of type 'java.lang.String' to required type 'java.lang.Boolean'"
}
메소드 인자 타입이 일치하지 않는 경우 응답 메시지 형태(400)
{
  "code": "BAD_REQUEST",
  "message": "Failed to convert value of type 'java.lang.String' to required type 'java.lang.Boolean'"
}
메소드 인자 검증 실패한 경우 응답 메시지 형태(400)
{
  "code": "BAD_REQUEST",
  "message": "Validation failed for argument at index 0 in method"
}
json 형식이 잘못된 경우 응답 메시지 형태(400)
{
  "code": "BAD_REQUEST",
  "message": "Malformed JSON request"
}
요청값이 잘못된 경우 응답 메시지 형태(400)
{
  "code": "BAD_REQUEST",
  "message": "Invalid argument"
}
요청한 URL에 맞는 핸들러를 찾을 수 없는 경우 응답 메시지 형태(404)
{
  "code": "BAD_REQUEST",
  "message": "No handler found for the request"
}
서버 에러인 경우 응답 메시지 형태(500)
{
  "code": "ERROR",
  "message": "Internal server error. Please try again later."
}