Virima API Specification - SearchService Services
The requests documented in this section are directed to
SearchService resources, which represent .
search POST Interface
Method: POST
Relative URL: global/search
Request Headers: Accept, Authorization
Response Headers: Content-Length, Content-Type.
Request Structure:
Field Name | Type | Description |
---|
input | SearchInput | |
Response Structure:
Field Name | Type | Description |
---|
resp | Response | |
Example Request:
SEARCH
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
"type":"?",
"term":"?",
"field":"?"
}
Example Response:
{
"id":205938957,
"response":"?"
}
searchKnowledgeArticles POST Interface
Method: POST
Relative URL: global/search-articles
Request Headers: Accept, Authorization
Response Headers: Content-Length, Content-Type.
Request Structure:
Field Name | Type | Description |
---|
input | SearchInput | |
Response Structure:
Field Name | Type | Description |
---|
resp | Response | |
Example Request:
SEARCHKNOWLEDGEARTICLES
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
"type":"?",
"term":"?",
"field":"?"
}
Example Response:
{
"id":2014925217,
"response":"?"
}