Evaluates the provided criteria string based on the CriteriaRule grammar.

Overview

This method evaluates the provided criteria string based on the CriteriaRule grammar.

###Parameters
Criteria: A string representing the criteria based on the CriteriaRule grammar.

###Returns
The evaluation result either successful or failed grammar.

Supported Fields

Program: Represents a program. This field only accepts GUID values.

Example: Program == {11139728-d1e2-4e57-86d6-8a0e32534bbe}

Product: Represents a product. This field only accepts GUID values.

Example: Product == {21139728-d1e2-4e57-86d6-8a0e32534bbe}

Plan: Represents a plan. This field only accepts GUID values.

Example: Plan == {31139728-d1e2-4e57-86d6-8a0e32534bbe}

ProgramCode: Represents the code of a program. This field only accepts string values.

Example: ProgramCode == "Prog123"

ProductCode: Represents the code of a product. This field only accepts string values.

Example: ProductCode == "Prod123"

PlanCode: Represents the code of a plan. This field only accepts string values.

Example: PlanCode == "Plan123"

ClassCode: Represents the class code. This field only accepts string values.

Example: ClassCode == "Class123"

Make: Represents the make of a vehicle. This field only accepts string values.

Example: Make == "BMW"

VehiclePurchaseType: Represents the type of vehicle purchase. This field only accepts option values.

Supported values are New, Certified, Used.

Example: VehiclePurchaseType == New

VehicleFinanceType: Represents the type of vehicle finance. This field only accepts option values.

Supported values are Lease, Balloon, Purchase, Cash.

Example: VehicleFinanceType == Cash

DealerState: Represents the state of the dealer. This field only accepts option values.

Example: DealerState == "IL"

TermMonths: Represents the term in months. This field only accepts numeric values.

Example: TermMonths == 12

TermMiles: Represents the term in miles. This field only accepts numeric values.

Example: TermMiles == 10000

Supported Operators

Equality:

==: Equals

!=: Not equals

Comparison:

>: Greater than

>=: Greater than or equal to

<: Less than

<=: Less than or equal to

String operations:

~=: Contains

!~=: Does not contain

^=: Begins with

!^=: Does not begin with

$=: Ends with

!$=: Does not end with

Inclusion:

~: Includes

!~: Does not include

Logical:

Or: Logical OR

And: Logical AND

Value Types

Fixed Choice Values:

VehiclePurchaseType: New, Certified, Used

VehicleFinanceType: Lease, Balloon, Purchase, Cash

Numeric Values:

TermMonths: Matches 1-999

TermMiles: Matches 1-99999999

String Values:

Enclosed in double quotes, e.g., "ExampleString"

Example Criteria

Here are some examples of criteria strings:

*Simple Equality * *:

    ClassCode == "Class123"

*Logical AND * *:

(ClassCode == "Class123" And TermMiles == 1000)

*Logical OR * *:

(TermMiles == 12000 Or TermMonths == 12)

*Nested Expressions * *:

(Plan == {1a2bb6f9-ab29-460e-abab-618d879b87d2} And VehiclePurchaseType == New And (DealerState == "IL" Or TermMiles == 12000 Or TermMonths == 24))

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

API Key

Add parameter in header

X-API-Key

Example:

X-API-Key: ********************

Header Params

Body Params

application/json

Examples

Evaluates the provided criteria string based on the CriteriaRule grammar.

Overview#

Supported Fields#

Supported Operators#

Value Types#