기본정보설정

설명

회사의 인사 정책에 따라 사원의 속성 정보를 설정할 수 있는 API입니다.
직급이나 직책 등 사원정보 항목 사용여부를 선택적으로 설정할 수 있고,
‘사용’으로 설정된 항목은 사원정보 입력 시에 보여지게 되며, 사원검색결과에 노출여부를 설정하여 검색용 정보로 활용할 수 있도록 API를 제공한다.

수정 API

기본속성설정 정보를 설정 한다.

요청 URL

PUT https://workplace.apigw.ntruss.com/organization/apigw/v1/company/{companyId}/basicattr/{attrId}

요청 헤더

헤더명 설명
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 > 기본 설정 > 연동키
attrId String 36 Y attr ID

요청 Body 파라미터

파라미터 타입 크기 필수 여부 설명
useYn String 1 Y 사용유무
searchDispYn String 1 Y 사원검색 노출여부

요청 예시

PUT https://workplace.apigw.ntruss.com/organization/apigw/v1/company/578c7009-bdad-4493-9835-72302cf988c6/basicattr/grade

POST /organization/apigw/v1/company/578c7009-bdad-4493-9835-72302cf988c6/basicattr/grade
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=
{
    "useYn": "N",
    "searchDispYn": "N"
}

응답 예시

HTTP/1.1 200 OK
Server: nginx
Date: Wed, 12 Sep 2018 10: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

{
    "useYn": "N",
    "searchDispYn": "N"
}

전체 리스트 API

설정한 추가정보 전체 리스트를 가져온다.

요청 URL

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

요청 헤더

헤더명 설명
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 > 기본 설정 > 연동키

응답 예시

HTTP/1.1 200 OK
Server: nginx
Date: Wed, 12 Sep 2019 12:13:42 GMT
Content-Type: application/json;charset=utf-8
Transfer-Encoding: chunked
Connection: keep-alive
Access-Control-Allow-Origin: *
x-ncp-trace-id: 68d1o68pm4cr63gc3169gm4p34
[
    {
        "attrId": "ETRCOYMD",
        "useYn": "Y",
        "searchDispYn": "N"
    },
    {
        "attrId": "EMPSTAT",
        "useYn": "Y",
        "searchDispYn": "N"
    },
    {
        "attrId": "EMPTYPE",
        "useYn": "Y",
        "searchDispYn": "N"
    },
    {
        "attrId": "GRADE",
        "useYn": "Y",
        "searchDispYn": "Y"
    },
    {
        "attrId": "JOB",
        "useYn": "Y",
        "searchDispYn": "Y"
    },
    {
        "attrId": "PLACE",
        "useYn": "Y",
        "searchDispYn": "N"
    },
    {
        "attrId": "REPORTS_TO",
        "useYn": "N",
        "searchDispYn": "N"
    },
    {
        "attrId": "EMPNO",
        "useYn": "Y",
        "searchDispYn": "Y"
    },
    {
        "attrId": "BIRTH",
        "useYn": "Y",
        "searchDispYn": "N"
    },
    {
        "attrId": "CPH_NO",
        "useYn": "Y",
        "searchDispYn": "Y"
    },
    {
        "attrId": "TEL_NO",
        "useYn": "Y",
        "searchDispYn": "Y"
    },
    {
        "attrId": "EMAIL",
        "useYn": "Y",
        "searchDispYn": "Y"
    },
    {
        "attrId": "EXT_EMAIL",
        "useYn": "Y",
        "searchDispYn": "N"
    },
    {
        "attrId": "DEPT",
        "useYn": "Y",
        "searchDispYn": "Y"
    }
]

응답

HTTP 상태 코드로 리턴되고, Body 정보로 전달한다.

HTTP 상태 코드 응답 메시지 설명
200 OK 일반적인 요청 성공
201 Created 리소스 생성 성공에 대한 응답 코드
400 Bad Request 일반적인 요청 실패에 사용(대체로 서버가 이해할 수 없는 형식의 요청이 왔을 때 응답하기 위해 사용)
500 Internal Server Error 일반적인 서버 오류에 대한 응답 코드. 4XX대의 오류 코드가 클라이언트 측 오류를 나타내기 위해 사용된다면,
5XX대의 오류 코드는 서버 측 오류를 나타내기 위해 사용됩니다.

제공되는 기본속성 attrId

attrId 사용여부 설정 설명
ETRCOYMD Y(사용여부 수정불가) 입사일
EMPSTAT Y(사용여부 수정불가) 재직상태
EMPTYPE Y(사용여부 수정불가) 고용형태
GRADE Y/N 직급
JOB Y/N 직책
PLACE Y(사용여부 수정불가) 사업장
REPORTS_TO Y/N Reports To
EMPNO Y/N 사원번호
BIRTH Y/N 생년월일
CPH_NO Y/N 휴대폰
TEL_NO Y/N 회사 전화번호
EMAIL Y(사용여부 수정불가) 업무메일
EXT_EMAIL Y(사용여부 수정불가) 개인메일