통계조회
• DOI 등록 유형 중 지식재산권 종류별 이용 건수를 조회하는 API.
• 이용 통계는 파라미터 groupBy 값에 따라 연도별(Y), 월별(M), 일별(D)로 합산된 결과가 제공됨.
• 이용 통계는 전월을 기준으로 산출되어 제공됨.
• 이용 통계는 요청 파라미터에 포함된 ID와 Prefix로 등록된 DOI에 대해서만 조회 가능.
|
이름 |
의미 |
설명 |
필수 |
기본값 |
|---|---|---|---|---|
|
id |
로그인ID |
DOI등록관리시스템 로그인 ID |
Y |
- |
|
key |
API 키 |
등록기관별로 발급된 API key로, DOI등록관리시스템에 로그인 한 후 자신의 정보 페이지에서 조회 |
Y |
- |
|
prefix |
조회대상 DOI접두사 |
없으면 요청한 등록기관에게 할당된 Prefix에 한해 조회 |
N |
- |
|
type |
권리구분 |
없으면 모든 권리구분 조회 |
N |
현재 미적용 |
|
Date |
조회범위 시작일자 |
yyyymmdd 형식 |
N |
이전달 첫일 20170901 |
|
endDate |
조회범위 끝일자 |
yyyymmdd 형식 |
N |
이전달 말일 20170930 |
|
groupBy |
집계 단위 기간 |
• Y: 연도별 건수 • M: 연월별 건수 • D: 일별 건수 |
N |
M 일별 조회시 최대 92일간까지 가능 |
• Content-Type: text/xml: charset=utf8
• 형식
|
태그 |
반복 |
값 |
설명 |
|
|---|---|---|---|---|
|
reponse |
1 |
|
|
|
|
@version |
1 |
버전 |
“1”로 고정 |
|
|
summary |
1 |
|
|
|
|
result |
1 |
• SUCCESS: 성공 • FAIL: 오류 |
|
|
|
message |
0..1 |
메시지 |
|
|
|
query |
1 |
사용된 파라미터 값 |
요청된 값과 다를 수도 있다 |
|
|
prefix |
1 |
조회대상 DOI접두사 |
|
|
|
type |
1 |
권리구분 |
|
|
|
Date |
1 |
조회범위 시작일자 |
|
|
|
endDate |
1 |
조회범위 끝일자 |
|
|
|
groupBy |
1 |
집계 단위 기간 |
|
|
|
records |
0..1 |
조회 결과 통계 목록 |
|
|
|
record |
0..1 |
조회 결과 통계 |
|
|
|
type |
1 |
권리구분 |
|
|
|
year |
1 |
연도 |
|
|
|
month |
월 |
1 |
연별 집계일 때는 값이 없다 |
|
|
day |
1 |
일 |
연별, 월별 집계일 때는 값이 없다 |
|
|
count |
1 |
이용 건수 |
|
|
[성공시]
[실패시]
