ClassIT+ API Methods: Keyword Search

The Keyword Search method performs a search and retrieves Article, Index, Package, and Rule summaries.

Method Definition

Http Method: POST

Authorization header: Bearer JWT

URL: <Environment URL>/KeywordSearch

Keyword Search Method Parameter Name, Description, and Data Type

Parameter Name	Description	Date Type
keyword	The words or article number to search on. It can also be an article number.	String Min. Length = 3 Max. Length = 100
criteria	How the search is performed.	String Valid Values: FullMatch PartialMatchIt It is not case-sensitive
scopes	The sections on which to search.	String Array Valid Values: Article Index Package Rule All It is not case=sensitive
page	If the search result has more than 25 hits, the result is broken into multiple pages. Use this parameter to retrieve a specific page from the search result.	Integer Min. Value = 1

Method Result

Search Method Result Definition

JSON Properties	Description	Data Type
Success	Identifies if the method call completed successfully.	Boolean
TotalPages	Total Number of pages in search result.	Integer
CurrentPage	Current Page from the search result.	Integer
TotalCount	Total number of hits for the passed in search “keyword”.	Integer
articles	List of matching Articles. Each record includes the following properties that describe the Article. articleNumber–Item number. description–Partial description. grouping–Denote if the article is a grouping header.	ArticleSearchResult Array Min Occurs = 0 Max Occurs = Unlimited
index	List of matching Articles. Each record includes the following properties that describe the Article. articleNumber–Item number. description–Partial description. grouping–Denote if the article is a grouping header.	IndexSearchResult Array Min Occurs = 0 Max Occurs = Unlimited
rule	List of matching Articles. Each record includes the following properties that describe the Article. articleNumber–Item number. description–Partial description. grouping–Denote if the article is a grouping header.	RuleSearchResult Array Min Occurs = 0 Max Occurs = Unlimited
package	List of matching Articles. Each record includes the following properties that describe the Article. articleNumber–Item number. description–Partial description. grouping–Denote if the article is a grouping header.	PackageSearchResult Array Min Occurs = 0 Max Occurs = Unlimited
referenceNumber	A unique number that identifies or tags a request.	String
message	Result message.	String

 

Sample

Sample Name	Sample Code
Sample Request JSON	{   "keyword": "Abrasives",   "criteria": "PartialMatch",   "scopes": ["Articles", "Index"],   "pagingParameters": {     "pageNumber": 1   } }
Sample Response JSON	{     "article": {         "searchHint": "Abrasives",         "articles": [             {                 "articleNumber": "1050",                 "description": "Abrasives, see Note, item 1051, viz.:Abrasive Belts;Abrasive Cloth or Paper, including Emery Cloth or Paper or Sandpaper;Abrasive Wheels;Bonded Abrasive Blocks;Crude or Lump;Flour or Grain;Refuse, including Broken Wheels, Wheel Stubs or Wheel Grindings;Sanding Pads, Sponges or Blocks;In bags, boxes or drums, subject to Item 170 and having a density in pounds per cubic foot of:",                 "grouping": null             }         ],         "totalMatch": 1     },     "index": {         "articleIndexes": [             {                 "articleNumbers": [                     "1050"                 ],                 "keywords": [                     "Abrasives - as listed"                 ],                 "isHeading": true             }         ],         "totalMatch": 1     },     "rule": null,     "package": null,     "referenceNumber": "3840d567d21746f981cd9b8caab3d181",     "success": true,     "message": [], }