Notice

---

➊ Heading List

(1) Interface Description

• URL : https://{domain}.oc.nhncloud.com/{serviceId}/api/v2/notice/categories.json

• URL(Real Test Environment) : https://{domain}.oc.beta-nhncloud.com/{serviceId}/api/v2/notice/categories.json

• URL(Development Test Environment) : https://{domain}.oc.alpha-nhncloud.com/{serviceId}/api/v2/notice/categories.json

Interface Name	Protocol	Request Format	Encoding	Response Format	Interface Description	접근제한 여부
Heading list	HTTPS	GET	UTF-8	JSON	Notice heading list	필요 없음

---

(2) Request Parameter

Name	Field (Parameter)	Type	Location	Required	Description
Service ID	serviceId	String	path	O	Service ID configured in the URL path
language code	language	String	query	X	Default language code of the Help Center

---

(3) Response Data

Name	Field (Parameter)	Type	Description
result.contents	categoryId	Integer	Heading ID
	parent	Integer	Parent heading ID (fixed value: 0)
	name	String	Heading name
	level	Integer	Depth (fixed value : 1)
	path	String	Depth path (fixed value : \\)
	orderNo	Integer	Sort order
	languages	Object	Multilingual heading names (language code : corresponding localized name)

---

(4) Response Body

{   
    "header": { 
        "resultCode": 200,  
        "resultMessage": "",    
        "isSuccessful": true    
    },  
    "result": { 
        "contents": [   
            {   
                "categoryId": 2543, 
                "parent": 0,    
                "name": "유형1",  
                "level": 1, 
                "path": "\\",   
                "orderNo": 0,   
                "languages": {  
                    "ko": "유형1",    
                    "th": "พิมพ์1", 
                    "ja": "タイプ1",   
                    "en": "Type1",  
                    "zh": "类型1" 
                }   
            },  
            {   
                "categoryId": 2544, 
                "parent": 0,    
                "name": "유형2",  
                "level": 1, 
                "path": "\\",   
                "orderNo": 1,   
                "languages": {  
                    "ko": "유형2",    
                    "th": "พิมพ์2", 
                    "ja": "タイプ2",   
                    "en": "Type2",  
                    "zh": "类型2" 
                }   
            },  
            {   
                "categoryId": 2545, 
                "parent": 0,    
                "name": "유형3",  
                "level": 1, 
                "path": "\\",   
                "orderNo": 2,   
                "languages": {  
                    "ko": "유형3",    
                    "th": "พิมพ์3", 
                    "ja": "タイプ3",   
                    "en": "Type3",  
                    "zh": "类型3" 
                }   
            }   
        ]   
    }   
}

---

➋ Tag List

(1) Interface Description

• URL: https://{domain}.oc.nhncloud.com/{serviceId}/api/v2/notice/tags.json

• URL(Real Test Environment) : https://{domain}.oc.beta-nhncloud.com/{serviceId}/api/v2/notice/tags.json

• URL(Development Test Environment): https://{domain}.oc.alpha-nhncloud.com/{serviceId}/api/v2/notice/tags.json

Interface Name	Protocol	Request Format	Encoding	Response Format	Interface Description	Access Restriction
Tag list	HTTPS	GET	UTF-8	JSON	Notice tag list	Not required

---

(2) Request Parameter

Name	Field (Parameter)	Type	Location	Required	Description
Service ID	serviceId	String	path	O	Service ID configured in the URL path
Tag keyword	language	String	query	X	Tag search keyword

---

(3) Response Data

Name	Field (Parameter)	Type	Description
result.contents	tagId	Integer	Tag ID
	tag	String	Tag name
	languages	Object	Multilingual tag names (language code : corresponding localized name)

---

(4) Resonse Body

{   
    "header": { 
        "resultCode": 200,  
        "resultMessage": "",    
        "isSuccessful": true    
    },  
    "result": { 
        "contents": [   
            {   
                "tagId": 391,   
                "tag": "태그1",   
                "languages": {  
                    "ko": "태그1",    
                    "th": "แท็ก1",  
                    "ja": "タグ1",    
                    "en": "Tag1",   
                    "zh": "标签1" 
                }   
            },  
            {   
                "tagId": 392,   
                "tag": "태그2",   
                "languages": {  
                    "ko": "태그2",    
                    "th": "แท็ก2",  
                    "ja": "タグ2",    
                    "en": "Tag2",   
                    "zh": "标签2" 
                }   
            }   
        ]   
    }   
}

---

➌ Notice List

(1) Interface description

• URL : https://{domain}.oc.nhncloud.com/{serviceId}/api/v2/notice/list.json

• URL(Real Test Environment) : https://{domain}.oc.beta-nhncloud.com/{serviceId}/api/v2/notice/list.json

• URL(Development Test Environment) : https://{domain}.oc.alpha-nhncloud.com/{serviceId}/api/v2/notice/list.json

Interface name	Protocol	Request Format	Encoding	Response Format	Interface description	Acess restriction
Notice list	HTTPS	GET	UTF-8	JSON	Helpcenter notice list	Common authentication

---

(2) Request parameter

Sort Parameter Format and Example

• Format: 필드1:정렬, 필드2:정렬, ...

• Example: isTOP:desc,createdDT:asc

• Default sort: isTop:desc,displayDt:desc,updatedDt:desc

Name	Field (Parameter)	Type	Location	Required	Description
Service ID	serviceId	String	path	O	Service ID configured in the URL path
Language code	language	String	query	X	Default helpcenter language of the service
Category ID	categoryId	Integer	query	X	Category ID
Tag ID	tagId	Integer	query	X	Tag ID
Keyword search	query	String	query	X	Keyword search (search scope: title, content)
Sort order	sort	String	query	X	Sorting is supported by the isTop, createdDt, and updateDt fields. For multi-field sorting, separate each sort condition with a comma (,). asc : ascending order, desc : descending order
Page	page	Integer	query	X	Default : 1
Items per page	pageSize	Integer	query	X	Default: 10; max=200

---

(3) Response Data

Name	Field (Parameter)	Type	Description
result.contents	noticeId	Integer	Notice ID
	categoryId	Integer	Notice category ID
	isTop	Boolean	Fixed posts (true: yes; false: no)
	title	String	Notice title
	content	String	Notice contents
	displayDt	String	Output date (yyyy.mm.dd)
	updatedDt	Long	Update date
	categoryName	String	Category name
	tagStr	Integer	Tag name
	isNew	String	New notice. true: Display(displayDt) today, false: Display not today
result	total	Integer	total items
	pages	Integer	Total page
	pageNum	Integer	page
	pageSize	Integer	Items per page

---

(4) Resonse Body

{   
    "header": { 
        "resultCode": 200,  
        "resultMessage": "",    
        "isSuccessful": true    
    },  
    "result": { 
        "contents": [   
            {   
                "noticeId": 1241,   
                "categoryId": 2543, 
                "isTop": true,  
                "title": "공지제목7",   
                "content": "공지내용7", 
                "displayDt": "2022.07.08",  
                "updatedDt": 1657243026000, 
                "categoryName": "유형1",  
                "tagStr": "태그2",    
                "isNew": false  
            },  
            {   
                "noticeId": 1246,   
                "categoryId": 2543, 
                "isTop": false, 
                "title": "공지제목11",  
                "content": "공지내용11",    
                "displayDt": "2022.07.08",  
                "updatedDt": 1657243165000, 
                "categoryName": "유형1",  
                "tagStr": "태그1",    
                "isNew": false  
            },  
            {   
                "noticeId": 1245,   
                "categoryId": 2543, 
                "isTop": false, 
                "title": "공지제목10",  
                "content": "공지내용10",    
                "displayDt": "2022.07.08",  
                "updatedDt": 1657243148000, 
                "categoryName": "유형1",  
                "tagStr": "태그1",    
                "isNew": false  
            },  
            {   
                "noticeId": 1244,   
                "categoryId": 2543, 
                "isTop": false, 
                "title": "공지제목9",   
                "content": "공지내용9", 
                "displayDt": "2022.07.08",  
                "updatedDt": 1657243129000, 
                "categoryName": "유형1",  
                "tagStr": "태그1",    
                "isNew": false  
            },  
            {   
                "noticeId": 1243,   
                "categoryId": 2543, 
                "isTop": false, 
                "title": "공지제목8",   
                "content": "공지내용8", 
                "displayDt": "2022.07.08",  
                "updatedDt": 1657243106000, 
                "categoryName": "유형1",  
                "tagStr": "태그1",    
                "isNew": false  
            },  
            {   
                "noticeId": 1240,   
                "categoryId": 2543, 
                "isTop": false, 
                "title": "공지제목6",   
                "content": "공지내용6", 
                "displayDt": "2022.07.08",  
                "updatedDt": 1657242949000, 
                "categoryName": "유형1",  
                "tagStr": "태그2",    
                "isNew": false  
            },  
            {   
                "noticeId": 1239,   
                "categoryId": 2543, 
                "isTop": false, 
                "title": "공지제목5",   
                "content": "공지내용5", 
                "displayDt": "2022.07.08",  
                "updatedDt": 1657242735000, 
                "categoryName": "유형1",  
                "tagStr": "태그1",    
                "isNew": false  
            },  
            {   
                "noticeId": 1238,   
                "categoryId": 2543, 
                "isTop": false, 
                "title": "공지제목4",   
                "content": "공지내용4", 
                "displayDt": "2022.07.08",  
                "updatedDt": 1657242576000, 
                "categoryName": "유형1",  
                "isNew": false  
            },  
            {   
                "noticeId": 1237,   
                "categoryId": 2545, 
                "isTop": false, 
                "title": "공지제목3",   
                "content": "공지내용3", 
                "displayDt": "2022.07.08",  
                "updatedDt": 1657242501000, 
                "categoryName": "유형3",  
                "tagStr": "태그1,태그2",    
                "isNew": false  
            },  
            {   
                "noticeId": 1236,   
                "categoryId": 2544, 
                "isTop": false, 
                "title": "공지제목2",   
                "content": "공지내용2", 
                "displayDt": "2022.07.08",  
                "updatedDt": 1657242420000, 
                "categoryName": "유형2",  
                "tagStr": "태그2",    
                "isNew": false  
            }   
        ],  
        "total": 11,    
        "pages": 2, 
        "pageNum": 1,   
        "pageSize": 10  
    }   
}

---

➍ Notice Details

(1) Interface description

• URL : https://{domain}.oc.nhncloud.com/{serviceId}/api/v2/notice/detail/{id}.json

• URL(Real Test Environment) : https://{domain}.oc.beta-nhncloud.com/{serviceId}/api/v2/notice/detail/{id}.json

• URL(Development Test Environment) : https://{domain}.oc.alpha-nhncloud.com/{serviceId}/api/v2/notice/detail/{id}.json

Interface Name	Protocol	Request Format	Encoding	Response Format	Interface Description	Access Restriction
Notice details	HTTPS	GET	UTF-8	JSON	Retrieve notice details by Notice ID	Not required

---

(2) Request parameter

Name	Field (Parameter)	Type	Location	Required	Description
Service ID	serviceId	String	path	O	Service ID configured in the URL path
Notice ID	id	Integer	path	O	Notice ID
Language code	language	String	query	X	Default helpcenter language of the service

---

(3) Response data

Name	Field (Parameter)	Type	Description
result.content	noticeId	Integer	Notice ID
	categoryId	Integer	Heading ID
	isTop	Boolean	Fixed posts (true: yes; false: no)
	title	String	Notice title
	content	String	Notice contents
	displayDt	String	Output date (yyyyMMddHHmmss)
	attachmentYn	Boolean	Include attachments (value: true = include, false = exclude)
	readCnt	Integer	views
	updatedDt	Long	Notice update date
	attachments	Array	Attachment of notice
	attachments.attachmentId	String	Attachment ID
	attachments.fileName	String	Attachment name
	attachments.contentType	String	Attachment type
	attachments.size	Long	Attachment size
	tags	Array	Notice tag
	tags.tagId	Integer	Tag ID
	tags.tag	String	Tag name
	categoryName	String	Heading name
	isNew	String	New notice. true: Display(displayDt) today, false: Display not today

---

(4) Resonse Body

{   
    "header": { 
        "resultCode": 200,  
        "resultMessage": "",    
        "isSuccessful": true    
    },  
    "result": { 
        "content": {    
            "noticeId": 1240,   
            "categoryId": 2543, 
            "isTop": true,  
            "title": "공지제목6",   
            "content": "<p>공지내용6</p>",  
            "displayDt": "2022.07.08",  
            "attachmentYn": "Y",    
            "readCnt": 5,   
            "updatedDt": 1658114209000, 
            "attachments": [    
                {   
                    "attachmentId": "42fb4c8801ed4c278475f70f531b8c92", 
                    "fileName": "logo_footer.png",  
                    "contentType": "image/png", 
                    "size": 1412    
                }   
            ],  
            "tags": [   
                {   
                    "tagId": 391,   
                    "tag": "태그1"    
                },  
                {   
                    "tagId": 392,   
                    "tag": "태그2"    
                }   
            ],  
            "categoryName": "유형1",  
            "isNew": false  
        }   
    }   
}

---

➎ Notice Attachement

(1) Interface description

• URL: https://{domain}.oc.nhncloud.com/{serviceId}/api/v2/notice/attachments/{id}

• URL(Real Test Environment) : https://{domain}.oc.beta-nhncloud.com/{serviceId}/api/v2/notice/attachments/{id}

• URL(Development Test Environment) : https://{domain}.oc.alpha-nhncloud.com/{serviceId}/api/v2/notice/attachments/{id}

Interface Name	Protocol	Request Format	Encoding	Response Format	Interface Description	Access Required
Open and download notice attachments	HTTPS	GET	UTF-8	JSON	Open and download notice attachments	Not required

---

(2) Request parameter

Name	Field (Parameter)	Type	Location	Required	Description
Service ID	serviceId	String	path	O	Service ID configured in the URL path
Attachment ID	id	String	path	O	attachement ID
Viewing method	type	String	query	X	Default: download , open: open)

---

(3) Reponse data

• File