> For the complete documentation index, see [llms.txt](https://malgn.gitbook.io/cloud/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://malgn.gitbook.io/cloud/api/get-learner-info.md).

# 수강생 정보 조회

> **문서 정보**
>
> * **버전:** 1.4
> * **작성일:** 2024.04.01

***

### 1. 소개

맑은소프트 범용 클라우드 LMS를 이용하여 학습을 진행한 수강생의 정보를 검색 및 출력하는 API입니다.

***

### 2. API 연결 스펙

<table><thead><tr><th width="164">구분</th><th width="318">정보</th></tr></thead><tbody><tr><td><strong>URL</strong></td><td><code>[domain]/api/course_user_api.jsp</code></td></tr><tr><td><strong>Method</strong></td><td><code>POST</code> 또는 <code>GET</code></td></tr><tr><td><strong>Response Type</strong></td><td><code>application/json</code> 또는 <code>text/xml</code></td></tr><tr><td><strong>Encoding</strong></td><td><code>UTF-8</code></td></tr></tbody></table>

***

### 3. Request Parameters (요청 변수)

<table><thead><tr><th width="112">파라미터</th><th width="85" align="center">필수</th><th width="128">포맷</th><th>정의</th></tr></thead><tbody><tr><td><strong>token</strong></td><td align="center"><strong>Y</strong></td><td>string</td><td>API 엑세스 토큰을 지정합니다.</td></tr><tr><td><strong>sdate</strong></td><td align="center"><strong>Y</strong></td><td>YYYYMMDD</td><td>수강 등록일의 검색 범위 시작일</td></tr><tr><td><strong>edate</strong></td><td align="center"><strong>Y</strong></td><td>YYYYMMDD</td><td>수강 등록일의 검색 범위 종료일</td></tr><tr><td><strong>cid</strong></td><td align="center">N</td><td>integer</td><td>과정아이디를 지정합니다. <br>(지정하지 않으면 모든 과정 검색)</td></tr><tr><td><strong>uid</strong></td><td align="center">N</td><td>integer</td><td>회원아이디를 지정합니다. <br>(지정하지 않으면 모든 회원 검색)</td></tr><tr><td><strong>complete</strong></td><td align="center">N</td><td>Y or N</td><td>과정 수료상태를 지정합니다. <br>(지정 시, 수료처리하지 않은 수강생은 제외)</td></tr><tr><td><strong>status</strong></td><td align="center">N</td><td>string</td><td>수강생의 상태를 지정합니다. <br>(지정하지 않으면 모든 수강생 검색)<br><br><strong>[지정 가능 값]</strong><br>• <code>1</code> : 정상<br>• <code>0</code> : 승인대기<br>• <code>2</code> : 입금대기<br>• <code>3</code> : 취소요청<br>• <code>-4</code> : 취소승인</td></tr><tr><td><strong>format</strong></td><td align="center">N</td><td>json or xml</td><td>출력 형식을 지정합니다. <br>(지정하지 않으면 기본 <code>json</code> 출력)</td></tr><tr><td><strong>login_id</strong></td><td align="center">N</td><td>string</td><td>로그인아이디를 지정합니다. <br>(지정하지 않으면 모든 회원 검색)</td></tr></tbody></table>

***

### 4. Response (응답 구조)

#### 공통 응답 필드

<table data-search="true"><thead><tr><th width="152">값</th><th width="163">포맷</th><th width="348">정의</th></tr></thead><tbody><tr><td><strong>ret_code</strong></td><td>string</td><td>호출 결과 코드</td></tr><tr><td><strong>ret_msg</strong></td><td>string</td><td>호출 결과 메시지</td></tr><tr><td><strong>ret_size</strong></td><td>integer</td><td>응답 데이터의 개수</td></tr><tr><td><strong>ret_data</strong></td><td>array</td><td>응답 데이터 배열 (수강생 상세 목록)</td></tr></tbody></table>

#### ret\_data 상세 필드 (수강생 상세 정보)

<table><thead><tr><th width="150">값</th><th width="167">포맷</th><th>정의</th></tr></thead><tbody><tr><td><strong>__ord</strong></td><td>integer</td><td>데이터 순번</td></tr><tr><td><strong>first</strong></td><td>boolean</td><td>첫 번째 데이터 여부 (<code>true</code> / <code>false</code>)</td></tr><tr><td><strong>last</strong></td><td>boolean</td><td>마지막 데이터 여부 (<code>true</code> / <code>false</code>)</td></tr><tr><td><strong>id</strong></td><td>integer</td><td>수강생아이디</td></tr><tr><td><strong>course_id</strong></td><td>integer</td><td>과정아이디</td></tr><tr><td><strong>year</strong></td><td>integer</td><td>과정년도</td></tr><tr><td><strong>step</strong></td><td>integer</td><td>과정기수</td></tr><tr><td><strong>course_nm</strong></td><td>string</td><td>과정명</td></tr><tr><td><strong>user_id</strong></td><td>integer</td><td>회원아이디</td></tr><tr><td><strong>login_id</strong></td><td>string</td><td>로그인아이디</td></tr><tr><td><strong>user_nm</strong></td><td>string</td><td>회원명</td></tr><tr><td><strong>email</strong></td><td>string</td><td>이메일</td></tr><tr><td><strong>start_date</strong></td><td>YYYYMMDD</td><td>학습시작일</td></tr><tr><td><strong>end_date</strong></td><td>YYYYMMDD</td><td>학습종료일</td></tr><tr><td><strong>credit</strong></td><td>integer</td><td>수강생 인정학점 (수강생 등록 당시 과정설정 기준)</td></tr><tr><td><strong>course_credit</strong></td><td>integer</td><td>과정 인정학점 (현재 과정설정 기준)</td></tr><tr><td><strong>total_score</strong></td><td>integer</td><td>총점</td></tr><tr><td><strong>progress_ratio</strong></td><td>double</td><td>진도율</td></tr><tr><td><strong>complete_yn</strong></td><td>Y or N</td><td>수료상태</td></tr><tr><td><strong>complete_no</strong></td><td>string</td><td>수료번호 (과정년도-과정기수-수강생아이디)</td></tr><tr><td><strong>complete_date</strong></td><td>YYYYMMDD</td><td>수료일</td></tr><tr><td><strong>status</strong></td><td>string</td><td>수강생 상태</td></tr></tbody></table>

***

### 5. 응답 예시 (JSON Example)

```json
{
  "ret_code": "000",
  "ret_msg": "success",
  "ret_size": 1,
  "ret_data": [
    {
      "__ord": 1,
      "first": true,
      "last": true,
      "id": 12345,
      "course_id": 999,
      "year": 2024,
      "step": 1,
      "course_nm": "맑은소프트 범용 클라우드 LMS 활용 과정",
      "user_id": 54321,
      "login_id": "malgn_user",
      "user_nm": "홍길동",
      "email": "gildong@malgnsoft.com",
      "start_date": "20240401",
      "end_date": "20240430",
      "credit": 3,
      "course_credit": 3,
      "total_score": 95,
      "progress_ratio": 100.0,
      "complete_yn": "Y",
      "complete_no": "2024-1-12345",
      "complete_date": "20240430",
      "status": "1"
    }
  ]
}
```
