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


➋ 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


➌ 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


➍ 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


➎ 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

Last updated