고시 정보 조회 API

Description

고시 상품군 조회: [GET] https://sa2.esmplus.com/item/v1/official-notice/groups 상품군별 리스트 조회 : [GET] https://sa2.esmplus.com/item/v1/official-notice/groups/{officialNoticeNo}/codes

고시 상품군 및 리스트 조회하는 API 입니다. 상품 등록/수정시 해당되는 상품군 및 상품군 내 리스트 확인 후 정확한 정보 입력 해주시면 됩니다.

 

Request Description

상품군별 리스트 조회

항목	항목명	필수여부	Type	Description
officialNoticeNo	상품군 코드	Y	path	1 ~ 41 내 조회 가능

JSON
고시 상품군 조회 - URL만 호출 / Request Body 없음
[GET] https://sa2.esmplus.com/item/v1/official-notice/groups

상품군별 리스트 조회 - URL만 호출 / Request Body 없음
[GET] https://sa2.esmplus.com/item/v1/official-notice/groups/{officialNoticeNo}/codes

 

Response Description

고시 상품군 조회

항목	항목명	Type	Description
officialNoticeNo	상품군 코드	number
officialNoticeName	상품군명	string

상품군 리스트 조회

항목	항목명	Type	Description
officialNoticeItemelementCode	고시 상세 코드	string
officialNoticeItemelementName	고시 상세명	string
guideText	가이드	string
isExtraMark	필수 여부	boolean

JSON_Success

고시 상품군 조회
{
    "groups": [
        {
            "officialNoticeNo": number,
            "officialNoticeName": "string"
        }
    ]
}

상품군 리스트 조회
{
    "codes": [
        {
            "officialNoticeItemelementCode": "string",
            "officialNoticeItemelementName": "string",
            "guideText": "string",
            "isExtraMark": boolean
        }
    ]
}

JSON_Fail

{
   "resultCode": 0,
   "message": "string"
}

Sample Code_Success

고시 상품군 조회
{
    "groups": [
        {
            "officialNoticeNo": 1,
            "officialNoticeName": "의류"
        }
    ]
}

상품군 리스트 조회
{
    "codes": [
        {
            "officialNoticeItemelementCode": "41-1",
            "officialNoticeItemelementName": "제품명 및 살생물제품유형",
            "guideText": "",
            "isExtraMark": true
        }
    ]
}

Sample Code_Fail

{
    "resultCode": 2181,
    "message": "데이터 형식 nvarchar을(를) int(으)로 변환하는 중 오류가 발생했습니다."
}