Employee v2

Article Summary

Share feedback

Thanks for sharing your feedback!

Description

API to set the employee information for your company in WORKPLACE.

Addition API

Adds employee information.

Request URL

POST https://workplace.apigw.ntruss.com/organization/apigw/v2/company/{companyId}/employee/{externalKey}

Request header

Header	Description
x-ncp-apigw-timestamp	* This is the number of milliseconds that have elapsed since January 1, 1970 00:00:00 UTC. * If the time difference compared to the API Gateway server is more than 5 minutes, then the request is considered invalid.
x-ncp-iam-access-key	* Access Key ID issued on NAVER Cloud Platform portal or by Sub Account
x-ncp-apigw-signature-v2	* A signature that encrypts the body of the example above with Secret Key mapped to the access key ID * HmacSHA256 is used as the HMAC encryption algorithm

Request path parameters

Parameter	Type	Capacity	Requirement status	Description
companyId	String	36	Y	Connection key`(CompanyId) Developers > Default settings > Connection key`
externalKey	String	36	Y	Employee external key

Request body parameters

Parameter	Type	Capacity	Requirement status	Description
loginId	String	100	Y	Login ID
emailAddress	String	100	Y	Email
employYmd	String	10	Y	Date of employment`(yyyy-MM-dd)`
telephoneNo	String	30	N	Telephone number
cellphoneNo	String	100	N	Mobile phone number
birthYmd	String	30	N	Date of birth`(yyyy-MM-dd)`
genderCd	String	30	N	Gender`(MALE, FEMALE)`
empNick	String	100	N	Nickname `Only the following characters are allowed: ! @ & ( ) - _ + [ ] { } , .`
localeTypeCd	String		N	Locale information
tmznTypeCd	String		N	Time zone information
zipCode	String	10	N	Zip code
address	String	100	N	Address
addressDetail	String	100	N	Detailed address
name	String	100	Y	Name
i18nNames	Map		N	Localized name `Map<Locale, String> i18nNames`
deptExternalKey	String	100	Y	Department external key
concurrentDeptExternalKeys	array		Y	Concurrent department external key
empTypeExternalKey	String	100	Y	Employment type external key
gradeCdExternalKey	String	100	N	Job grade external key
jobCdExternalKey	String	100	N	Position external key
passwordSettingType	String	10	Y	Passwords setting type`(ADMIN/USER)`
initializePassword	String	100	Y	ADMIN: initial password/USER: email address to receive the invitation email

Request example

POST https://workplace.apigw.ntruss.com/organization/apigw/v2/company/c1798784-9a47-4751-ab9f-b9629825ab93/employee/apiTestExternal1

POST /organization/apigw/v1/company/578c7009-bdad-4493-9835-72302cf988c6/emp/EX00001
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=

{
        "employYmd" : "2021-03-01",
        "loginId" : "gildong@sample.co.kr",
        "emailAddress" : "gildong@test.com",
        "telephoneNo" : "0100000000",
        "cellphoneNo" : "0310000000",
        "birthYmd" : "1988-01-01",
        "genderCd" : "MALE",
        "zipCode" : "123456",
        "address" : "Jeongja-dong, Bundang-gu, Seongnam-si, Gyeonggi-do",
        "addressDetail" : "1-dong 1-ho, Green apartment",
        "name": "Gildong Hong",
        "i18nNames": {
            "ko_KR": "Gildong Hong",
            "en_US": "gildong"
        },
        "deptExternalKey" : "apitestdept1",
        "concurrentDeptExternalKeys" : ["apitestdept2", "apitestdept3"],
        "empTypeExternalKey" : "apitestempType1",
        "gradeCdExternalKey" : "apitestgrade5",
        "jobCdExternalKey" : "apitestjob1",
        "passwordSettingType" : "ADMIN",
        "initializePassword" : "password"
}

Response example

HTTP/1.1 201 OK
Server: nginx
Date: Wed, 12 Sep 2020 01: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

{
        "employYmd" : "2021-03-01",
        "loginId" : "gildong@sample.co.kr",
        "emailAddress" : "gildong@test.com",
        "telephoneNo" : "0100000000",
        "cellphoneNo" : "0310000000",
        "birthYmd" : "1988-01-01",
        "genderCd" : "MALE",
        "zipCode" : "123456",
        "address" : "Jeongja-dong, Bundang-gu, Seongnam-si, Gyeonggi-do",
        "addressDetail" : "1-dong 1-ho, Green apartment",
        "name": "Gildong Hong",
        "i18nNames": {
            "ko_KR": "Gildong Hong",
            "en_US": "gildong"
        },
        "deptExternalKey" : "apitestdept1",
        "concurrentDeptExternalKeys" : ["apitestdept2", "apitestdept3"],
        "empTypeExternalKey" : "apitestempType1",
        "gradeCdExternalKey" : "apitestgrade5",
        "jobCdExternalKey" : "apitestjob1",
        "passwordSettingType" : "ADMIN",
        "initializePassword" : "password"
}

Edit API

Edits employee information.

You should pass all the information, including information that is unchanged. (Even if you only need to edit certain fields, all information must be resubmitted.)

Request URL

PUT https://workplace.apigw.ntruss.com/organization/apigw/v2/company/{companyId}/employee/{externalKey}

Request header

Header	Description
x-ncp-apigw-timestamp	* This is the number of milliseconds that have elapsed since January 1, 1970 00:00:00 UTC. * If the time difference compared to the API Gateway server is more than 5 minutes, then the request is considered invalid.
x-ncp-iam-access-key	* Access Key ID issued on NAVER Cloud Platform portal or by Sub Account
x-ncp-apigw-signature-v2	* A signature that encrypts the body of the example above with Secret Key mapped to the access key ID * HmacSHA256 is used as the HMAC encryption algorithm

Request path parameters

Parameter	Type	Capacity	Requirement status	Description
companyId	String	36	Y	Connection key`(CompanyId) Developers > Default settings > Connection key`
externalKey	String	36	Y	Employee external key

Request body parameters

Parameter	Type	Capacity	Requirement status	Description
loginId	String	100	Y	Login ID
emailAddress	String	100	Y	Email
employYmd	String	10	Y	Date of employment`(yyyy-MM-dd)`
telephoneNo	String	30	N	Telephone number
cellphoneNo	String	100	N	Mobile phone number
birthYmd	String	30	N	Date of birth`(yyyy-MM-dd)`
genderCd	String	30	N	Gender`(MALE, FEMALE)`
empNick	String	100	N	Nickname`Only the following characters are allowed: ! @ & ( ) - _ + [ ] { } , .`
localeTypeCd	String		N	Locale information
tmznTypeCd	String		N	Time zone information
zipCode	String	10	N	Zip code
address	String	100	N	Address
addressDetail	String	100	N	Detailed address
name	String	100	Y	Name
i18nNames	Map		N	Localized name `Map<Locale, String> i18nNames`
deptExternalKey	String	100	Y	Department external key
concurrentDeptExternalKeys	array		Y	Concurrent department external key
empTypeExternalKey	String	100	Y	Employment type external key
gradeCdExternalKey	String	100	N	Job grade external key
jobCdExternalKey	String	100	N	Position external key
passwordSettingType	String	10	Y	Passwords setting type (ADMIN/USER)
initializePassword	String	100	Y	ADMIN: initial password/USER: email address to receive the invitation email

Request example

POST https://workplace.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: 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-v1: WTPItrmMIfLUk/UyUIyoQbA/z5hq9o3G8eQMolUzTEo=

{
        "employYmd" : "2021-03-01",
        "loginId" : "gildong@sample.co.kr",
        "emailAddress" : "gildong@test.com",
        "telephoneNo" : "0100000000",
        "cellphoneNo" : "0310000000",
        "birthYmd" : "1988-01-01",
        "genderCd" : "MALE",
        "zipCode" : "123456",
        "address" : "Jeongja-dong, Bundang-gu, Seongnam-si, Gyeonggi-do",
        "addressDetail" : "1-dong 1-ho, Green apartment",
        "name": "Gildong Hong",
        "i18nNames": {
            "ko_KR": "Gildong Hong",
            "en_US": "gildong"
        },
        "deptExternalKey" : "apitestdept1",
        "concurrentDeptExternalKeys" : ["apitestdept2", "apitestdept3"],
        "empTypeExternalKey" : "apitestempType1",
        "gradeCdExternalKey" : "apitestgrade5",
        "jobCdExternalKey" : "apitestjob1",
        "passwordSettingType" : "ADMIN",
        "initializePassword" : "password"
 }

Response example

HTTP/1.1 200 OK
Server: nginx
Date: Wed, 12 Sep 2020 01: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

{
        "employYmd" : "2021-03-01",
        "loginId" : "gildong@sample.co.kr",
        "emailAddress" : "gildong@test.com",
        "telephoneNo" : "0100000000",
        "cellphoneNo" : "0310000000",
        "birthYmd" : "1988-01-01",
        "genderCd" : "MALE",
        "zipCode" : "123456",
        "address" : "Jeongja-dong, Bundang-gu, Seongnam-si, Gyeonggi-do",
        "addressDetail" : "1-dong 1-ho, Green apartment",
        "name": "Gildong Hong",
        "i18nNames": {
            "ko_KR": "Gildong Hong",
            "en_US": "gildong"
        },
        "deptExternalKey" : "apitestdept1",
        "concurrentDeptExternalKeys" : ["apitestdept2", "apitestdept3"],
        "empTypeExternalKey" : "apitestempType1",
        "gradeCdExternalKey" : "apitestgrade5",
        "jobCdExternalKey" : "apitestjob1",
        "passwordSettingType" : "ADMIN",
        "initializePassword" : "password"
}

Delete API

Deletes employee information.

Request URL

DELETE https://workplace.apigw.ntruss.com/organization/apigw/v2/company/{companyId}/employee/{externalKey}

Request header

Header	Description
x-ncp-apigw-timestamp	* This is the number of milliseconds that have elapsed since January 1, 1970 00:00:00 UTC. * If the time difference compared to the API Gateway server is more than 5 minutes, then the request is considered invalid.
x-ncp-iam-access-key	* Access Key ID issued on NAVER Cloud Platform portal or by Sub Account
x-ncp-apigw-signature-v2	* A signature that encrypts the body of the example above with Secret Key mapped to the access key ID * HmacSHA256 is used as the HMAC encryption algorithm

Request path parameters

Parameter	Type	Capacity	Requirement status	Description
companyId	String	36	Y	Connection key (CompanyId) `Developers > Default settings > Connection key`
externalKey	String	36	Y	Employee external key `Developers > Default settings > Connect Organization > Employee` LoginId empId

Search employee API

Searches employees.

Request URL

GET https://workplace.apigw.ntruss.com/organization/apigw/v2/company/{companyId}/employee/{externalKey}

Request header

Header	Description
x-ncp-apigw-timestamp	* This is the number of milliseconds that have elapsed since January 1, 1970 00:00:00 UTC. * If the time difference compared to the API Gateway server is more than 5 minutes, then the request is considered invalid.
x-ncp-iam-access-key	* Access Key ID issued on NAVER Cloud Platform portal or by Sub Account
x-ncp-apigw-signature-v2	* A signature that encrypts the body of the example above with Secret Key mapped to the access key ID * HmacSHA256 is used as the HMAC encryption algorithm

Request path parameters

Parameter	Type	Capacity	Requirement status	Description
companyId	String	36	Y	Connection key`(CompanyId) Developers > Default settings > Connection key`
externalKey	String	36	Y	Employee external key

Request example

GET https://workplace.apigw.ntruss.com/organization/apigw/v2/company/c1798784-9a47-4751-ab9f-b9629825ab93/employee/apiTestExternal1

GET /organization/apigw/v2/company/c1798784-9a47-4751-ab9f-b9629825ab93/employee/apiTestExternal1
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=

Response example

HTTP/1.1 200 OK
Server: nginx
Date: Wed, 12 Sep 2020 01: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
{
            "tenantId": "c1798784-9a47-4751-ab9f-b9629825ab93",
            "companyId": "c1798784-9a47-4751-ab9f-b9629825ab93",
            "externalKey": "apiTestExternal1",
             "name": "Gildong Hong",
             "i18nNames": {
                  "ko_KR": "Gildong Hong",
                  "en_US": "gildong"
             },
            "employYmd": "2021-03-01",
            "loginId" : "gildong@sample.co.kr",
            "emailAddress" : "gildong@test.com",
            "telephoneNo" : "0100000000",
            "cellphoneNo" : "0310000000",
            "empNo": null,
            "nationCd": null,
            "residentRegistrationNumber": null,
            "genderCd": "MALE",
            "birthYmd": "1989-01-01",
            "zipCode" : "123456",
            "address" : "Jeongja-dong, Bundang-gu, Seongnam-si, Gyeonggi-do",
            "addressDetail" : "1-dong 1-ho, Green apartment",
            "deptExternalKey": "apitestdept1",
            "gradeCdExternalKey": "apitestgrade5",
            "jobCdExternalKey": "apitestjob1",
            "empTypeExternalKey": "apitestempType1"
}

Search employee list API

Searches employee list.

Request URL

GET https://workplace.apigw.ntruss.com/organization/apigw/v2/company/{companyId}/employee

Request header

Header	Description
x-ncp-apigw-timestamp	* This is the number of milliseconds that have elapsed since January 1, 1970 00:00:00 UTC. * If the time difference compared to the API Gateway server is more than 5 minutes, then the request is considered invalid.
x-ncp-iam-access-key	* Access Key ID issued on NAVER Cloud Platform portal or by Sub Account
x-ncp-apigw-signature-v2	* A signature that encrypts the body of the example above with Secret Key mapped to the access key ID * HmacSHA256 is used as the HMAC encryption algorithm

Request path parameters

Parameter	Type	Capacity	Requirement status	Description
companyId	String	36	Y	Connection key`(CompanyId) Developers > Default settings > Connection key`

Request parameters

Parameter	Type	Capacity	Requirement status	Description
offset	long		N	Display offset rows first
limit	long		N	Display as many as the number of limits

Request example

GET https://workplace.apigw.ntruss.com/organization/apigw/v2/company/c1798784-9a47-4751-ab9f-b9629825ab93/employee?offset=0&limit=10

GET 
organization/apigw/v2/company/c1798784-9a47-4751-ab9f-b9629825ab93/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=

Response example

HTTP/1.1 200 OK
Server: nginx
Date: Wed, 12 Sep 2020 01: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

{
    "elements": [
        {
            "tenantId": "c1798784-9a47-4751-ab9f-b9629825ab93",
            "companyId": "c1798784-9a47-4751-ab9f-b9629825ab93",
            "externalKey": "apiTestExternal1",
             "name": "Gildong Hong",
             "i18nNames": {
                  "ko_KR": "Gildong Hong",
                  "en_US": "gildong"
             },
            "employYmd": "2021-03-01",
            "loginId" : "gildong@sample.co.kr",
            "emailAddress" : "gildong@test.com",
            "telephoneNo" : "0100000000",
            "cellphoneNo" : "0310000000",
            "empNo": null,
            "nationCd": null,
            "residentRegistrationNumber": null,
            "genderCd": "MALE",
            "birthYmd": "1989-01-01",
            "zipCode" : "123456",
            "address" : "Jeongja-dong, Bundang-gu, Seongnam-si, Gyeonggi-do",
            "addressDetail" : "1-dong 1-ho, Green apartment",
            "deptExternalKey": "apitestdept1",
            "gradeCdExternalKey": "apitestgrade5",
            "jobCdExternalKey": "apitestjob1",
            "empTypeExternalKey": "apitestempType1"
        },
        {
            "tenantId": "c1798784-9a47-4751-ab9f-b9629825ab93",
            "companyId": "c1798784-9a47-4751-ab9f-b9629825ab93",
            "externalKey": "apiTestExternal2",
            "name": "Gildongi",
            "i18nNames": {},
            "employYmd": "2021-03-01",
            "loginId" : "gildong1@sample.co.kr",
            "emailAddress" : "gildong1@test.com",
            "telephoneNo" : "0100000000",
            "cellphoneNo" : "0310000000",
            "empNo": null,
            "nationCd": null,
            "residentRegistrationNumber": null,
            "genderCd": "MALE",
            "birthYmd": "1986-11-01",
            "zipCode": "",
            "address": null,
            "addressDetail": null,
            "deptExternalKey": "apitestdept1",
            "gradeCdExternalKey": "apitestgrade5",
            "jobCdExternalKey": "apitestjob1",
            "empTypeExternalKey": "apitestempType1"
        }
    ],
    "totalCount": 2
}

Response

Returned as an HTTP status code in the response body.

HTTP status code	Response message	Description
200	OK	General request made successfully
201	Created	Response code related to the success of resource creation
400	Bad Request	Used for failed general request
500	Internal Server Error	General server error. While 4xx error codes represent client-side errors, 5xx error codes represent server-side errors.

Response example

{
    "status": 400,
    "code": -4001,
    "errors": [],
    "message": "This is a duplicate login ID"
}

Usable language codes

Locale code	Description
ko_KR	Korean
ja_JP	Japanese
zh_CN	Chinese (Simplified)
zh_TW	Chinese (Traditional)
en_US	English

Time zone codes

Time zone code	Description
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)

Was this article helpful?

What's Next

Employee v1

Table of contents

Description
Addition API
Edit API
Delete API
Search employee API
Search employee list API
Response
Usable language codes
Time zone codes