사원부여 자동 부여 설정

설명

고객사의 사원번호 자동부여 정보를 WOKPLACE[k]에서 설정하기 위한 API입니다.

등록/수정 API

사원번호 자동부여 정보를 설정한다.

요청 URL

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

요청 헤더

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

요청 Body 파라미터

파라미터 타입 크기 필수 여부 설명
autoNoYn String 1 Y 사번자동부여여부(Y/N)
prefixUseYn String 1 Y 사용여부(Y/N)
prefix String 5 N 사번PREFIX
seqLength Int 10 N 사번자리수

요청 예시

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

PUT /organization/apigw/v1/company/e721e2da-29ee-4782-9672-3d2b150ac1a6/autono
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=
{
 "autoNoYn" : "Y",
 "prefixUseYn" : "Y",
 "prefix" : "ABC",
 "seqLength" : 5
}

응답 예시

{
    "timestamp": "2019-12-13 17:48:50",
    "status": 200,
    "error": null,
    "message": null,
    "path": "/organization/apigw/v1/company/e721e2da-29ee-4782-9672-3d2b150ac1a6/autono",
    "body": {
        "companyId": "e721e2da-29ee-4782-9672-3d2b150ac1a6",
        "prefix": "ABC",
        "seqLength": "5",
        "prefixUseYn": "Y",
        "autoNoYn": "Y"
    }
}

전체 리스트 API

설정한 사원번호 자동부여 여부를 설정한다.

요청 URL

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

요청 헤더

헤더명 설명
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/e721e2da-29ee-4782-9672-3d2b150ac1a6/autono

응답 예시

{
    "timestamp": "2019-12-13 17:50:26",
    "status": 200,
    "error": null,
    "message": null,
    "path": "/organization/apigw/v1/company/e721e2da-29ee-4782-9672-3d2b150ac1a6/autono",
    "body": {
        "companyId": "e721e2da-29ee-4782-9672-3d2b150ac1a6",
        "prefix": "ABC",
        "seqLength": "5",
        "prefixUseYn": "Y",
        "autoNoYn": "Y"
    }
}

응답

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

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