| ClassIT+™ |
The SupplementRuleBatch method retrieves the Supplement rule data.
|
This method is only available on Production during the following window: Batch requests will not impact monthly thresholds. |
Method Definition
Http Method: POST
Authorization header: Bearer JWT
- Sandbox URL: https://snbxapi-se.nmfta.org/api/v1.0/search/SupplementRuleBatch
- Production URL: https://Api-se.classitplus.com/api/v1.0/search/SupplementRuleBatch
The SupplementRuleBatch API method does not require any parameters other than the authentication token for authorization.
Method Request
Method JSON Request
| Result Status | Result JSON String |
| Http Method | POST |
| BODY | None required |
Method Result
Method JSON Result
| Result Status | Result JSON String |
| success | { "newRules": [ { "ruleNumber": "110", "ruleHeader": "Example of Rule with Table and Image", "ruleSubHeading": null, "issueDate": "2025-11-06T06:00:00Z", "effectiveDate": "2025-12-06T06:00:00Z", "cancellationDate": "2095-12-31T06:00:00Z", "tariffIssue": null, "ruleDescriptions": [ { "type": "generic", "title": null, "text": "The following definitions will apply when such terms are used in this Classification or in tariffs governed by this Classification. When different definitions are provided for the same terms in connection with rates, classes, rules or other provisions, such definitions will take precedence.", "subItems": [] }, { "type": "sec", "title": "Sec. 1.", "text": "'Carrier,' 'Consignee,' 'Consignor' or 'Shipper' includes the authorized representatives or agents of such 'carrier,' 'consignee,' 'consignor' or 'shipper.' ", "subItems": [] } ] } ], "amendedRules": [ { "ruleNumber": "210", "ruleHeader": "Example of Rule with Table and Image", "ruleSubHeading": null, "issueDate": "2025-11-06T06:00:00Z", "effectiveDate": "2025-12-06T06:00:00Z", "cancellationDate": "2095-12-31T06:00:00Z", "tariffIssue": null, "ruleDescriptions": [ { "type": "generic", "title": null, "text": "The following definitions will apply when such terms are used in this Classification or in tariffs governed by this Classification. When different definitions are provided for the same terms in connection with rates, classes, rules or other provisions, such definitions will take precedence.", "subItems": [] }, { "type": "sec", "title": "Sec. 1.", "text": "'Carrier,' 'Consignee,' 'Consignor' or 'Shipper' includes the authorized representatives or agents of such 'carrier,' 'consignee,' 'consignor' or 'shipper.' ", "subItems": [] } ] } ], "canceledRuleItems": [ { "canceledItemNumber": "100", "newItemNumbers": [], "newItemsDescription": "" } ], "message": "", "success": true } |
| failure | { "newRules": [], "amendedRules": [], "canceledRuleItems": [], "message": "The batch is not currently available. Please try again between 2025-07-11 00:00:00Z and 2025-08-10 00:00:00Z (UTC)", "success": false } |
Result Definition
| JSON Properties | Description | Data Type |
| success | Identifies if the method call completed successfully. |
-True -False |
| message | Result message. |
|
| newRules | Gets or sets the list of newly created rules in the batch, represented as search result DTOs. |
|
| amendRules | Gets or sets the list of amended (updated) rules in the batch, represented as search result DTOs. |
|
| canceledRuleItems | List of items that have been canceled in this batch. |
|
All content © Copyright 2025 National Motor Freight Traffic Association, Inc.™ All Rights Reserved.