사원
- 인쇄
- PDF
사원
- 인쇄
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
설명
파트너사에 연결된 고객사의 사원 목록을 조회한다.
사원 목록 조회 API
사원 목록을 조회한다.
요청 URL
GET https://workplace.apigw.ntruss.com/partner/apigw/v2/partner/{partnerId}/company/{companyId}/employee
요청 헤더
Header | Description |
---|---|
x-ncp-apigw-timestamp | - 1970년 1월 1일 00:00:00 협정 세계시(UTC)부터의 경과 시간을 밀리초(Millisecond)로 표현 - API Gateway 서버와 시간 차가 5분 이상 나는 경우 유효하지 않은 요청으로 간주 |
x-ncp-iam-access-key | - 네이버 클라우드 플랫폼 포털 또는 Sub Account에서 발급받은 Access Key ID |
x-ncp-apigw-signature-v2 | - 위 예제의 Body를 Access Key ID와 맵핑되는 Secret Key로 암호화한 서명 - HMAC 암호화 알고리즘은 HmacSHA256 사용 |
요청 Path 파라미터
파라미터 | 타입 | 크기 | 필수 여부 | 설명 |
---|---|---|---|---|
partnerId | String | 15 | Y | WORKPLACE에서 제공한 파트너 ID |
companyId | String | 36 | Y | 조회할 고객사의 연동키(CompanyId) Developers > 기본 설정 > 연동키 |
요청 파라미터
파라미터 | 타입 | 크기 | 필수 여부 | 설명 |
---|---|---|---|---|
offset | long | N | offset row부터 출력 | |
limit | long | N | limit 개수만큼 출력 |
요청 Body 파라미터
파라미터 | 타입 | 크기 | 필수 여부 | 설명 |
---|---|---|---|---|
loginId | String | 100 | Y | 로그인 아이디 |
emailAddress | String | 100 | Y | 이메일 주소 |
employYmd | String | 10 | Y | 입사일(yyyy-MM-dd) |
telephoneNo | String | 30 | N | 전화번호 |
cellphoneNo | String | 100 | N | 휴대폰 번호 |
empId | String | 36 | Y | WORKPLACE 사원키 |
deptNo | String | 36 | Y | WORKPLACE 소속 부서키 |
birthYmd | String | 30 | N | 생년월일(yyyy-MM-dd) |
genderCd | String | 30 | N | 성별(MALE, FEMALE) |
empNick | String | 100 | N | 닉네임 특수 문자 중 ! @ & ( ) - _ + [ ] { } , . 만 허용 |
localeTypeCd | String | N | 로케일정보 | |
tmznTypeCd | String | N | 타임존정보 | |
zipCode | String | 10 | N | 우편번호 |
address | String | 100 | N | 주소 |
addressDetail | String | 100 | N | 상세 주소 |
name | String | 100 | Y | 기본 이름 |
i18nNames | Map | N | 이름 다국어 Map<Locale, String> i18nNames | |
deptExternalKey | String | 100 | Y | 부서 외부키 |
concurrentDeptExternalKeys | array | Y | 겸직 부서 외부키 | |
empTypeExternalKey | String | 100 | Y | 고용 형태 외부키 |
gradeCdExternalKey | String | 100 | N | 직급 외부키 |
jobCdExternalKey | String | 100 | N | 직책 외부키 |
empStatus | String | 30 | N | 사원상태정보 |
passwordSettingType | String | 10 | Y | 비밀번호 설정 타입(ADMIN/USER) |
initializePassword | String | 100 | Y | ADMIN: 초기 비밀번호 / USER: 초대메일 받을 이메일 주소 |
요청 예시
GET https://workplace.apigw.ntruss.com/partner/apigw/v2/partner/partnertest/company/1663a976-32c9-48a4-8edb-f1ffcefb1bf3/employee?offset=0&limit=10
GET
/partner/apigw/v2/partner/partnertest/company/1663a976-32c9-48a4-8edb-f1ffcefb1bf3/employee?offset=0&limit=10
HOST: workplace.apigw.ntruss.com
Content-Type: application/json
x-ncp-apigw-timestamp: 1505290625682
x-ncp-apigw-api-key: DUxjP4HYTP8V7khBkgywdDHQjKuaYWGrppHKpvdv
x-ncp-iam-access-key: D78BB444D6D3C84CA38A
x-ncp-apigw-signature-v2: WTPItrmMIfLUk/UyUIyoQbA/z5hq9o3G8eQMolUzTEo=
응답 예시
HTTP/1.1 200 OK
Server: nginx
Date: Wed, 23 Feb 2022 05:17:06 GMT
Content-Type: application/json;charset=utf-8
Transfer-Encoding: chunked
Connection: keep-alive
Access-Control-Allow-Origin: *
x-ncp-trace-id: 68d1o68pm4cr63gc3169gm4p34
{
"elements": [
{
"tenantId": "1663a976-32c9-48a4-8edb-f1ffcefb1bf3",
"companyId": "1663a976-32c9-48a4-8edb-f1ffcefb1bf3",
"externalKey": null,
"name": "박사원",
"i18nNames": {},
"employYmd": "",
"loginId": "testuser@sample.com",
"emailAddress": "testuser@sample.com",
"telephoneNo": "",
"cellphoneNo": "",
"empNo": null,
"empId": "81aaa126-655d-2123-5903-94e95386e866",
"deptNo": "partner-test202202000001",
"nationCd": "",
"residentRegistrationNumber": "",
"genderCd": "",
"birthYmd": "",
"zipCode": "",
"address": "",
"addressDetail": "",
"deptExternalKey": null,
"gradeCdExternalKey": "",
"jobCdExternalKey": "",
"empTypeExternalKey": "",
"empStatus" "IN",
"concurrentDeptExternalKeys": [],
"reportsToExternalKey": []
},
{
"tenantId": "1663a976-32c9-48a4-8edb-f1ffcefb1bf3",
"companyId": "1663a976-32c9-48a4-8edb-f1ffcefb1bf3",
"externalKey": null,
"name": "관리자",
"i18nNames": {},
"employYmd": "",
"loginId": "admin@sample.com",
"emailAddress": "admin@sample.com",
"telephoneNo": "",
"cellphoneNo": "01012341234",
"empNo": null,
"empId": "41bc321a-a6d2-4b57-8f71-b7602993be84",
"deptNo": "1663a976-32c9-48a4-8edb-f1ffcefb1bf3",
"nationCd": "",
"residentRegistrationNumber": "",
"genderCd": "",
"birthYmd": "",
"zipCode": "",
"address": "",
"addressDetail": "",
"deptExternalKey": null,
"gradeCdExternalKey": "",
"jobCdExternalKey": "",
"empTypeExternalKey": "",
"empStatus" "RETIRE",
"concurrentDeptExternalKeys": [],
"reportsToExternalKey": []
}
],
"totalCount": 2
}
응답
HTTP 상태 코드로 리턴되고, Body 정보로 전달한다.
HTTP 상태 코드 | 응답메시지 | 설명 |
---|---|---|
200 | OK | 일반적인 요청 성공 |
201 | Created | 리소스 생성 성공에 대한 응답 코드 |
400 | Bad Request | 일반적인 요청 실패에 사용 |
500 | Internal Server Error | - 일반적인 서버 오류에 대한 응답 코드 - 4XX대의 오류 코드가 클라이언트 측 오류를 나타내기 위해 사용됨 - 5XX대의 오류 코드는 서버 측 오류를 나타내기 위해 사용됨 |
응답 예시
{
"status": 400,
"code": -4001,
"errors": [],
"message": "This is a duplicate login ID"
}
지원하는 언어 코드
locale 코드 | 설명 |
---|---|
ko_KR | 한국어 |
ja_JP | 일본어 |
zh_CN | 중국어(간체) |
zh_TW | 중국어(번체) |
en_US | 영어 |
타임존 코드
timeZone 코드 | 설명 |
---|---|
Pacific/Midway | GMT-11:00(MidwayIsland, Samoa) |
Pacific/Honolulu | GMT-10:00(Hawaii) |
Pacific/Marquesas | GMT-09:30(Marquesas) |
America/Anchorage | GMT-09:00(Alaska) |
America/Los_Angeles | GMT-08:00(PacificTime) |
America/Denver | GMT-07:00(MountainTime_US/Canada) |
America/Chicago | GMT-06:00(CentralTime_US/Canada) |
America/New_York | GMT-05:00(EasternTime_US/Canada) |
America/Caracas | GMT-04:30(Caracas) |
America/Santiago | GMT-04:00(Santiago) |
America/St_Johns | GMT-03:30(Newfoundland) |
America/Sao_Paulo | GMT-03:00(SaoPaulo) |
America/Noronha | GMT-02:00(Mid-Atlantic) |
Atlantic/Azores | GMT-01:00(Azores) |
Europe/London | GMT+00:00(GreenwichMeanTime_London) |
Europe/Berlin | GMT+01:00(Amsterdam,Berlin, Vienna) |
Europe/Athens | GMT+02:00(Athens, Cairo) |
Asia/Baghdad | GMT+03:00(Moscow, Baghdad) |
Asia/Tehran | GMT+03:30(Tehran) |
Asia/Baku | GMT+04:00(Baku, Muscat) |
Asia/Karachi | GMT+05:00(Karachi) |
Asia/Colombo | GMT+05:30(NewDelhi,Mumbai, Colombo) |
Asia/Katmandu | GMT+05:45(Katmandu) |
Asia/Dhaka | GMT+06:00(Astana, Dhaka) |
Asia/Rangoon | GMT+06:30(Rangoon) |
Asia/Bangkok | GMT+07:00(Bangkok, Hanoi,Jakarta) |
Asia/Shanghai | GMT+08:00(Beijing,Dalian, Singapore, Taiwan) |
Asia/Seoul | GMT+09:00(Seoul) |
Asia/Tokyo | GMT+09:00(Tokyo, Fukuoka) |
Australia/Darwin | GMT+09:30(Darwin,Adelaide) |
Australia/Sydney | GMT+10:00(Guam,Canberra, Sydney) |
Australia/Lord_Howe | GMT+10:30(LordHoweIsland) |
Pacific/Noumea | GMT+11:00(NewCaledonia) |
Pacific/Norfolk | GMT+11:30(NorfolkIsland) |
Pacific/Auckland | GMT+12:00(Auckland,Fiji) |
사원상태 코드
사원상태 코드 | 설명 |
---|---|
IN | 재직 |
REST | 휴직 |
RETIRE | 퇴직 |
DELETE | 삭제 |
이 문서가 도움이 되었습니까?