Login
      Contents x
      Employee v1
        • Print
        • PDF
        Contents

        Employee v1

          • Print
          • PDF
          Article Summary

          Description

          Sets employee information for your company in WORKPLACE.

          Addition API

          Adds employee information.

          Request URL

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

          Request headers

          HeaderDescription
          x-ncp-apigw-timestampShows the time elapsed since January 1, 1970 00:00:00 UTC.
          If the time differs from that of the API Gateway server by 5 minutes or more, the request is considered invalid.
          x-ncp-apigw-timestamp:{Timestamp}
          x-ncp-apigw-api-keyKey issued by APIGW
          x-ncp-apigw-api-key:{API Gateway API Key}
          x-ncp-iam-access-keyThis is the Access Key ID value issued by the NAVER CLOUD PLATFORM portal.
          x-ncp-iam-access-key:{Account Access Key}
          x-ncp-apigw-signature-v1This is the signature encrypted with the Access Key ID value and Secret Key.
          x-ncp-apigw-signature-v1:{API Gateway Signature}
          Content-TypeRequest body content type is specified as application/json
          Content-Type: application/json

          Request path parameters

          ParameterTypeSizeRequiredDescription
          companyIdString36YAPI key CompanyId (Developers > Basic Settings > API Key)
          externalKeyString36YEmployee external key

          Request body parameters

          ParameterTypeSizeRequiredDescription
          nameString100YName
          i18nNamesMapNName in multiple languages Map<Locale, String> i18nNames
          deptExternalKeyString36NDepartment external key
          emailAddrString100YBusiness email address (login ID)
          extEmailAddrString30NExternal email address
          telNoString30NPhone number
          cphNoString100NCellphone number
          localeTypeCdStringNLocale information
          tmznTypeCdStringNTimezone information
          gradeExternalKeyString100NJob grade external key
          jobExternalKeyString100NPosition external key
          empNickString100NNickname Only the following characters are allowed:! @ & ( ) - _ + [ ] { } , .
          empNoString30NEmployee number
          employYmdDate10NDate hired (YYYY-MM-DD)

          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=

{
    "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",
    "empNo" : "T00001"
}

          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

{
    "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",
    "empNo" : "T00001"
}

          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/v1/company/{companyId}/emp/{externalKey}

          Request headers

          HeaderDescription
          x-ncp-apigw-timestampShows the time elapsed since January 1, 1970 00:00:00 UTC.
          If the time differs from that of the API Gateway server by 5 minutes or more, the request is considered invalid.
          x-ncp-apigw-timestamp:{Timestamp}
          x-ncp-apigw-api-keyKey issued by APIGW
          x-ncp-apigw-api-key:{API Gateway API Key}
          x-ncp-iam-access-keyThis is the Access Key ID value issued by the NAVER CLOUD PLATFORM portal.
          x-ncp-iam-access-key:{Account Access Key}
          x-ncp-apigw-signature-v1This is the signature encrypted with the Access Key ID value and Secret Key.
          x-ncp-apigw-signature-v1:{API Gateway Signature}
          Content-TypeRequest body content type is specified as application/json
          Content-Type: application/json

          Request path parameters

          ParameterTypeSizeRequiredDescription
          companyIdString36YAPI key CompanyId (Developers > Basic Settings > API Key)
          externalKeyString36YEmployee external key

          Request body parameters

          ParameterTypeSizeRequiredDescription
          nameString100YName
          i18nNamesMapNName in multiple languages Map&lt;Locale, String> i18nNames
          deptExternalKeyString36NDepartment external key
          extEmailAddrString30YExternal email address
          telNoString30NPhone number
          cphNoString100NCellphone number
          faxNoString30NFax number
          gradeExternalKeyString100NJob grade external key
          jobExternalKeyString100NPosition external key
          empNickString100NNickname Only the following characters are allowed:! @ & ( ) - _ + [ ] { } , .
          empNoString30NEmployee number
          employYmdDate10NDate hired (YYYY-MM-DD)

          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=

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

          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

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

          Delete API

          Deletes employee information.

          Request URL

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

          Request headers

          HeaderDescription
          x-ncp-apigw-timestampShows the time elapsed since January 1, 1970 00:00:00 UTC.
          If the time differs from that of the API Gateway server by 5 minutes or more, the request is considered invalid.
          x-ncp-apigw-timestamp:{Timestamp}
          x-ncp-apigw-api-keyKey issued by APIGW
          x-ncp-apigw-api-key:{API Gateway API Key}
          x-ncp-iam-access-keyThis is the Access Key ID value issued by the NAVER CLOUD PLATFORM portal.
          x-ncp-iam-access-key:{Account Access Key}
          x-ncp-apigw-signature-v1This is the signature encrypted with the Access Key ID value and Secret Key.
          x-ncp-apigw-signature-v1:{API Gateway Signature}
          Content-TypeRequest body content type is specified as application/json
          Content-Type: application/json

          Request path parameters

          ParameterTypeSizeRequiredDescription
          companyIdString36YAPI key CompanyId (Developers > Basic Settings > API Key)
          externalKeyString36YEmployee external key

          Response

          Returned as HTTP status code in the response body.

          HTTP status codeResponse messageDescription
          200OKSuccess
          201CreatedResource successfully created
          400Bad RequestFailure (usually used to respond to a request format that the server cannot understand.)
          500Internal Server ErrorGeneral server error. Where 4xx error codes represent client-side errors,
          5xx error codes represent server-side errors.

          Usable language codes

          locale codeDescription
          ko_KRKorean
          ja_JPJapanese
          zh_CNChinese (Simplified)
          zh_TWChinese (Traditional)
          en_USEnglish

          Timezone codes

          timeZone codeDescription
          Pacific/MidwayGMT-11:00(MidwayIsland, Samoa)
          Pacific/HonoluluGMT-10:00(Hawaii)
          Pacific/MarquesasGMT-09:30(Marquesas)
          America/AnchorageGMT-09:00(Alaska)
          America/Los_AngelesGMT-08:00(PacificTime)
          America/DenverGMT-07:00(MountainTime_US/Canada)
          America/ChicagoGMT-06:00(CentralTime_US/Canada)
          America/New_YorkGMT-05:00(EasternTime_US/Canada)
          America/CaracasGMT-04:30(Caracas)
          America/SantiagoGMT-04:00(Santiago)
          America/St_JohnsGMT-03:30(Newfoundland)
          America/Sao_PauloGMT-03:00(SaoPaulo)
          America/NoronhaGMT-02:00(Mid-Atlantic)
          Atlantic/AzoresGMT-01:00(Azores)
          Europe/LondonGMT+00:00(GreenwichMeanTime_London)
          Europe/BerlinGMT+01:00(Amsterdam,Berlin, Vienna)
          Europe/AthensGMT+02:00(Athens, Cairo)
          Asia/BaghdadGMT+03:00(Moscow, Baghdad)
          Asia/TehranGMT+03:30(Tehran)
          Asia/BakuGMT+04:00(Baku, Muscat)
          Asia/KarachiGMT+05:00(Karachi)
          Asia/ColomboGMT+05:30(NewDelhi,Mumbai, Colombo)
          Asia/KatmanduGMT+05:45(Katmandu)
          Asia/DhakaGMT+06:00(Astana, Dhaka)
          Asia/RangoonGMT+06:30(Rangoon)
          Asia/BangkokGMT+07:00(Bangkok, Hanoi,Jakarta)
          Asia/ShanghaiGMT+08:00(Beijing,Dalian, Singapore, Taiwan)
          Asia/SeoulGMT+09:00(Seoul)
          Asia/TokyoGMT+09:00(Tokyo, Fukuoka)
          Australia/DarwinGMT+09:30(Darwin,Adelaide)
          Australia/SydneyGMT+10:00(Guam,Canberra, Sydney)
          Australia/Lord_HoweGMT+10:30(LordHoweIsland)
          Pacific/NoumeaGMT+11:00(NewCaledonia)
          Pacific/NorfolkGMT+11:30(NorfolkIsland)
          Pacific/AucklandGMT+12:00(Auckland,Fiji)
          Was this article helpful?
          What's Next
          Change password!
          Changing your password will log you out immediately. Use the new password to log back in.
          Change profile
          Success!
          First name must have atleast 2 characters. Numbers and special characters are not allowed.
          Last name must have atleast 1 characters. Numbers and special characters are not allowed.
          Enter a valid email
          Enter a valid password
          Your profile has been successfully updated.
          Logout