휴직 구분 설정 v1
- 인쇄
- PDF
휴직 구분 설정 v1
- 인쇄
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
설명
고객사의 인사정책에 따른 휴직 구분을 설정 및 조회하는 API입니다.
휴직 구분 생성 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"
}
}
휴직 구분 목록 조회 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 | 네이버 클라우드 플랫폼 포털에서 발급받은 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
}
]
}
응답
HTTP 상태 코드로 리턴되고, Body 정보로 전달한다.
HTTP 상태 코드 | 응답 메시지 | 설명 |
---|---|---|
200 | OK | 일반적인 요청 성공 |
201 | Created | 리소스 생성 성공에 대한 응답 코드 |
400 | Bad Request | 일반적인 요청 실패에 사용(대체로 서버가 이해할 수 없는 형식의 요청이 왔을 때 응답하기 위해 사용) |
500 | Internal Server Error | - 일반적인 서버 오류에 대한 응답 코드 4XX대의 오류 코드가 클라이언트 측 오류를 나타내기 위해 사용된다면, 5XX대의 오류 코드는 서버 측 오류를 나타내기 위해 사용됨 |
이 문서가 도움이 되었습니까?