Business places

Article Summary

Share feedback

Thanks for sharing your feedback!

Description

Sets business place information of your company in WOKPLACE.

Add business places

Adds business place information.

Request URL

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

Request header

Header	Description
x-ncp-apigw-timestamp	* This is the number of milliseconds that have elapsed since January 1, 1970 00:00:00 UTC. * If the time difference compared to the API Gateway server is more than 5 minutes, then the request is considered invalid.
x-ncp-iam-access-key	* Access Key ID issued on NAVER Cloud Platform portal or by Sub Account
x-ncp-apigw-signature-v2	* A signature that encrypts the body of the example above with Secret Key mapped to the access key ID * HmacSHA256 is used as the HMAC encryption algorithm

Request path parameters

Parameter	Type	Length	Required	Description
companyId	String	36	Y	API key (CompanyId). `Developers > Basic Settings > API Key`
externalKey	String	36	Y	Additional property’s external key

Request body parameters

Parameter	Type	Length	Required	Description
placeNm	String	100	Y	Business place name
placeNmI18nNames	Map		Y	Business place name in multiple languages Map<Locale, String> i18nNames
corporateNum	String	30	Y	Corporate number or CEO’s resident registration number
corporateNm	String	100	Y	Corporate name or company name
category	String	1	N	Business place category (1:Representative, 2:Corporate business, 3: Self-employed business)
phoneNum	String	30	N	Phone number
corpRegistNum	String	30	Y	Business registration number
corpRegistSubNum	Int		N	Business place number (4 digits)
bossNm	String	100	Y	CEO name
bossNmI18nNames	Map		N	CEO name in multiple languages Map<Locale, String> i18nNames
useYn	String	1	Y	Indicates whether to use the property (Y/N).
zipcode	String	10	N	Zip code
addr	String	100	N	Address
addrDtl	String	100	N	Detailed address
bizType	String	100	N	Business type
bizCond	String	100	N	Business category
texOfficeCode	Int		N	Tax office code
addTexDeclareYn	String	1	N	Indicates whether to file VAT returns.
endYmd	String	10	N	End date of business place

Request example

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" : "34-13, 65beon-gil, Dongpangyo-ro, Bundang-gu, Seongnam-si, Gyeonggi-do",
    "addrDtl" : "Detailed address",
    "bizType" : "Business type",
    "bizCond" : "Business category",
    "texOfficeCode" : "123",
    "addTexDeclareYn" : "Y",
    "endYmd" : "2999-12-31"
}

Response example

{
    "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": "65beon-gil, Dongpangyo-ro, Bundang-gu, Seongnam-si, Gyeonggi-do",
    "addrDtl": " 34-13 801호",
    "bizType": "Internet",
    "bizCond": "Service",
    "texOfficeCode": 123,
    "addTexDeclareYn": "Y",
    "endYmd": "2999-12-31",
    "externalKey": "gw02attrext0001"
}

Edit business places

Edits business place information.

Request URL

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

Request header

Header	Description
x-ncp-apigw-timestamp	* This is the number of milliseconds that have elapsed since January 1, 1970 00:00:00 UTC. * If the time difference compared to the API Gateway server is more than 5 minutes, then the request is considered invalid.
x-ncp-iam-access-key	* Access Key ID issued on NAVER Cloud Platform portal or by Sub Account
x-ncp-apigw-signature-v2	* A signature that encrypts the body of the example above with Secret Key mapped to the access key ID * HmacSHA256 is used as the HMAC encryption algorithm

Request path parameters

Parameter	Type	Length	Required	Description
companyId	String	36	Y	API key (CompanyId). `Developers > Basic Settings > API Key`
externalKey	String	36	Y	Additional property’s external key

Request body parameters

Parameter	Type	Length	Required	Description
placeNm	String	100	Y	Business place name
placeNmI18nNames	Map		Y	Business place name in multiple languages Map<Locale, String> i18nNames
corporateNum	String	30	Y	Corporate number or representative’s resident registration number
corporateNm	String	100	Y	Corporate name or company name
category	String	1	N	Business place category (1:Representative, 2:Corporate business, 3: Self-employed business)
phoneNum	String	30	N	Phone number
corpRegistNum	String	30	Y	Business registration number
corpRegistSubNum	Int		N	Business place number (4 digits)
bossNm	String	100	Y	CEO name
bossNmI18nNames	Map		N	CEO name in multiple languages Map<Locale, String> i18nNames
useYn	String	1	Y	Indicates whether to use the property (Y/N).
zipcode	String	10	N	Zip code
addr	String	100	N	Address
addrDtl	String	100	N	Detailed address
bizType	String	100	N	Business type
bizCond	String	100	N	Business category
texOfficeCode	Int		N	Tax office code
addTexDeclareYn	String	1	N	Indicates whether to file VAT returns.
endYmd	String	10	N	End date of business place

Request example

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": "65beon-gil, Dongpangyo-ro, Bundang-gu, Seongnam-si, Gyeonggi-do",
     "addrDtl": " 34-13 801호",
     "bizType": "Internet",
     "bizCond": "Service",
     "texOfficeCode": 123,
     "addTexDeclareYn": "Y",
     "endYmd": "2999-12-31"
}

Response example

{
    "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": "65beon-gil, Dongpangyo-ro, Bundang-gu, Seongnam-si, Gyeonggi-do",
        "addrDtl": "801, 34-13",
        "bizType": "Business type",
        "bizCond": "Business category",
        "texOfficeCode": 123,
        "addTexDeclareYn": "Y",
        "endYmd": "2999-12-31",
        "externalKey": "195c1526-d8f4-40b3-9269-1c55b7336551111111"
    }
}

Delete business places

Deletes business place information.

Request URL

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

Request header

Header	Description
x-ncp-apigw-timestamp	* This is the number of milliseconds that have elapsed since January 1, 1970 00:00:00 UTC. * If the time difference compared to the API Gateway server is more than 5 minutes, then the request is considered invalid.
x-ncp-iam-access-key	* Access Key ID issued on NAVER Cloud Platform portal or by Sub Account
x-ncp-apigw-signature-v2	* A signature that encrypts the body of the example above with Secret Key mapped to the access key ID * HmacSHA256 is used as the HMAC encryption algorithm

Request path parameters

Parameter	Type	Length	Required	Description
companyId	String	36	Y	API key (CompanyId). `Developers > Basic Settings > API Key`
externalKey	String	36	Y	Additional property’s external key

Response example

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

Get all business places

Gets all business places.

Request URL

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

Request header

Header	Description
x-ncp-apigw-timestamp	* This is the number of milliseconds that have elapsed since January 1, 1970 00:00:00 UTC. * If the time difference compared to the API Gateway server is more than 5 minutes, then the request is considered invalid.
x-ncp-iam-access-key	* Access Key ID issued on NAVER Cloud Platform portal or by Sub Account
x-ncp-apigw-signature-v2	* A signature that encrypts the body of the example above with Secret Key mapped to the access key ID * HmacSHA256 is used as the HMAC encryption algorithm

Request path parameters

Parameter	Type	Length	Required	Description
companyId	String	36	Y	API key (CompanyId). `Developers > Basic Settings > API Key`

Request example

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

Response example

{
    "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": "65beon-gil, Dongpangyo-ro, Bundang-gu, Seongnam-si, Gyeonggi-do",
            "addrDtl": " 34-13",
            "bizType": "Business type",
            "bizCond": "Business category",
            "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": "65beon-gil, Gyodae-ro, Gangnam-gu, Seoul",
            "addrDtl": " 34-13",
            "bizType": "Business type",
            "bizCond": "Business category",
            "texOfficeCode": 123,
            "addTexDeclareYn": "Y",
            "endYmd": "2017-12-29",
            "externalKey": "195c1526-d8f4-40b3-9269-1c55b7336551111112"
        }
    ]
}

Get a business place

Gets a single business place.

Request URL

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

Request header

Header	Description
x-ncp-apigw-timestamp	* This is the number of milliseconds that have elapsed since January 1, 1970 00:00:00 UTC. * If the time difference compared to the API Gateway server is more than 5 minutes, then the request is considered invalid.
x-ncp-iam-access-key	* Access Key ID issued on NAVER Cloud Platform portal or by Sub Account
x-ncp-apigw-signature-v2	* A signature that encrypts the body of the example above with Secret Key mapped to the access key ID * HmacSHA256 is used as the HMAC encryption algorithm

Request path parameters

Parameter	Type	Length	Required	Description
companyId	String	36	Y	API key (CompanyId). `Developers > Basic Settings > API Key`
externalKey	String	36	Y	Additional property’s external key

Request example

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

Response example

{
    "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": "65beon-gil, Dongpangyo-ro, Bundang-gu, Seongnam-si, Gyeonggi-do",
        "addrDtl": " 34-13",
        "bizType": "Business type",
        "bizCond": "Business category",
        "texOfficeCode": 123,
        "addTexDeclareYn": "Y",
        "endYmd": "2999-12-31",
        "externalKey": "195c1526-d8f4-40b3-9269-1c55b7336551111111"
    }
}

Response

It returns an HTTP status code in the response body.

HTTP status code	Response message	Description
200	OK	Success
201	Created	Resource successfully created.
400	Bad Request	Failure (It is usually used to respond to the request format that the server cannot understand.)
500	Internal Server Error	General server error. Whereas 4xx error codes represent client-side errors, 5xx error codes represent server-side errors.

Was this article helpful?

What's Next

Get primary admin

Table of contents

Description
Add business places
Edit business places
Delete business places
Get all business places
Get a business place
Response