事業場

印刷する
共有
PDF

事業場

印刷する
共有
PDF

Article Summary

Share feedback

Thanks for sharing your feedback!

説明

顧客社の事業場情報をWOKPLACEで設定するためのAPIです。

追加API

事業場情報を追加する。

リクエストURL

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

リクエストヘッダ

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を使用

リクエストPathパラメータ

パラメータ	タイプ	サイズ	必須	説明
companyId	String	36	Y	連携キー(CompanyId) `Developers > 基本設定 > 連携キー`
externalKey	String	36	Y	追加情報外部キー

リクエストBodyパラメータ

パラメータ	タイプ	サイズ	必須	説明
placeNm	String	100	Y	事業場名
placeNmI18nNames	Map		Y	事業場多国語名Map<Locale, String> i18nNames
corporateNum	String	30	Y	法人番号または代表者住民番号
corporateNm	String	100	Y	法人名または商号
category	String	1	N	事業場区分(1:代理人, 2:法人事業者, 3:個人事業者)
phoneNum	String	30	N	電話番号
corpRegistNum	String	30	Y	事業者登録番号
corpRegistSubNum	Int		N	従事業場番号(4桁)
bossNm	String	100	Y	事業場名
bossNmI18nNames	Map		N	事業場多国語名Map<Locale, String> i18nNames
useYn	String	1	Y	使用区分(Y/N)
zipcode	String	10	N	郵便番号
addr	String	100	N	住所
addrDtl	String	100	N	詳細住所
bizType	String	100	N	業種
bizCond	String	100	N	業態
texOfficeCode	Int		N	税務署コード
addTexDeclareYn	String	1	N	消費税申告区分
endYmd	String	10	N	事業場終了日

リクエスト例示

POST https://workplace.apigw.ntruss.com/organization/apigw/v1/company/adc835a8-244c-46b4-8410-7421816d4808/placebiz/gw02attrext0001

POST /organization/apigw/v1/company/adc835a8-244c-46b4-8410-7421816d4808/placebiz/gw02attrext0001
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=
{
    "placeNm" : "ソチョ事業場",
    "placeNmI18nNames" : {
    "en_US" : "SEOCHO PLACE",
    "ko_KR" : "서초사업장",
    "ja_JP" : "ソチョ事業場(JP)",
    "zh_CN" : "ソチョ事業場(CN)",
    "zh_TW" : "ソチョ事業場(TW)"
    },
    "category" : "1",
    "corporateNum" : "111-22-34567",
    "corporateNm" : "テスト事業場(法人)",
    "phoneNum" : "010-3456-3456",
    "corpRegistNum" : "345-22-34567",
    "corpRegistSubNum" : "666",
    "bossNm" : "ホンギルドン",
    "bossNmI18nNames" : {
    "en_US" : "Gil-Dong Hong",
    "ko_KR" : "홍길동",
    "ja_JP" : "ホンギルドン(JP)",
    "zh_CN" : "ホンギルドン(CN)",
    "zh_TW" : "ホンギルドン(TW)"
    },
    "useYn" : "Y",
    "zipcode" : "123-456",
    "addr" : "キョンギ道　ソンナン市　ブンダン区　ドンパンギョ路　65番ギル 34-13",
    "addrDtl" : "詳細住所",
    "bizType" : "業態",
    "bizCond" : "業種",
    "texOfficeCode" : "123",
    "addTexDeclareYn" : "Y",
    "endYmd" : "2999-12-31"
}

レスポンス例示

{
    "companyId": "187d83ad-4038-45b6-8e7c-59eca16fdc46",
    "category": 1,
    "corporateNum": "111-22-34567",
    "placeNm": "テスト事業場",
    "placeNmI18nNames": {
        "en_US": "SEOCHO PLACE",
        "ko_KR": "서초사업장",
        "ja_JP": "ソチョ事業場(JP)",
        "zh_CN": "ソチョ事業場(CN)",
        "zh_TW": "ソチョ事業場(TW)"
    },
    "corporateNm": "テスト事業場(法人)",
    "phoneNum": "010-3456-3456",
    "corpRegistNum": "345-22-34567",
    "corpRegistSubNum": 666,
    "bossNm": "ホンギルドン",
    "bossNmI18nNames": {
        "en_US": "Gil-Dong Hong",
        "ko_KR": "홍길동",
        "ja_JP": "ホンギルドン(JP)",
        "zh_CN": "ホンギルドン(CN)",
        "zh_TW": "ホンギルドン(TW)"
    },
    "useYn": "Y",
    "zipcode": "123-456",
    "addr": "キョンギ道　ソンナン市　ブンダン区　ドンパンギョ路　65番ギル",
    "addrDtl": " 34-13 801号",
    "bizType": "インターネット",
    "bizCond": "サービス",
    "texOfficeCode": 123,
    "addTexDeclareYn": "Y",
    "endYmd": "2999-12-31",
    "externalKey": "gw02attrext0001"
}

修正API

事業場情報を修正する。

リクエストURL

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

リクエストヘッダ

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を使用

リクエストPathパラメータ

パラメータ	タイプ	サイズ	必須	説明
companyId	String	36	Y	連携キー(CompanyId) `Developers > 基本設定 > 連携キー`
externalKey	String	36	Y	追加情報外部キー

リクエストBodyパラメータ

パラメータ	タイプ	サイズ	必須	説明
placeNm	String	100	Y	事業場名
placeNmI18nNames	Map		Y	事業場多国語名Map<Locale, String> i18nNames
corporateNum	String	30	Y	法人番号または代表者住民番号
corporateNm	String	100	Y	法人名または商号
category	String	1	N	事業場区分(1:代理人, 2:法人事業者, 3:個人事業者)
phoneNum	String	30	N	電話番号
corpRegistNum	String	30	Y	事業者登録番号
corpRegistSubNum	Int		N	従事業場番号(4桁)
bossNm	String	100	Y	事業場名
bossNmI18nNames	Map		N	事業場多国語名Map<Locale, String> i18nNames
useYn	String	1	Y	使用区分(Y/N)
zipcode	String	10	N	郵便番号
addr	String	100	N	住所
addrDtl	String	100	N	詳細住所
bizType	String	100	N	業種
bizCond	String	100	N	業態
texOfficeCode	Int		N	税務署コード
addTexDeclareYn	String	1	N	消費税申告区分
endYmd	String	10	N	事業場終了日

リクエスト例示

PUT https://workplace.apigw.ntruss.com/organization/apigw/v1/company/adc835a8-244c-46b4-8410-7421816d4808/placebiz/gw02attrext0002

PUT /organization/apigw/v1/company/adc835a8-244c-46b4-8410-7421816d4808/placebiz/gw02attrext0002
HOST: workplaceg.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=
{   "placeNm" : "修正-ソチョ事業場",
    "placeNmI18nNames" : {
    "en_US" : "SEOCHO PLACE",
    "ko_KR" : "수정-서초사업장",
    "ja_JP" : "修正-ソチョ事業場(JP)",
    "zh_CN" : "修正-ソチョ事業場(CN)",
    "zh_TW" : "修正-ソチョ事業場(TW)"
    },
    "category" : "1",
    "corporateNum" : "111-22-34567",
    "corporateNm" : "テスト事業場(法人)",
    "phoneNum" : "010-3456-3456",
    "corpRegistNum" : "345-22-34567",
    "corpRegistSubNum" : "666",
    "bossNm" : "ホンギルドン",
    "bossNmI18nNames" : {
    "en_US" : "Gil-Dong Hong",
    "ko_KR" : "홍길동",
    "ja_JP" : "ホンギルドン(JP)",
    "zh_CN" : "ホンギルドン(CN)",
    "zh_TW" : "ホンギルドン(TW)"
    },
     "useYn": "Y",
     "zipcode": "123-456",
     "addr": "キョンギ道　ソンナン市　ブンダン区　ドンパンギョ路　65番ギル",
     "addrDtl": " 34-13 801号",
     "bizType": "インターネット",
     "bizCond": "サービス",
     "texOfficeCode": 123,
     "addTexDeclareYn": "Y",
     "endYmd": "2999-12-31"
}

レスポンス例示

{
    "timestamp": "2019-12-13 14:33:31",
    "status": 200,
    "error": null,
    "message": null,
    "path": "/organization/apigw/v1/company/187d83ad-4038-45b6-8e7c-59eca16fdc46/placebiz/195c1526-d8f4-40b3-9269-1c55b7336551111111",
    "body": {
        "companyId": "187d83ad-4038-45b6-8e7c-59eca16fdc46",
        "category": 1,
        "corporateNum": "111-22-34567",
        "placeNm": "修正-ソチョ事業場",
        "placeNmI18nNames" : {
        "en_US" : "SEOCHO PLACE",
        "ko_KR" : "수정-서초사업장",
        "ja_JP" : "修正-ソチョ事業場(JP)",
        "zh_CN" : "修正-ソチョ事業場(CN)",
        "zh_TW" : "修正-ソチョ事業場(TW)"
        },
        "corporateNm": "テスト事業場(法人)",
        "phoneNum": "010-3456-3456",
        "corpRegistNum": "3452234567",
        "corpRegistSubNum": 666,
        "bossNm": "ホンギルドン",
        "bossNmI18nNames": {
            "zh_CN": "ホンギルドン(CN)",
            "ja_JP": "ホンギルドン(JP)",
            "ko_KR": "홍길동",
            "zh_TW": "ホンギルドン(TW)",
            "en_US": "Gil-Dong Hong"
        },
        "useYn": "Y",
        "zipcode": "123-456",
        "addr": "キョンギ道　ソンナン市　ブンダン区　ドンパンギョ路　65番ギル",
        "addrDtl": "34-13 801号",
        "bizType": "業態",
        "bizCond": "業種",
        "texOfficeCode": 123,
        "addTexDeclareYn": "Y",
        "endYmd": "2999-12-31",
        "externalKey": "195c1526-d8f4-40b3-9269-1c55b7336551111111"
    }
}

削除API

事業場情報を削除する。

リクエストURL

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

リクエストヘッダ

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を使用

リクエストPathパラメータ

パラメータ	タイプ	サイズ	必須	説明
companyId	String	36	Y	連携キー(CompanyId) `Developers > 基本設定 > 連携キー`
externalKey	String	36	Y	追加情報外部キー

レスポンス例示

{
    "timestamp": "2019-12-17 13:54:08",
    "status": 200,
    "error": null,
    "message": null,
    "path": "/admin/ns/apigw/v1/company/fe5f8382-aae3-4746-8d6e-f9d0545c5a9b/placebiz/KEY_004",
    "body": null
}

全体リストAPI

設定した追加情報の全体リストを取得する。

リクエストURL

GET https://workplace.apigw.ntruss.com/organization/apigw/v1/company/{companyId}/placebiz

リクエストヘッダ

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を使用

リクエストPathパラメータ

パラメータ	タイプ	サイズ	必須	説明
companyId	String	36	Y	連携キー(CompanyId) `Developers > 基本設定 > 連携キー`

リクエスト例示

GET https://workplace.apigw.ntruss.com/organization/apigw/v1/company/fe5f8382-aae3-4746-8d6e-f9d0545c5a9b/placebiz

レスポンス例示

{
    "timestamp": "2019-12-17 13:36:21",
    "status": 200,
    "error": null,
    "message": null,
    "path": "/admin/ns/apigw/v1/company/fe5f8382-aae3-4746-8d6e-f9d0545c5a9b/placebiz",
    "body": [
        {
            "companyId": "187d83ad-4038-45b6-8e7c-59eca16fdc46",
            "category": 1,
            "corporateNum": "111-22-34567",
            "placeNm": "ソチョ事業場",
            "placeNmI18nNames": {
                "zh_CN": "ソチョ事業場(CN)",
                "ja_JP": "ソチョ事業場(JP)",
                "ko_KR": "서초사업장",
                "zh_TW": "ソチョ事業場(TW)",
                "en_US": "SEOCHO PLACE"
            },
            "corporateNm": "ソチョ事業場(法人)",
            "phoneNum": "010-3456-3456",
            "corpRegistNum": "3452234567",
            "corpRegistSubNum": 666,
            "bossNm": "ホンギルドン",
            "bossNmI18nNames": {
                "zh_CN": "ホンギルドン(CN)",
                "ja_JP": "ホンギルドン(JP)",
                "ko_KR": "홍길동",
                "zh_TW": "ホンギルドン(TW)",
                "en_US": "Gil-Dong Hong"
            },
            "useYn": "Y",
            "zipcode": "123-456",
            "addr": "キョンギ道　ソンナン市　ブンダン区　ドンパンギョ路　65番ギル",
            "addrDtl": " 34-13",
            "bizType": "業態",
            "bizCond": "業種",
            "texOfficeCode": 123,
            "addTexDeclareYn": "Y",
            "endYmd": "2999-12-31",
            "externalKey": "195c1526-d8f4-40b3-9269-1c55b7336551111111"
        },
        {
            "companyId": "fe5f8382-aae3-4746-8d6e-f9d0545c5a9b",
            "category": 2,
            "corporateNum": "111-22-34561",
            "placeNm": "カンナン事業場",
            "placeNmI18nNames": {
               "zh_CN": "カンナン事業場(CN)",
               "ja_JP": "カンナン事業場(JP)",
               "ko_KR": "강남사업장",
               "zh_TW": "カンナン事業場(TW)",
               "en_US": "GANG-NAM PLACE"
            },
            "corporateNm":  "カンナン事業場(法人)",
            "phoneNum": "111-3456-7890",
            "corpRegistNum": "3452234567",
            "corpRegistSubNum": 777,
            "bossNm": "ホンギルソク",
            "bossNmI18nNames": {
                "zh_CN": "ホンギルソク(CN)",
                "ja_JP": "ホンギルソク(JP)",
                "ko_KR": "홍길석",
                "zh_TW": "ホンギルソク(TW)",
                "en_US": "Gil-SEOK Hong"
            },
            "useYn": "Y",
            "zipcode": "123-456",
            "addr": "ソウル市　カンナン区　キョデ路　65番ギル",
            "addrDtl": " 34-13",
            "bizType": "業態",
            "bizCond": "業種",
            "texOfficeCode": 123,
            "addTexDeclareYn": "Y",
            "endYmd": "2017-12-29",
            "externalKey": "195c1526-d8f4-40b3-9269-1c55b7336551111112"
        }
    ]
}

単件照会API

事業場の中、1件を照会する。

リクエストURL

GET https://workplace.apigw.ntruss.com/organization/apigw/v1/company/{companyId}/placebiz

リクエストヘッダ

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を使用

リクエストPathパラメータ

パラメータ	タイプ	サイズ	必須	説明
companyId	String	36	Y	連携キー(CompanyId) `Developers > 基本設定 > 連携キー`
externalKey	String	36	Y	追加情報外部キー

リクエスト例示

GET https://workplace.apigw.ntruss.com/organization/apigw/v1/company/adc835a8-244c-46b4-8410-7421816d4808/placebiz

レスポンス例示

{
    "timestamp": "2019-12-13 14:33:31",
    "status": 200,
    "error": null,
    "message": null,
    "path": "/organization/apigw/v1/company/187d83ad-4038-45b6-8e7c-59eca16fdc46/placebiz",
    "body": {
        "companyId": "187d83ad-4038-45b6-8e7c-59eca16fdc46",
        "category": 1,
        "corporateNum": "111-22-34567",
        "placeNm": "ソチョ事業場",
        "placeNmI18nNames": {
            "zh_CN": "ソチョ事業場(CN)",
            "ja_JP": "ソチョ事業場(JP)",
            "ko_KR": "서초사업장",
            "zh_TW": "ソチョ事業場(TW)",
            "en_US": "SEOCHO PLACE"
        },
        "corporateNm": "ソチョ事業場(法人)",
        "phoneNum": "010-3456-3456",
        "corpRegistNum": "3452234567",
        "corpRegistSubNum": 666,
        "bossNm": "ホンギルドン",
        "bossNmI18nNames": {
            "zh_CN": "ホンギルドン(CN)",
            "ja_JP": "ホンギルドン(JP)",
            "ko_KR": "홍길동",
            "zh_TW": "ホンギルドン(TW)",
            "en_US": "Gil-Dong Hong"
        },
        "useYn": "Y",
        "zipcode": "123-456",
        "addr": "キョンギ道　ソンナン市　ブンダン区　ドンパンギョ路　65番ギル",
        "addrDtl": " 34-13",
        "bizType": "業態",
        "bizCond": "業種",
        "texOfficeCode": 123,
        "addTexDeclareYn": "Y",
        "endYmd": "2999-12-31",
        "externalKey": "195c1526-d8f4-40b3-9269-1c55b7336551111111"
    }
}

レスポンス

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

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

この記事は役に立ちましたか?

What's Next

代表管理者照会

説明
追加API
修正API
削除API
全体リストAPI
単件照会API
レスポンス

タグ

WORKPLACE