Login
      目次 x
      社員v1
        • 印刷する
        • PDF
        目次

        社員v1

          • 印刷する
          • PDF
          Article Summary

          説明

          クライアントの社員情報をWORKPLACEに設定するためのAPIです。

          追加API

          社員情報を追加する。

          リクエストURL

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

          リクエストヘッダ

          ヘッダ名説明
          x-ncp-apigw-timestamp1970年1月1日00:00:00協定世界時(UTC)からの経過時間をミリ秒(Millisecond)で表し、
          API Gatewayサーバーとの時間差が5分以上の場合、有効ではないリクエストと見なす
          x-ncp-apigw-timestamp:{Timestamp}
          x-ncp-apigw-api-keyAPIGWから発行されたキー値
          x-ncp-apigw-api-key:{API Gateway API Key}
          x-ncp-iam-access-keyNAVERクラウドプラットフォームポータルで発行したAccess Key ID値
          x-ncp-iam-access-key:{Account Access Key}
          x-ncp-apigw-signature-v1Access Key ID値やSecret Keyで暗号化した署名
          x-ncp-apigw-signature-v1:{API Gateway Signature}
          Content-TypeRequest body content typeをapplication/jsonに指定
          Content-Type：application/json

          リクエストPathパラメーター

          パラメータータイプ容量必須の有無説明
          companyIdString36Y連携キー(CompanyId) Developers > 基本設定 > 連携キー
          externalKeyString36Y社員の外部キー

          リクエストBodyパラメーター

          パラメータータイプ容量必須の有無説明
          nameString100Y基本名
          i18nNamesMapN名前多言語 Map<Locale、String> i18nNames
          deptExternalKeyString36N部署の外部キー
          emailAddrString100Y業務メール(ログインID)
          extEmailAddrString30N外部メールアドレス
          telNoString30N電話番号
          cphNoString100N携帯電話番号
          localeTypeCdStringNロケール情報
          tmznTypeCdStringNタイムゾーン情報
          gradeExternalKeyString100N役職の外部キー
          jobExternalKeyString100N肩書の外部キー
          empNickString100Nニックネーム特殊文字のうち!@ & ( ) - _ + [ ] { } , .のみ許可
          empNoString30N社員番号使用時
          employYmdDate10N入社日(YYYY-MM-DD)

          リクエスト例

          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"
}

          レスポンス例

          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"
}

          修正API

          社員情報を修正する。

          変更のない情報も共に渡す。(部分編集不可)

          リクエストURL

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

          リクエストヘッダ

          ヘッダ名説明
          x-ncp-apigw-timestamp1970年1月1日00:00:00協定世界時(UTC)からの経過時間をミリ秒(Millisecond)で表し、
          API Gatewayサーバーとの時間差が5分以上の場合、有効ではないリクエストと見なす
          x-ncp-apigw-timestamp:{Timestamp}
          x-ncp-apigw-api-keyAPIGWから発行されたキー値
          x-ncp-apigw-api-key:{API Gateway API Key}
          x-ncp-iam-access-keyNAVERクラウドプラットフォームポータルで発行したAccess Key ID値
          x-ncp-iam-access-key:{Account Access Key}
          x-ncp-apigw-signature-v1Access Key ID値やSecret Keyで暗号化した署名
          x-ncp-apigw-signature-v1:{API Gateway Signature}
          Content-TypeRequest body content typeをapplication/jsonに指定
          Content-Type：application/json

          リクエストPathパラメーター

          パラメータータイプ容量必須の有無説明
          companyIdString36Y連携キー(CompanyId) Developers > 基本設定 > 連携キー
          externalKeyString36Y社員の外部キー

          リクエストBodyパラメーター

          パラメータータイプ容量必須の有無説明
          nameString100Y基本名
          i18nNamesMapN名前多言語 Map<Locale、String> i18nNames
          deptExternalKeyString36N部署の外部キー
          extEmailAddrString30Y外部メールアドレス
          telNoString30N電話番号
          cphNoString100N携帯電話番号
          faxNoString30Nファックス番号
          gradeExternalKeyString100N役職の外部キー
          jobExternalKeyString100N肩書の外部キー
          empNickString100Nニックネーム 特殊文字のうち!@ & ( ) - _ + [ ] { } , .のみ許可
          empNoString30N社員番号
          employYmdDate10N入社日 YYYY-MM-DD

          リクエスト例

          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"
}

          レスポンス例

          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"
}

          削除API

          社員情報を削除する。

          リクエストURL

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

          リクエストヘッダ

          ヘッダ名説明
          x-ncp-apigw-timestamp1970年1月1日00:00:00協定世界時(UTC)からの経過時間をミリ秒(Millisecond)で表し、
          API Gatewayサーバーとの時間差が5分以上の場合、有効ではないリクエストと見なす
          x-ncp-apigw-timestamp:{Timestamp}
          x-ncp-apigw-api-keyAPIGWから発行されたキー値
          x-ncp-apigw-api-key:{API Gateway API Key}
          x-ncp-iam-access-keyNAVERクラウドプラットフォームポータルで発行したAccess Key ID値
          x-ncp-iam-access-key:{Account Access Key}
          x-ncp-apigw-signature-v1Access Key ID値やSecret Keyで暗号化した署名
          x-ncp-apigw-signature-v1:{API Gateway Signature}
          Content-TypeRequest body content typeをapplication/jsonに指定
          Content-Type：application/json

          リクエストPathパラメーター

          パラメータータイプ容量必須の有無説明
          companyIdString36Y連携キー(CompanyId) Developers > 基本設定 > 連携キー
          externalKeyString36Y社員の外部キー

          レスポンス

          HTTPステータスコードにリターンされ、Body情報に伝達する。

          HTTPステータスコードレスポンスメッセージ説明
          200OK一般的なリクエスト成功
          201Createdリソース作成の成功に対するレスポンスコード
          400Bad Request一般的なリクエスト失敗に使用(ほとんどサーバが理解できない形式のリクエストがあった場合、レスポンスのために使用)
          500Internal Server Error一般的なサーバエラーに対するレスポンスコード。4XX台のエラーコードがクライアント側のエラーを示すために使用される場合、
          5XX台のエラーコードはサーバ側のエラーを示すために使用されます。

          サポートしている言語コード

          localeコード説明
          ko_KR한국어
          ja_JP日本語
          zh_CN中国語(簡体字)
          zh_TW中国語(繁体字)
          en_US英語

          タイムゾーンコード

          timeZoneコード説明
          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)
          この記事は役に立ちましたか?
          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