개요
다우오피스 OpenAPI 서비스의 부서원 정보 조회 연동을 위한 <부서원 정보 조회 API> 입니다. 부서원 정보 조회 시 회사 내 전체 부서원 정보가 전달됩니다.
Request URL
https://api.daouoffice.com/public/v1/dept/member
※ 다우오피스 OpenAPI 서비스는 DOAS 서버로 API 호출을 진행하기 때문에 별도 고객사 그룹웨어 URL이 아닌 “https://api.daouoffice.com”을 사용합니다.
HTTP Method
POST (Content-Type: application/json; charset=UTF-8)
Request Parameters
| 변수 (Parameter) |
타입(Type) | 필수 여부 |
사전 발급 |
설명 (Description) |
|---|---|---|---|---|
| clientId | String | Y | Y | 고객사 식별/인증을 위한 서비스 인증ID / Client ID ※ <인증키 발급 API>를 통해 전달받은 값 |
| clientSecret | String | Y | Y | 고객사 식별/인증을 위한 서비스 보안KEY / Secret Key ※ <인증키 발급 API>를 통해 전달받은 값 |
| productName | String | N | N | 업무시스템 제품명(제휴시스템 사용할 경우 입력) |
| productVersion | String | N | N | 업무시스템 제품버전(제휴시스템 사용할 경우 입력) |
| clientCompanyName | String | N | N | 업무시스템 고객사 식별정보(제휴시스템 사용할 경우 입력) |
※ productName, productVersion, clientCompanyName은 외부업무시스템의 정보를 전달받아 문제 발생 시 다우기술에서 로그 확인을 위해 필요한 사항입니다. 필수 입력값은 아니므로 초기 개발 시 비워두고 정식 사용 시 값을 입력하는 것을 권장합니다.
Request Example
POST /public/v1/dept/member HTTP/1.1
api.daouoffice.com
Content-Type: application/json
{
"clientId": "f255cbe0b4a9d12f",
"clientSecret": "bafdd7b4cff6fabdc417b8a6b0e4fff6",
"productName" : "DSoft BIS",
"productVersion" : "3.1.21",
"clientCompanyName" : "ddgs11231#1122"
}
Response Parameters
| 변수 (Parameter) |
타입 (Type) |
필수 여부 |
사전 발급 |
설명 (Description) |
|---|---|---|---|---|
| code | String | Y | N | API 호출결과 코드 |
| message | String | Y | N | API 호출결과 메시지 |
| messageDetail | String | N | N | API 호출결과 상세내용 (실패한 경우만 리턴함) |
| data | Object | Y | N | API 호출결과 상세내용 JSON Object 배열 |
- data
| 변수 (Parameter) |
타입(Type) | 필수 여부 |
사전 발급 |
설명 (Description) |
|---|---|---|---|---|
| loginId | String | Y | N | 로그인 아이디 |
| employeeNumber | String | N | N | 사번 |
| userName | String | Y | N | 계정 이름 |
| orgCode | String | Y | N | 부서 코드 |
| orgName | String | Y | N | 부서 이름 |
| dutyCode | String | N | N | 부서 직책 코드 |
| dutyName | String | N | N | 부서 직책 이름 |
| memberType | String | N | N | 멤버 타입 ※ 부서장 MASTER / 부부서장 MODERATOR / 부서원 MEMBER(default) |
Response Example
Content-Type: application/json;charset=UTF-8
{
"code": "200",
"message": "OK",
"data": [
{ 내용생략 … }
]
}
Return Code
| 구분 | 코드 (Code) |
내용 (Message) |
설명 (Description) |
|---|---|---|---|
| 성공 (Success) |
200 | 성공 | OK |
| 실패 (Error) |
901 | 유효하지 않은 client ID | client ID를 확인하세요. |
| 902 | 유효하지 않은 client Secret | client Secret을 확인하세요. | |
| 955 | 도메인 코드 오류 | 'XXXX'는 존재하지 않는 도메인 코드입니다. |
제약 사항
| 구분 | 누적 호출 제한 횟수 | 비고 |
|---|---|---|
| 월간 | 900회 | - |
제공 서비스 유형
| 구분 | 제공 여부 |
|---|---|
| 다우오피스 단독형 | 제공 |
| 다우오피스 설치형 | 제공 |
| 다우오피스 구축형 | 제공 |
| 다우오피스 공유형 | 미제공 |