Please enable JavaScript to view this site.

iService API Documentation

Navigation: iService API Forms > Customer Portal

Manage Knowledge Base Articles (api=manage)

Scroll Prev Top Next More

Purpose

 

The manage API is used to display article lists in the knowledge base.

 

UI Reference: The API is called when a user clicks on a topic name in the knowledge base.

 

URI: webapp-api-findanswer?api=manage

 

Access Rights Required:  

 

 

Request

 

 

Request Parameters

Name

Type

Description

pageNum

String

This parameter represents current page no.

perPage

String

This parameter represents how many records we want in one page.

recursive

Boolean

True to fetch the children of the selected topic.

pageAction

String

This parameter represents the action name which is performed from the page.

 

 

Request Payload Example

{
    "pageNum": 1,
    "perPage": 2500,
    "recursive": true,
    "_pageAction": "FindAnswerArticles"
}

 

Response

 

 

Response Parameters

Name

Type

Description

errors

Array

This represents the list of errors.

errorDetails

Array

This represents the list of error details.

articles

Array

An array of strings. The details for an article are contained in this array.

articles[].id

String

The ID of the article.

articles[].subject

String

The subject of the article (similar to subject of an email)

articles[].date

String

The date the article was updated

articles[].rating

String

The user rating for the article on a scale of 1 to 5.

articles[].topicID

String

This has the value of topic id in which article belongs to .

articles[].topicName

String

This has the value of  topic name in which article belongs to .

articles[].viewCount

String

This has total view count of article.

articles[].public

String

Shows if an article is public or not.

 

 

Response example

{
    "errors": [],
    "errorDetails": [],
    "articles": [
        {
            "id": "1337",
            "subject": "Action mode",
            "date": "2009-01-21T06:20:03.5130000Z",
            "rating": "0.0",
            "topicID": "37",
            "topicName": "Cameras",
            "viewCount": "422",
            "public": "public"
        },{...}
    ]
}

 

© 2008 - 2022 One-to-One Service.com, Inc. All rights reserved.