POST Rules/Validate

For the supplied requirement and field of that requirement this method looks up its validation rules and applies them to the passed in value.

Request Information

URI Parameters

None.

Body Parameters

Json representation of the ValidateDataVm model

Collection of Object

None.

Request Formats

application/json, text/json, application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

All the rule information with a pass or fail for each rule.

Collection of RequirementRuleQfVm
NameDescriptionTypeAdditional information
GlobalPrerequisiteId

globally unique identifier

None.

FieldId

globally unique identifier

None.

FieldName

string

None.

FieldType

string

None.

Message

string

None.

Priority

integer

None.

RuleId

integer

None.

RuleMessage

string

None.

RuleName

string

None.

RuleCategoryName

string

None.

RuleResult

RuleResultEnum

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "GlobalPrerequisiteId": "04cece01-7690-44e3-955a-4d28c1f9a777",
    "FieldId": "4b0fee82-1d47-4575-8f40-2cf146571050",
    "FieldName": "sample string 3",
    "FieldType": "sample string 4",
    "Message": "sample string 5",
    "Priority": 6,
    "RuleId": 7,
    "RuleMessage": "sample string 8",
    "RuleName": "sample string 9",
    "RuleCategoryName": "sample string 10",
    "RuleResult": 0
  },
  {
    "GlobalPrerequisiteId": "04cece01-7690-44e3-955a-4d28c1f9a777",
    "FieldId": "4b0fee82-1d47-4575-8f40-2cf146571050",
    "FieldName": "sample string 3",
    "FieldType": "sample string 4",
    "Message": "sample string 5",
    "Priority": 6,
    "RuleId": 7,
    "RuleMessage": "sample string 8",
    "RuleName": "sample string 9",
    "RuleCategoryName": "sample string 10",
    "RuleResult": 0
  }
]

application/xml, text/xml

Sample:
<ArrayOfRequirementRuleQfVm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Vci.Models.ViewModels.Api.Rules.Requirement">
  <RequirementRuleQfVm>
    <FieldId>4b0fee82-1d47-4575-8f40-2cf146571050</FieldId>
    <FieldName>sample string 3</FieldName>
    <FieldType>sample string 4</FieldType>
    <GlobalPrerequisiteId>04cece01-7690-44e3-955a-4d28c1f9a777</GlobalPrerequisiteId>
    <Message>sample string 5</Message>
    <Priority>6</Priority>
    <RuleCategoryName>sample string 10</RuleCategoryName>
    <RuleId>7</RuleId>
    <RuleMessage>sample string 8</RuleMessage>
    <RuleName>sample string 9</RuleName>
    <RuleResult>Pass</RuleResult>
  </RequirementRuleQfVm>
  <RequirementRuleQfVm>
    <FieldId>4b0fee82-1d47-4575-8f40-2cf146571050</FieldId>
    <FieldName>sample string 3</FieldName>
    <FieldType>sample string 4</FieldType>
    <GlobalPrerequisiteId>04cece01-7690-44e3-955a-4d28c1f9a777</GlobalPrerequisiteId>
    <Message>sample string 5</Message>
    <Priority>6</Priority>
    <RuleCategoryName>sample string 10</RuleCategoryName>
    <RuleId>7</RuleId>
    <RuleMessage>sample string 8</RuleMessage>
    <RuleName>sample string 9</RuleName>
    <RuleResult>Pass</RuleResult>
  </RequirementRuleQfVm>
</ArrayOfRequirementRuleQfVm>