Please enable JavaScript to view this site.

iService API Documentation

Navigation: iService API Forms > Customer Portal

Search KB articles (api=articles)

Scroll Prev Top Next More

Purpose

 

The articles API is used to display  all KB articles in the database.

 

UI Reference: The API is called when the ''search selected topics'' button is clicked on the Knowledge Base page.

 

URI: webapp-api-findanswer?api=articles

 

Access Rights Required:  

 

 

Request

 

 

Request Parameters

Name

Type

Description

topicID

String

This returns the id of the topic.

pageNum

Integer

This parameter represents current page no.

perPage

Integer

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

recursive

Boolean


searchString

String


pageAction

String

This parameter represents the action name which was performed.

 

 

 

Request Payload Example

{
    "topicID": "",
    "pageNum": 1,
    "perPage": 1000,
    "recursive": false,
    "searchString": "Best camera for travelers",
    "_pageAction": "GetArtclies"
}

 

 

 

Response

 

 

Response Parameters

Name

Type

Description

errors

Array

An array of strings. Returns the error message if an error is encountered, otherwise a blank array if there is no error.

errorDetails

Array

An array of strings. Provides detailed information about the error encountered, otherwise returns a blank array if no error is encountered.

interactions

Array

This returns a list of objects with all interaction details.

interactions[].id

String

This returns the id of interaction.

interactions[].subject

String

This returns the subject of interaction.

interactions[].date

String

This returns the date of interaction.

interactions[].topicID

String

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

interactions[].topicName

String

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

interactions[].rating

String


interactions[].viewCount

String

This has the total view count of interaction.

interactions[].properties

Array

Property details, see property values

interactions[].public

Array

Shows if an article is public or not.

 

 

 

Response Example

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

 

 

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