休職区分設定

印刷する
共有
PDF

休職区分設定

印刷する
共有
PDF

Article Summary

Share feedback

Thanks for sharing your feedback!

説明

顧客社の人事ポリシーによる休職区分を設定及び照会するAPIです。

代表管理者であるかを社員別に照会するAPI

全体休職区分リストを照会する。

リクエストURL

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

リクエストヘッダ

ヘッダ名	説明
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 > 基本設定 > 連携キー`

リクエスト例示

GET https://workplace.apigw.ntruss.com/organization/apigw/v1/company/187d83ad-4038-45b6-8e7c-59eca16fdc46/settingLeave

レスポンス例示

{
    "timestamp": "2019-12-13 17:51:11",
    "status": 200,
    "error": null,
    "message": null,
    "path": "/organization/apigw/v1/company/aecd6274-e826-4f85-88ee-e46668f46941/settingLeave",
    "body": [
        {
            "tenantId": "aecd6274-e826-4f85-88ee-e46668f46941",
            "companyId": "aecd6274-e826-4f85-88ee-e46668f46941",
            "name": "育児休職",
            "i18nNames": {
                "zh_CN": "产假",
                "ja_JP": "育児休職",
                "ko_KR": "육아휴직",
                "zh_TW": "育嬰假",
                "en_US": "Maternity leave"
            },
            "payYn": "PAID",
            "workDcalcYn": "Y",
            "externalKey": null,
            "sortOrder": "1",
            "tid": null
        },
        {
            "tenantId": "aecd6274-e826-4f85-88ee-e46668f46941",
            "companyId": "aecd6274-e826-4f85-88ee-e46668f46941",
            "name": "業務上傷病休職",
            "i18nNames": {
                "zh_CN": "业务上病假",
                "ja_JP": "業務上傷病休職",
                "ko_KR": "업무상상병휴직",
                "zh_TW": "因公傷休假",
                "en_US": "Sick Leave caused on the job"
            },
            "payYn": "PAID",
            "workDcalcYn": "Y",
            "externalKey": null,
            "sortOrder": "2",
            "tid": null
        }
    ]
}

休職区分作成API

休職区分設定を作成する。

リクエストURL

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

リクエストPathパラメータ

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

リクエストBodyパラメータ

パラメータ	タイプ	サイズ	必須	説明
name	String	100	Y	属性名
i18nNames	Map		N	属性多国語名Map<Locale, String> i18nNames
payYn	String		Y	給与反映区分
workDcalcYn	String		N	勤務日数算定区分
sortOrder	Int		N	順番

リクエスト例示

POST https://workplace.apigw.ntruss.com/organization/apigw/v1/company/e721e2da-29ee-4782-9672-3d2b150ac1a6/settingLeave/absenceleaveExternalkey

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-v1:WTPItrmMIfLUk/UyUIyoQbA/z5hq9o3G8eQMolUzTEo=
{
	"tenantId" : "e721e2da-29ee-4782-9672-3d2b150ac1a6",
	"companyId" : "e721e2da-29ee-4782-9672-3d2b150ac1a6",
	"name" : "安息休職",
	"i18nNames" : {
		"en_US" : "restLeaveAbsence"
	},
	"payYn" : "PAID",
	"workDcalcYn" : "Y",
	"sortOrder" : 10
}

レスポンス例示

{
    "timestamp": "2019-12-13 18:07:54",
    "status": 200,
    "error": null,
    "message": null,
    "path": "/organization/apigw/v1/company/e721e2da-29ee-4782-9672-3d2b150ac1a6/settingLeave/absenceleaveExternalkey",
    "agsettingLeaveVO": {
        "tenantId": "e721e2da-29ee-4782-9672-3d2b150ac1a6",
        "companyId": "e721e2da-29ee-4782-9672-3d2b150ac1a6",
        "name": "安息休職",
        "i18nNames": {
            "en_US": "restLeaveAbsence"
        },
        "payYn": "PAID",
        "workDcalcYn": "Y",
        "externalKey": "absenceleaveExternalkey",
        "sortOrder": "10",
        "tid": "absenceleaveExternalkey"
    },
    "body": {
        "tenantId": "e721e2da-29ee-4782-9672-3d2b150ac1a6",
        "companyId": "e721e2da-29ee-4782-9672-3d2b150ac1a6",
        "name": "安息休職",
        "i18nNames": {
            "en_US": "restLeaveAbsence"
        },
        "payYn": "PAID",
        "workDcalcYn": "Y",
        "externalKey": "absenceleaveExternalkey",
        "sortOrder": "10",
        "tid": "absenceleaveExternalkey"
    }
}

休職区分修正API

休職区分設定を修正する。

リクエストURL

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

リクエストPathパラメータ

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

リクエストBodyパラメータ

パラメータ	タイプ	サイズ	必須	説明
name	String	100	Y	属性名
i18nNames	Map		N	属性多国語名Map<Locale, String> i18nNames
payYn	String		Y	給与反映区分
workDcalcYn	String		N	勤務日数算定区分
sortOrder	Int		N	順番

リクエスト例示

PUT https://workplace.apigw.ntruss.com/organization/apigw/v1/company/e721e2da-29ee-4782-9672-3d2b150ac1a6/settingLeave/absenceleaveExternalkey

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-v1:WTPItrmMIfLUk/UyUIyoQbA/z5hq9o3G8eQMolUzTEo=
{
	"tenantId" : "e721e2da-29ee-4782-9672-3d2b150ac1a6",
	"companyId" : "e721e2da-29ee-4782-9672-3d2b150ac1a6",
	"name" : "安息休職修正",
	"i18nNames" : {
		"en_US" : "restLeaveAbsenceV2"
	},
	"payYn" : "NPAID",
	"workDcalcYn" : "N",
	"sortOrder" : 20
}

レスポンス例示

{
    "timestamp": "2019-12-13 18:07:54",
    "status": 200,
    "error": null,
    "message": null,
    "path": "/organization/apigw/v1/company/e721e2da-29ee-4782-9672-3d2b150ac1a6/settingLeave/absenceleaveExternalkey",
    "agsettingLeaveVO": {
        "tenantId": "e721e2da-29ee-4782-9672-3d2b150ac1a6",
        "companyId": "e721e2da-29ee-4782-9672-3d2b150ac1a6",
        "name": "安息休職修正",
        "i18nNames": {
            "en_US": "restLeaveAbsenceV2"
        },
        "payYn": "PAID",
        "workDcalcYn": "Y",
        "externalKey": "absenceleaveExternalkey",
        "sortOrder": "10",
        "tid": "absenceleaveExternalkey"
    },
    "body": {
        "tenantId": "e721e2da-29ee-4782-9672-3d2b150ac1a6",
        "companyId": "e721e2da-29ee-4782-9672-3d2b150ac1a6",
        "name": "安息休職修正",
        "i18nNames": {
            "en_US": "restLeaveAbsenceV2"
        },
        "payYn": "PAID",
        "workDcalcYn": "Y",
        "externalKey": "absenceleaveExternalkey",
        "sortOrder": "10",
        "tid": "absenceleaveExternalkey"
    }
}

休職区分削除API

休職区分設定を削除する。

リクエストURL

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

リクエストPathパラメータ

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

リクエストPathパラメータ

パラメータ	タイプ		サイズ	必須	説明
companyId	String		36	Y	連携キー(CompanyId)
externalKey	String		36	Y	休職区分キー(externalKey)

リクエスト例示

DELETE https://workplace.apigw.ntruss.com/organization/apigw/v1/company/e721e2da-29ee-4782-9672-3d2b150ac1a6/settingLeave/absenceleaveExternalkey22

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-v1:WTPItrmMIfLUk/UyUIyoQbA/z5hq9o3G8eQMolUzTEo=
{
    "timestamp": "2019-12-13 18:33:03",
    "status": 200,
    "error": null,
    "message": null,
    "path": "/organization/apigw/v1/company/e721e2da-29ee-4782-9672-3d2b150ac1a6/settingLeave/absenceleaveExternalkey22",
    "agsettingLeaveVO": {
        "tenantId": "e721e2da-29ee-4782-9672-3d2b150ac1a6",
        "companyId": "e721e2da-29ee-4782-9672-3d2b150ac1a6",
        "name": "安息休職修正",
        "i18nNames": {
            "en_US": "restLeaveAbsenceV2"
        },
        "payYn": "NPAID",
        "workDcalcYn": "N",
        "externalKey": "absenceleaveExternalkey",
        "sortOrder": null,
        "tid": "absenceleaveExternalkey"
    },
    "body": {
        "tenantId": "e721e2da-29ee-4782-9672-3d2b150ac1a6",
        "companyId": "e721e2da-29ee-4782-9672-3d2b150ac1a6",
        "name": "安息休職修正",
        "i18nNames": {
            "en_US": "restLeaveAbsenceV2"
        },
        "payYn": "NPAID",
        "workDcalcYn": "N",
        "externalKey": "absenceleaveExternalkey22",
        "sortOrder": null,
        "tid": "absenceleaveExternalkey22"
    }
}

レスポンス例示

{
    "timestamp": "2019-12-15 23:51:03",
    "status": 200,
    "error": null,
    "message": null,
    "path": "/organization/apigw/v1/company/e721e2da-29ee-4782-9672-3d2b150ac1a6/settingLeave/absenceleaveExternalkey22",
    "agsettingLeaveVO": {
        "tenantId": "e721e2da-29ee-4782-9672-3d2b150ac1a6",
        "companyId": "e721e2da-29ee-4782-9672-3d2b150ac1a6",
        "name": "安息休職修正",
        "i18nNames": {
            "en_US": "restLeaveAbsenceV2"
        },
        "payYn": "NPAID",
        "workDcalcYn": "N",
        "externalKey": "absenceleaveExternalkey22",
        "sortOrder": null,
        "tid": "absenceleaveExternalkey22"
    },
    "body": {
        "tenantId": "e721e2da-29ee-4782-9672-3d2b150ac1a6",
        "companyId": "e721e2da-29ee-4782-9672-3d2b150ac1a6",
        "name": "安息休職修正",
        "i18nNames": {
            "en_US": "restLeaveAbsenceV2"
        },
        "payYn": "NPAID",
        "workDcalcYn": "N",
        "externalKey": "absenceleaveExternalkey22",
        "sortOrder": null,
        "tid": "absenceleaveExternalkey22"
    }
}

レスポンス

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

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

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

What's Next

休職区分の設定v2

説明
代表管理者であるかを社員別に照会するAPI
休職区分作成API
休職区分修正API
休職区分削除API
レスポンス

タグ

WORKPLACE