| ClassIT+™ |
The Keyword Relevant Search method performs a keyword search across the classification and returns the most relevant matching articles, index entries, rules, and packages, along with the total number of matches found in each category.
Method Definition
Http Method: POST
Authorization header: Bearer JWT
URL: https://Snbxapi-se.nmfta.org/api/v1.0/search/KeywordRelevantSearch
Keyword Relevant Search Method Parameter Name, Description, and Data Type
| Parameter Name | Description | Data Type |
| keyword | Keyword or phrase to search for (for example, an article name or description). |
|
| criteria | The match criteria used when comparing the keyword to the classification content. |
|
| scopes | The categories to include in the search. Only the categories listed are returned in the result. |
|
| pagingParameters | Paging settings that control which page of results is returned for each category. |
|
Method Request
Keyword Relevant Search Method JSON Request
| Result Status | Result JSON String |
| Http Method | POST |
| Body |
{ "keyword": "Paper", "criteria": "PartialMatch", "scopes": ["Articles", "Index", "Rule", "Package"], "pagingParameters": { "pageNumber": 1, "pageSize": 20 } } |
Method Result
Keyword Relevant Search Method JSON Result
| Result Status | Result JSON String |
| Success |
{ "article": { "searchHint": "Paper", "articles": [ { "articleNumber": "56310", "description": "Deeds or Valuable Papers, other than old ...", "grouping": "Deeds or Valuable Papers", "isHazardous": false, "isSpecialHandling": true, "subGrouping": "" }, { "articleNumber": "150560", "description": "Paper, Paperboard, Fiberboard or Pulpboard, combined or ...", "grouping": "Paper", "isHazardous": false, "isSpecialHandling": false, "subGrouping": "" } ], "totalMatch": 148 }, "index": { "articleIndexes": [ { "articleNumbers": [ "176565" ], "keywords": [ "Wallpaper paste" ], "heading": "Additive(s)", "isHeading": false }, { "articleNumbers": [ "12600" ], "keywords": [ "Albums", "paper", "pulpboard", "or paper", "pulpboard and plastic combined", "with pages" ], "heading": "Albums, paper, pulpboard, or paper, pulpboard and plastic combined, with pages", "isHeading": false } ], "totalMatch": 365 }, "rule": { "rules": [ { "ruleNumber": "110", "ruleHeading": null, "ruleSubHeading": null, "partialDescription": "The following definitions will apply when such ..." }, { "ruleNumber": "250100", "ruleHeading": "DOCUMENTS AND GOVERNING RULES FOR TENDERING SHIPMENTS", "ruleSubHeading": null, "partialDescription": null } ], "totalMatch": 50 }, "package": { "packages": [ { "packageNumber": "27", "packageSubHeading": null, "partialDescription": "In five-ply multiple-wall paper bags meeting the ..." }, { "packageNumber": "33", "packageSubHeading": null, "partialDescription": "In four-ply paper bags meeting the requirements ..." } ], "totalMatch": 55 }, "message": "", "success": true } |
| Failure |
{ "success": false, "message": "The keyword must be between 3 and 50 characters long." } |
Keyword Relevant Search Method Result Definition
| JSON Properties | Description | Data Type |
| success | Identifies if the method call completed successfully. |
|
| message | Result message. | ● String |
| article | Article search results matching the keyword. | ● ArticleSearchResult object |
| index | Article index entries matching the keyword. | ● IndexSearchResult object |
| rule | Rules matching the keyword. | ● RuleSearchResult object |
| package | Packages matching the keyword. | ● PackageSearchResult object |