Please enable JavaScript to view this site.

iService API Documentation

Navigation: iService API Forms > Customer Portal

List Knowledge Base Article Details (api=details)

Scroll Prev Top Next More

Purpose

 

The details API is used to get details for a single article.

 

UI Reference: The API is called when an article is selected from a list of articles.

 

URI: webapp-api-findanswer?api=details

 

Access Rights Required:  

 

 

Request

 

 

Request Parameters

Name

Type

Description

articleID

String

The ID of the article.

pageAction

String

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

 

 

Request Payload Example

{
    "articleID": "45224",
    "_pageAction": "FindAnswerDetails"
}

 

 

Response

 

 

Response Parameters

Name

Type

Description

id

String

The id of interaction.

subject

String

The subject of the interaction.

date

String

The date the interaction was created.

questionHtml

String

This returns a question which has been mentioned in mail.

answerHtml

String

This returns a answer which has been mentioned in mail.

topicID

String

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

isPublic

String

Shows if an article is public or not.

creatorName

String

Name of the creator of an article.

rating

String

The average user rating for the article.

viewCount

String

The number of times an article has been viewed.

attachments

Array

An array of attachments which are included with the interaction.

properties

Array

This returns all properties and their values if property value set in interaction.see property values

propertiesEdit

Array

Some users have the ability to edit article properties.

isSubscribed

Boolean

Logged in users can subscribe to articles and receive updates when they are changed.

 

 

Response Example

{
    "id": "45224",
    "subject": "Optio et voluptatem",
    "date": "2021-09-29T12:08:33.6170000Z",
    "questionHtml": "What's your name?",
    "answerHtml": "This is Shuvo.",
    "topicID": "1",
    "isPublic": "public",
    "creatorName": "e-shop Administrator",
    "rating": "0.0",
    "viewCount": "0",
    "attachments": [],
    "properties": [],
    "propertiesEdit": [],
    "isSubscribed": false
}

 

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