hcsapi 1.16.0

자가진단 자동화 비공식 Api (Automation tool for https://hcs.eduro.go.kr/)

hcsapi

📥다운로드

git을 통해 리포지토리 코드를 설치하실 수 있습니다.

윈도우나 리눅스의 터미널에서 다음과 같이 입력합니다.

python -m pip install -U pip
pip install hcsapi

또는

python -m pip install -U pip
pip install git+https://github.com/hcsapi/hcsapi.git@main

업데이트 pip install hcsapi --upgrade

🤖사용 방법

이곳의 예제를 참고하세요.

지원하는 모든 지역이름 보기

지원하는 지역 이름은 다음과 같습니다:

'서울', '서울시', '서울교육청', '서울시교육청', '서울특별시'
'부산', '부산광역시', '부산시', '부산교육청', '부산광역시교육청'
'대구', '대구광역시', '대구시', '대구교육청', '대구광역시교육청'
'인천', '인천광역시', '인천시', '인천교육청', '인천광역시교육청'
'광주', '광주광역시', '광주시', '광주교육청', '광주광역시교육청'
'대전', '대전광역시', '대전시', '대전교육청', '대전광역시교육청'
'울산', '울산광역시', '울산시', '울산교육청', '울산광역시교육청'
'세종', '세종특별시', '세종시', '세종교육청', '세종특별자치시', '세종특별자치시교육청'
'경기', '경기도', '경기교육청', '경기도교육청'
'강원', '강원도', '강원교육청', '강원도교육청'
'충북', '충청북도', '충북교육청', '충청북도교육청'
'충남', '충청남도', '충남교육청', '충청남도교육청'
'전북', '전라북도', '전북교육청', '전라북도교육청'
'전남', '전라남도', '전남교육청', '전라남도교육청'
'경북', '경상북도', '경북교육청', '경상북도교육청'
'경남', '경상남도', '경남교육청', '경상남도교육청'
'제주', '제주도', '제주특별자치시', '제주교육청', '제주도교육청', '제주특별자치시교육청', '제주특별자치도'

지원하는 모든 학교종류 보기

지원하는 학교급 이름은 다음과 같습니다:

'유치원', '유','유치'
'초등학교', '초','초등'
'중학교', '중','중등'
'고등학교', '고','고등'
'특수학교', '특','특수','특별'

↩️리턴값

모든 리턴값은 Dict로 반환됩니다.
리턴값 구조는 다음과 같습니다:

{"error":Boolean(True,False),'code':"처리코드(밑의 처리코드 종류 참조)","message":"해당 에러나, 성공 상황에 대한 설명"}

처리코드 종류

성공 = "SUCCESS"
존재하지 않는 지역, 학교급 = "FORMET"
학교 검색 실패 = "NOSCHOOL"
학생 검색 실패 = "NOSTUDENT"
알 수 없는 에러 = "UNKNOWN"

💡 TIP

리턴값의 'code' 를 이용하시면 성공, 실패 여부, 실패 이유를 모두 알 수 있습니다.
또한 'message'로 이용자에게 바로 실패 이유를 알릴 수 있습니다.

원본 소스의 저작권은 331leo님에게 있습니다. 코드 일부분(transkey 부분)의 저작권은 blluv 님에게 있습니다.