社員
- 印刷する
- 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 | - NAVERクラウドプラットフォームポータルまたはSub Accountで発行されたAccess Key ID |
x-ncp-apigw-signature-v2 | - 上記例のBodyをAccess Key IDとマッピングするSecret Keyで暗号化した署名 - HMAC暗号化アルゴリズムは、HmacSHA256を使用 |
リクエストパスパラメータ
パラメータ | タイプ | サイズ | 必須の有無 | 説明 |
---|---|---|---|---|
partnerId | String | 15 | Y | WORKPLACEで提供されたパートナーID |
companyId | String | 36 | Y | 照会する顧客会社の連携キー(CompanyId) Developers > 基本設定 > 連携キー |
リクエストパラメータ
パラメータ | タイプ | サイズ | 必須の有無 | 説明 |
---|---|---|---|---|
offset | long | N | オフセット行から出力 | |
limit | long | N | リミットの数だけ出力 |
リクエストボディパラメータ
パラメータ | タイプ | サイズ | 必須の有無 | 説明 |
---|---|---|---|---|
loginId | String | 100 | Y | ログインID |
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ステータスコードで返され、ボディ情報として伝達する。
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"
}
サポートする言語コード
ロケールコード | 説明 |
---|---|
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 | 削除 |
この記事は役に立ちましたか?