| ClassIT+™ |
The Keyword Search method performs a search and retrieves Article, Index, Package, and Rule summaries.
See the following for more information:
| Note that this method only returns abbreviated descriptions and does not return class information. See ClassIT+ API Methods: Search By Article/Item Number for details on returning an item's full description along with class information. |
Endpoints
- Sandbox URL: https://Snbxapi-se.nmfta.org/api/v1.0/search/KeywordSearch
- Production URL: https://Api-se.classitplus.com/api/v1.0/search/KeywordSearch
Method Definition
- Http Method: POST
- Authorization header: Bearer JWT
Parameter Name, Description, and Data Type
| Parameter Name | Description | Data Type |
| keyword | The words or article number to search on. It can also be an article number. |
|
| criteria | How the search is performed. |
|
| scopes | The sections on which to search. |
|
| 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 |
Example Heading Levels
| The following table of sample code displays heading levels based on if the heading is the same or different from a keyword. |
| Heading Level | Sample Code |
| When the heading is the same as the keyword, so it is level 0. | { "articleNumbers": [ "1050" ], "keywords": [ "Abrasives - as listed" ], "heading": "Abrasives - as listed", "isHeading": true }, |
When the headings are different from keywords, so heading is at level 0 and the keywords are at level 1. |
{ "articleNumbers": [ "1050" ], "keywords": [ "Abrasive" ], "heading": "Belts", "isHeading": false }, { "articleNumbers": [ "131670" ], "keywords": [ "Cut-off", "abrasive disc type", "power", "other than hand" ], "heading": "Machinery or Machines", "isHeading": false } |
Method Result
Method Result Definition
| JSON Properties | Description | Data Type |
| Success | Identifies if the method call completed successfully. |
|
| TotalPages | Total Number of pages in search result. |
|
| CurrentPage | Current Page from the search result. |
|
| TotalCount | Total number of hits for the passed in search “keyword”. |
|
| 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. |
|
| heading | The heading the current index falls under. |
|
| 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. |
|
| 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. |
|
| 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. |
|
| referenceNumber | A unique number that identifies or tags a request. |
|
| message | Result message. |
|
Sample
|
For results that span multiple pages:
For example, if there are 3 pages of results, the results from page 1 are returned first. Next, enter the numbers 2 and then 3 for "pageNumber", in separate calls, to receive the results from those pages. Each "pageNumber" request counts toward your total number of calls/transactions. |
| 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...", "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": [], }
|