Skip to main content

ClassIT+ API Methods: Rule Search

Updated
This article is under construction. Additional details coming soon. 

The Rule Search method performs a search and retrieves a Rule from the itemNumber.

Method Definition

Http Method: POST

Authorization header: Bearer JWT

URL: <Environment URL>/RuleById

 

Rule Search Request Parameter Name, Description, and Data Type

Parameter Name Description Data Type

ruleNumber

 Item Number to search
  • String
  • Min. Length = 3
  • Max. Length = 10

 

Keyword Search Method Parameter Name, Description, and Data Type

JSON Properties Description Data Type
success

Identifies if the method call completed successfully.
  • Boolean
  • Valid Values:
    - True
    - False
description

Full description of the article.
  • String

tariffIssue

The book edition.
  • String

supplement 

If this is part of a supplement.
  • String
classification

The classification assigned to the item if any.
  • String
issueDate

The date this item was issued.
  • Date
effectiveDate

The date this item goes into effect.
  • Date
cancellationDate

The date this item was canceled.
  • Date

subItems

 

 

 List of sub items. Each record includes the following properties that describe the sub item.
  • item–Sub number
  • description–Description of the sub item
  • JSON Array
  • Min Occurs = 1
  • Max Occurs = Unlimited
ErrorMessage Error description.
  • String

Related articles