CRMLS rules allow for the validation of resource field values prior to committing updates to the CRIB database. This section is focused on the structure and definition of the validation rules developed by CRMLS.
The rules section is organized as follows:
Rule Syntax Definition: This section provides the RESO validation rule syntax in a more readable format then the RESO standard. If you wish to view the syntax as defined within the RESO standard, it can be found on the RESO site (www.RESO.org) and is titled, "RCP WebAPI-019 - Validation Expression in the WebAPI".
Rule Extensions: This section provides description of extensions that CRMLS needed to add to the RESO standard to meet the needs of of the CRMLS validation rules. Hopefully some or all of these extension will be folded into a future version of the RESO standard.
Rule Syntax Formatting: The rules are written in a manner to conform to formatting guidelines to help provide conformity and lend to readable, consistant rules. This section lists the formatting guidelines.
Rule Definitions: This section contains the actual rules. The rules are organized in a hierarchy top down as resource -> field -> action. This section is automatically generated from the rule source.
Field Definitions: This section contains the field definitions. The fields are organized by resource. This section is automatically generated from the C# data model through reflection.
Rule Index: This section allows the user an easy way to find examples. The section is organized by Claims, Functions, and Fields.
ANTLR4 Lexer-Parser: This section provides some high level information into the structure of the lexer-parser CRMLS built to process the rules.
Glossary: This section provides a list of terms and associated definitions used within this rule section of the Web API documentation.
