<aside> 💡 Lemonbase OpenAPI의 Error Code입니다. 요청이 실패할 경우, 아래의 body 형태와 Error Code 표를 참조 바랍니다.

</aside>

기본 body 형태

{
	"error": { // error라는 key가 없는 경우, 정상 응답임을 확인 가능
		"code": "INVALID_VALUES",
		"message": "입력하신 구성원 정보가 올바르지 않습니다. ",
		"details": null // 추후 상세 사유를 개발자 친화적으로 전달하기 위함
  }
}

bulk API body 형태

persons/bulk

{
    "error": {
        "code": "VALIDATION_ERROR",
        "message": "요청 본문에 포함된 파라미터가 올바르지 않습니다. 자세한 내용은 “details” 속성을 확인하세요.",
        "details": {
						// bulk API의 경우, "VALIDATION_ERROR" 등 일부 code에
						// results field로 list 형태로 발생한 error를 묶어서 보낼 수 있음
            "results": [
                {
                    "email": "[email protected]", // 문제가 발생한 email
                    "code": "DUPLICATED_EMPLOYEE_NUMBER",
                    "message": "이미 등록된 사번을 가진 구성원이 존재합니다."
                }
            ]
        }
    }
}

organizations/bulk

{
    "error": {
        "code": "VALIDATION_ERROR",
        "message": "요청 본문에 포함된 파라미터가 올바르지 않습니다. 자세한 내용은 “details” 속성을 확인하세요.",
        "details": {
						// bulk API의 경우, "VALIDATION_ERROR" 등 일부 code에
						// results field로 list 형태로 발생한 error를 묶어서 보낼 수 있음
            "results": [
                {
                    "organization_code": "3989", // 문제가 발생한 organization_code
                    "code": "INVALID_PARENT_ORGANIZATION_CODE",
                    "message": "존재하지 않거나 잘못 입력된 상위 조직 코드입니다."
                },
            ]
        }
    }
}

Code 일람(기본)

Untitled

Code 일람(VALIDATION_ERROR 상세)

Untitled