Previous Topic: deleteCommentNext Topic: updateRating


rateDocument

The following parameters apply to the rateDocument method:

Parameter

Type

Description

SID

Integer

Identifies the session retrieved from logging in.

docId

Integer

Identifies the document ID to rate.

rating

Integer

Identifies the rating to give the document (a scale of 0-4, where 0 is the worst and 4 is the best).

multiplier

Integer

Identifies the multiplier parameter. This parameter can be used to simulate many ratings at once. Use the default of 1 for a single rating and any other number for multiples.

For example, if you submit 3, it acts as if you called the method 3 times. Three ratings with the value you supplied in the rating parameter is added to the database.

ticketPerId

String

Identifies the persistent ID of a ticket related to this Knowledge document.

onTicketAccept

Boolean

Identifies whether the document was accepted as a solution for the ticket.

solveUserProblem

Boolean

Identifies whether this document solved the user's problem. It signifies how the user responded to the question "Did this document
solve your problem?" on the Solution Survey.

isDefault

Boolean

Indicates a default rating status. If you are setting the rating just because the user viewed the document and not because he actually rated it, set this to True. This is used for reporting reasons.

Description

Rates a particular document.

Returns

A <UDSObject> node with the following <Attributes> children nodes describing the rating BU_TRANS :

XML Element Value

Data Type

Description

id

Integer

Identifies the unique identifier for the rating most recently added. Use this with the updateRating() method if you want to modify the rating at a later time.

DOC_ID

Integer

Identifies the document ID.

INDEX_ID

Integer

Identifies the category ID.

BU_RATING

String

Identifies the rating given to the document.

HIT_NO_VOTE

Integer

Identifies the rating set because a user viewed the document and not actually rated it, or vice versa.