構成員
- 印刷する
- PDF
構成員
- 印刷する
- PDF
記事の要約
この要約は役に立ちましたか?
ご意見ありがとうございます
説明
顧客社の構成員情報をWORKBOXで設定するためのAPIです。
追加API
構成員情報を追加する。
リクエストURL
POST https://workbox.apigw.ntruss.com/workbox/workbox/openapi/v1/organization/company/{companyId}/user/{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 | Naverクラウドプラットフォームポータルで発行された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 | 部署外部キー |
| gradeExternalKey | String | 100 | N | 職級外部キー |
| positionExternalKey | String | 100 | N | 役職外部キー |
| emailAddr | String | 100 | Y | 業務メール(ログインID) |
| telNo | String | 30 | N | 電話番号 |
| cphNo | String | 100 | N | 携帯番号 |
| localeTypeCd | String | N | ロケール情報 | |
| tmznTypeCd | String | N | タイムゾーン情報 |
リクエスト例示
POST https://workbox.apigw.ntruss.com/workbox/workbox/openapi/v1/organization/company/578c7009-bdad-4493-9835-72302cf988c6/emp/EX00001
POST /openapi/v1/organization/company/578c7009-bdad-4493-9835-72302cf988c6/emp/EX00001
HOST: workbox.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",
"name": "ホンギルドン",
"i18nNames": {
"ko_KR": "홍길동",
"en_US": "gildong"
},
"gradeExternalKey" : "grade001",
"telNo" :"0317841111",
"cphNo" : "01012341234",
"localeTypeCd":"ko_KR",
"tmznTypeCd" : "Asia/Seoul",
"positionExternalKey" : "pos001"
}
レスポンス例示
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",
"name": "ホンギルドン",
"i18nNames": {
"ko_KR": "홍길동",
"en_US": "gildong"
},
"gradeExternalKey" : "grade001",
"telNo" :"0317841111",
"cphNo" : "01012341234",
"localeTypeCd":"ko_KR",
"tmznTypeCd" : "Asia/Seoul",
"positionExternalKey" : "pos001"
}
修正API
構成員情報を修正する。
変更がない情報も一緒に渡す必要がある。(部分編集不可)
リクエストURL
PUT https://workbox.apigw.ntruss.com/workbox/workbox/openapi/v1/organization/company/{companyId}/user/{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 | Naverクラウドプラットフォームポータルで発行された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 | 部署外部キー |
| gradeExternalKey | String | 100 | N | 職級外部キー |
| positionExternalKey | String | 100 | N | 役職外部キー |
| telNo | String | 30 | N | 電話番号 |
| cphNo | String | 100 | N | 携帯番号 |
| localeTypeCd | String | N | ロケール情報 | |
| tmznTypeCd | String | N | タイムゾーン情報 |
リクエスト例示
POST https://workbox.apigw.ntruss.com/workbox/workbox/openapi/v1/organization/company/578c7009-bdad-4493-9835-72302cf988c6/emp/EX00001
POST /openapi/v1/organization/company/578c7009-bdad-4493-9835-72302cf988c6/emp/EX00001
HOST: workbox.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",
"name": "ホンギルドン",
"i18nNames": {
"ko_KR": "홍길동",
"en_US": "gildong"
},
"gradeExternalKey" : "grade001",
"telNo" :"0317841111",
"cphNo" : "01012341234",
"positionExternalKey" : "pos001"
}
レスポンス例示
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",
"name": "ホンギルドン",
"i18nNames": {
"ko_KR": "홍길동",
"en_US": "gildong"
},
"gradeExternalKey" : "grade001",
"telNo" :"0317841111",
"cphNo" : "01012341234",
"positionExternalKey" : "pos001"
}
削除API
構成員情報を削除する。
リクエストURL
DELETE https://workbox.apigw.ntruss.com/workbox/workbox/openapi/v1/organization/company/{companyId}/user/{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 | Naverクラウドプラットフォームポータルで発行された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代のエラーコードはサーバ側のエラーを表示するために使われます。 |
サポートする言語コード
| ロケールコード | 説明 |
|---|---|
| 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) |
この記事は役に立ちましたか?