Employment types v2

Article Summary

Share feedback

Thanks for sharing your feedback!

Description

API to set the employment type information for your company in WORKPLACE.

Addition API

Adds employment type information.

Request URL

POST https://workplace.apigw.ntruss.com/organization/apigw/v2/company/{companyId}/empType/{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	Mandatory	Description
companyId	String	36	Y	Connection key (CompanyId)`Developers > Default settings > Connection key`
externalKey	String	36	Y	Employment type external key

Request body parameters

Parameter	Type	Capacity	Requirement status	Description
name	String	100	Y	Employment type (Duplication is not allowed.)
i18nNames	Map		N	Localized employment type name`Map<Locale, String> i18nNames`
itemUsed	boolean		Y	Use status
sortOrder	String		Y	Display order of employment type

Request example

POST https://workplace.apigw.ntruss.com/organization/apigw/v2/company/c1798784-9a47-4751-ab9f-b9629825ab93/empType/empTypeTest1

POST /organization/apigw/v2/company/c1798784-9a47-4751-ab9f-b9629825ab93/empType/empTypeTest1
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=
{
        "sortOrder": "1",
        "itemUsed" : true,
        "name" : "Regular",
         "i18nNames": {
                "ko_KR" : "Regular",
                "en_US": "Permanent employment"
            }
 }

Response example

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

{
        "sortOrder": "1",
        "itemUsed" : true,
        "name" : "Regular",
         "i18nNames": {
                "ko_KR" : "Regular",
                "en_US": "Permanent employment"
            }
 }

Edit API

Edits employment type information.

Request URL

PUT https://workplace.apigw.ntruss.com/organization/apigw/v2/company/{companyId}/empType/{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	Capacity	Requirement status	Description
companyId	String	36	Y	Connection key (CompanyId)`Developers > Default settings > Connection key`
externalKey	String	36	Y	Employment type external key

Request body parameters

Parameter	Type	Capacity	Requirement status	Description
name	String	100	Y	Employment type name (Duplication is not allowed.)
i18nNames	Map		N	Localized employment type name`Map<Locale, String> i18nNames`
itemUsed	boolean		Y	Use status
sortOrder	String		Y	Display order of employment type

Request example

PUT https://workplace.apigw.ntruss.com/organization/apigw/v2/company/c1798784-9a47-4751-ab9f-b9629825ab93/empType/empTypeTest1

PUT /organization/apigw/v2/company/c1798784-9a47-4751-ab9f-b9629825ab93/empType/empTypeTest1
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=
{
        "sortOrder": "1",
        "itemUsed" : true,
        "name" : "Regular",
         "i18nNames": {
                "ko_KR" : "Regular",
                "en_US": "Permanent employment"
            }
 }

Response example

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
{
        "sortOrder": "1",
        "itemUsed" : true,
        "name" : "Regular",
         "i18nNames": {
                "ko_KR" : "Regular",
                "en_US": "Permanent employment"
            }
 }

Delete API

Deletes employment type information.

Request URL

DELETE https://workplace.apigw.ntruss.com/organization/apigw/v2/company/{companyId}/empType/{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	Capacity	Requirement status	Description
companyId	String	36	Y	Connection key (CompanyId)`Developers > Default settings > Connection key`
externalKey	String	36	Y	Employment type external key

Search employment type API

Searches employment type requested.

Request URL

GET https://workplace.apigw.ntruss.com/organization/apigw/v2/company/{companyId}/empType/{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	Capacity	Requirement status	Description
companyId	String	36	Y	Connection key`(CompanyId) Developers > Default settings > Connection key`
externalKey	String	36	Y	Employment type external key `Developers > Default settings > Connect Organization > Employment Type`

Request example

GET https://workplace.apigw.ntruss.com/organization/apigw/v2/company/c1798784-9a47-4751-ab9f-b9629825ab93/empType/apitestempType2

GET /organization/apigw/v2/company/c1798784-9a47-4751-ab9f-b9629825ab93/empType/apitestempType2
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=

Response example

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

{
  "tenantId": "c1798784-9a47-4751-ab9f-b9629825ab93",
  "companyId": "c1798784-9a47-4751-ab9f-b9629825ab93",
  "externalKey": "apitestempType2",
  "name": "Regular",
  "i18nNames": {
    "zh_CN": "",
    "ja_JP": "",
    "ko_KR": "Regular",
    "zh_TW": "",
    "en_US": "Permanent employment"
  },
  "sortOrder": 0,
  "itemUsed": true
}

Search employment type list API

Searches employment type list.

Request URL

GET https://workplace.apigw.ntruss.com/organization/apigw/v2/company/{companyId}/empType

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	Capacity	Requirement status	Description
companyId	String	36	Y	Connection key`(CompanyId) Developers > Default settings > Connection key`

Request parameters

Parameter	Type	Capacity	Requirement status	Description
offset	long		N	Display offset rows first
limit	long		N	Display as many as the number of limits

Request example

GET https://workplace.apigw.ntruss.com/organization/apigw/v2/company/c1798784-9a47-4751-ab9f-b9629825ab93/empType?offset=0&limit=10

GET /organization/apigw/v2/company/c1798784-9a47-4751-ab9f-b9629825ab93/empType?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=

Response example

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

{
    "elements": [
        {
            "tenantId": "c1798784-9a47-4751-ab9f-b9629825ab93",
            "companyId": "c1798784-9a47-4751-ab9f-b9629825ab93",
            "externalKey": "apitestempType2",
            "name": "Regular",
            "i18nNames": {
                "zh_CN": "",
                "ja_JP": "",
                "ko_KR": "Regular",
                "zh_TW": "",
                "en_US": "Permanent employment"
            },
            "sortOrder": 0,
            "itemUsed": true
        },
        {
            "tenantId": "c1798784-9a47-4751-ab9f-b9629825ab93",
            "companyId": "c1798784-9a47-4751-ab9f-b9629825ab93",
            "externalKey": "apitestempType3",
            "name": "Contract worker",
            "i18nNames": {
                "zh_CN": "",
                "ja_JP": "",
                "ko_KR": "",
                "zh_TW": "",
                "en_US": ""
            },
            "sortOrder": 1,
            "itemUsed": true
        },
        {
            "tenantId": "c1798784-9a47-4751-ab9f-b9629825ab93",
            "companyId": "c1798784-9a47-4751-ab9f-b9629825ab93",
            "externalKey": "empTypeTest1",
            "name": "Test employment type",
            "i18nNames": {
                "ko_KR": "Test employment type",
                "en_US": "testEmpType"
            },
            "sortOrder": 2,
            "itemUsed": false
        },
        {
            "tenantId": "c1798784-9a47-4751-ab9f-b9629825ab93",
            "companyId": "c1798784-9a47-4751-ab9f-b9629825ab93",
            "externalKey": "apitestempType1",
            "name": "Hourly",
            "i18nNames": {
                "zh_CN": "",
                "ja_JP": "",
                "ko_KR": "",
                "zh_TW": "",
                "en_US": ""
            },
            "sortOrder": 3,
            "itemUsed": true
        }
    ],
    "totalCount": 4
}

Response

Returned as an HTTP status code in the response body.

HTTP status code	Response message	Description
200	OK	General request made successfully
201	Created	Response code related to the success of resource creation
400	Bad Request	Used for failed general request
500	Internal Server Error	General server error. While 4xx error codes represent client-side errors, 5xx error codes represent server-side errors.

Response example

{
    "status": 400,
    "code": -4008,
    "errors": [],
    "message": "The same name already exists."
}

Was this article helpful?

What's Next

Employment types v1

Table of contents

Description
Addition API
Edit API
Delete API
Search employment type API
Search employment type list API
Response