사원

설명

고객사의 사원 정보를 WORKPLACE[g]로 설정하기 위한 API입니다.

추가 API

사원 정보를 추가한다.

요청 URL

POST https://workplaceg.apigw.ntruss.com/organization/apigw/v1/company/{companyId}/emp/{externalKey}

요청 헤더

헤더명 설명
x-ncp-apigw-timestamp 1970년 1월 1일 00:00:00 협정 세계시(UTC)부터의 경과 시간을 밀리초(Millisecond)로 나타내며
API Gateway 서버와 시간 차가 5분 이상 나는 경우 유효하지 않은 요청으로 간주

x-ncp-apigw-timestamp:{Timestamp}
x-ncp-apigw-api-key APIGW에서 발급받은 키 값
x-ncp-apigw-api-key:{API Gateway API Key}
x-ncp-iam-access-key 네이버 클라우드 플랫폼 포털에서 발급받은 Access Key ID 값
x-ncp-iam-access-key:{Account Access Key}
x-ncp-apigw-signature-v1 Access Key ID 값과 Secret Key로 암호화한 서명
x-ncp-apigw-signature-v1:{API Gateway Signature}
Content-Type Request body content type을 application/json으로 지정
Content-Type: application/json

요청 Path 파라미터

파라미터 타입 크기 필수 여부 설명
companyId String 36 Y 연동키CompanyId)(Developers > 기본 설정 > 연동키
externalKey String 36 Y 사원 외부키

요청 Body 파라미터

파라미터 타입 크기 필수 여부 설명
name String 100 Y 기본이름
i18nNames Map N 이름 다국어 Map<Locale, String> i18nNames
deptExternalKey String 36 N 부서 외부키
emailAddr String 100 Y 업무메일(로그인 ID)
extEmailAddr String 30 Y 외부메일주소
telNo String 30 N 전화번호
cphNo String 100 N 휴대폰번호
localeTypeCd String N 로캘정보
tmznTypeCd String N 타임존정보
faxNo String 30 N 팩스번호
gradeExternalKey String 100 N 직급 외부키
jobExternalKey String 100 N 직책 외부키
empNick String 100 N 닉네임특수 문자 중 ! @ & ( ) - _ + [ ] { } , . 만 허용

요청 예시

POST https://workplaceg.apigw.ntruss.com/organization/apigw/v1/company/578c7009-bdad-4493-9835-72302cf988c6/emp/EX00001

POST /organization/apigw/v1/company/578c7009-bdad-4493-9835-72302cf988c6/emp/EX00001
HOST: workplaceg.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-v1: WTPItrmMIfLUk/UyUIyoQbA/z5hq9o3G8eQMolUzTEo=

{
    "deptExternalKey": "00002",
    "emailAddr": "gildong@sample.co.kr",
    "extEmailAddr": "gildong@test.com",
    "name": "홍길동",
    "i18nNames": {
            "ko_KR": "홍길동",
            "en_US": "gildong"
        },
    "empNick" : "홍길동전",
    "jobExternalKey" : "job001",
    "telNo" :"0317841111",
    "cphNo" : "01012341234",
    "localeTypeCd":"ko_KR",
    "tmznTypeCd" : "Asia/Seoul",
    "gradeExternalKey" : "grade001"
}

응답 예시

HTTP/1.1 201 OK
Server: nginx
Date: Wed, 12 Sep 2018 10:18:11 GMT
Content-Type: application/json;charset=utf-8
Transfer-Encoding: chunked
Connection: keep-alive
Access-Control-Allow-Origin: *
x-ncp-trace-id: 68d1o68pm4cr63gc3169gm4p34

{
    "deptExternalKey": "00002",
    "emailAddr": "gildong@sample.co.kr",
    "extEmailAddr": "gildong@test.com",
    "name": "홍길동",
    "i18nNames": {
            "ko_KR": "홍길동",
            "en_US": "gildong"
        },
    "empNick" : "홍길동전",
    "jobExternalKey" : "job001",
    "telNo" :"0317841111",
    "cphNo" : "01012341234",
    "localeTypeCd":"ko_KR",
    "tmznTypeCd" : "Asia/Seoul",
    "gradeExternalKey" : "grade001"
}

수정 API

사원 정보를 수정한다.
변경없는 정보도 함께 넘겨줘야 한다.(부분편집 안됨)

요청 URL

PUT https://workplaceg.apigw.ntruss.com/organization/apigw/v1/company/{companyId}/emp/{externalKey}

요청 헤더

헤더명 설명
x-ncp-apigw-timestamp 1970년 1월 1일 00:00:00 협정 세계시(UTC)부터의 경과 시간을 밀리초(Millisecond)로 나타내며
API Gateway 서버와 시간 차가 5분 이상 나는 경우 유효하지 않은 요청으로 간주

x-ncp-apigw-timestamp:{Timestamp}
x-ncp-apigw-api-key APIGW에서 발급받은 키 값
x-ncp-apigw-api-key:{API Gateway API Key}
x-ncp-iam-access-key 네이버 클라우드 플랫폼 포털에서 발급받은 Access Key ID 값
x-ncp-iam-access-key:{Account Access Key}
x-ncp-apigw-signature-v1 Access Key ID 값과 Secret Key로 암호화한 서명
x-ncp-apigw-signature-v1:{API Gateway Signature}
Content-Type Request body content type을 application/json으로 지정
Content-Type: application/json

요청 Path 파라미터

파라미터 타입 크기 필수 여부 설명
companyId String 36 Y 연동키CompanyId)(Developers > 기본 설정 > 연동키
externalKey String 36 Y 사원 외부키

요청 Body 파라미터

파라미터 타입 크기 필수 여부 설명
name String 100 Y 기본이름
i18nNames Map N 이름 다국어 Map<Locale, String> i18nNames
deptExternalKey String 36 N 부서 외부키
extEmailAddr String 30 Y 외부메일주소
telNo String 30 N 전화번호
cphNo String 100 N 휴대폰번호
faxNo String 30 N 팩스번호
gradeExternalKey String 100 N 직급 외부키
jobExternalKey String 100 N 직책 외부키
empNick String 100 N 닉네임(특수 문자 중 ! @ & ( ) - _ + [ ] { } , . 만 허용)

요청 예시

POST https://workplaceg.apigw.ntruss.com/organization/apigw/v1/company/578c7009-bdad-4493-9835-72302cf988c6/emp/EX00001

POST /organization/apigw/v1/company/578c7009-bdad-4493-9835-72302cf988c6/emp/EX00001
HOST: workplaceg.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-v1: WTPItrmMIfLUk/UyUIyoQbA/z5hq9o3G8eQMolUzTEo=

{
    "deptExternalKey": "00002",
    "extEmailAddr": "gildong@test.com",
    "name": "홍길동",
    "i18nNames": {
            "ko_KR": "홍길동",
            "en_US": "gildong"
        },
    "empNick" : "홍길동전",
    "jobExternalKey" : "job001",
    "telNo" :"0317841111",
    "cphNo" : "01012341234",
    "gradeExternalKey" : "grade001"
}

응답 예시

HTTP/1.1 200 OK
Server: nginx
Date: Wed, 12 Sep 2018 10:18:11 GMT
Content-Type: application/json;charset=utf-8
Transfer-Encoding: chunked
Connection: keep-alive
Access-Control-Allow-Origin: *
x-ncp-trace-id: 68d1o68pm4cr63gc3169gm4p34

{
    "deptExternalKey": "00002",
    "extEmailAddr": "gildong@test.com",
    "name": "홍길동",
    "i18nNames": {
            "ko_KR": "홍길동",
            "en_US": "gildong"
        },
    "empNick" : "홍길동전",
    "jobExternalKey" : "job001",
    "telNo" :"0317841111",
    "cphNo" : "01012341234",
    "gradeExternalKey" : "grade001"
}

삭제 API

사원 정보를 삭제한다.

요청 URL

DELETE https://workplaceg.apigw.ntruss.com/organization/apigw/v1/company/{companyId}/emp/{externalKey}

요청 헤더

헤더명 설명
x-ncp-apigw-timestamp 1970년 1월 1일 00:00:00 협정 세계시(UTC)부터의 경과 시간을 밀리초(Millisecond)로 나타내며
API Gateway 서버와 시간 차가 5분 이상 나는 경우 유효하지 않은 요청으로 간주

x-ncp-apigw-timestamp:{Timestamp}
x-ncp-apigw-api-key APIGW에서 발급받은 키 값
x-ncp-apigw-api-key:{API Gateway API Key}
x-ncp-iam-access-key 네이버 클라우드 플랫폼 포털에서 발급받은 Access Key ID 값
x-ncp-iam-access-key:{Account Access Key}
x-ncp-apigw-signature-v1 Access Key ID 값과 Secret Key로 암호화한 서명
x-ncp-apigw-signature-v1:{API Gateway Signature}
Content-Type Request body content type을 application/json으로 지정
Content-Type: application/json

요청 Path 파라미터

파라미터 타입 크기 필수 여부 설명
companyId String 36 Y 연동키CompanyId)(Developers > 기본 설정 > 연동키
externalKey String 36 Y 사원 외부키

응답

HTTP 상태 코드로 리턴되고, Body 정보로 전달한다.

HTTP 상태 코드 응답메시지 설명
200 OK 일반적인 요청 성공
201 Created 리소스 생성 성공에 대한 응답 코드
400 Bad Request 일반적인 요청 실패에 사용(대체로 서버가 이해할 수 없는 형식의 요청이 왔을 때 응답하기 위해 사용)
500 Internal Server Error 일반적인 서버 오류에 대한 응답 코드. 4XX대의 오류 코드가 클라이언트 측 오류를 나타내기 위해 사용된다면,
5XX대의 오류 코드는 서버 측 오류를 나타내기 위해 사용됩니다.

지원하는 언어 코드

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)