GET Rules/AvaiableRules

Returns all rules available that can be applied to the requirement.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of RuleVm

Name	Type	Additional information
RuleId	integer	None.
CategoryId	integer	None.
CategoryName	string	None.
Name	string	None.
Message	string	None.
Expression	ExpressionVm	None.
DisplayMessage	string	None.
RuleResult	RuleResultEnum	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "RuleId": 1,
    "CategoryId": 2,
    "CategoryName": "sample string 3",
    "Name": "sample string 4",
    "Message": "sample string 5",
    "Expression": {
      "ExpressionId": 1,
      "Name": "sample string 2",
      "Syntax": "sample string 3",
      "CategoryId": 4,
      "Variables": [
        {
          "VariableId": 1,
          "Name": "sample string 2",
          "Type": 0,
          "Value": "sample string 3"
        },
        {
          "VariableId": 1,
          "Name": "sample string 2",
          "Type": 0,
          "Value": "sample string 3"
        }
      ]
    },
    "DisplayMessage": "sample string 6",
    "RuleResult": 0
  },
  {
    "RuleId": 1,
    "CategoryId": 2,
    "CategoryName": "sample string 3",
    "Name": "sample string 4",
    "Message": "sample string 5",
    "Expression": {
      "ExpressionId": 1,
      "Name": "sample string 2",
      "Syntax": "sample string 3",
      "CategoryId": 4,
      "Variables": [
        {
          "VariableId": 1,
          "Name": "sample string 2",
          "Type": 0,
          "Value": "sample string 3"
        },
        {
          "VariableId": 1,
          "Name": "sample string 2",
          "Type": 0,
          "Value": "sample string 3"
        }
      ]
    },
    "DisplayMessage": "sample string 6",
    "RuleResult": 0
  }
]

application/xml, text/xml

Sample:

<ArrayOfRuleVm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Vci.Models.ViewModels.Api.Rules.Rule">
  <RuleVm>
    <CategoryId>2</CategoryId>
    <CategoryName>sample string 3</CategoryName>
    <DisplayMessage>sample string 6</DisplayMessage>
    <Expression>
      <CategoryId>4</CategoryId>
      <ExpressionId>1</ExpressionId>
      <Name>sample string 2</Name>
      <Syntax>sample string 3</Syntax>
      <Variables>
        <VariableVm>
          <Name>sample string 2</Name>
          <Type>Integer</Type>
          <Value>sample string 3</Value>
          <VariableId>1</VariableId>
        </VariableVm>
        <VariableVm>
          <Name>sample string 2</Name>
          <Type>Integer</Type>
          <Value>sample string 3</Value>
          <VariableId>1</VariableId>
        </VariableVm>
      </Variables>
    </Expression>
    <Message>sample string 5</Message>
    <Name>sample string 4</Name>
    <RuleId>1</RuleId>
    <RuleResult>Pass</RuleResult>
  </RuleVm>
  <RuleVm>
    <CategoryId>2</CategoryId>
    <CategoryName>sample string 3</CategoryName>
    <DisplayMessage>sample string 6</DisplayMessage>
    <Expression>
      <CategoryId>4</CategoryId>
      <ExpressionId>1</ExpressionId>
      <Name>sample string 2</Name>
      <Syntax>sample string 3</Syntax>
      <Variables>
        <VariableVm>
          <Name>sample string 2</Name>
          <Type>Integer</Type>
          <Value>sample string 3</Value>
          <VariableId>1</VariableId>
        </VariableVm>
        <VariableVm>
          <Name>sample string 2</Name>
          <Type>Integer</Type>
          <Value>sample string 3</Value>
          <VariableId>1</VariableId>
        </VariableVm>
      </Variables>
    </Expression>
    <Message>sample string 5</Message>
    <Name>sample string 4</Name>
    <RuleId>1</RuleId>
    <RuleResult>Pass</RuleResult>
  </RuleVm>
</ArrayOfRuleVm>