Get Query Options

GET

/api/Volunteer/QueryOptions

GET

/api/Volunteer/QueryOptions

curl https://api.virtuoussoftware.com/api/Volunteer/QueryOptions \
     -H "Authorization: Bearer <token>"

200Volunteering_getQueryOptions_example

{
  "options": [
    {
      "parameter": "Volunteer Opportunity Id",
      "type": "Int",
      "operatorOptions": [
        {
          "operator": "Is",
          "multipleValuesAllowed": false,
          "valueRequired": true
        },
        {
          "operator": "LessThan",
          "multipleValuesAllowed": false,
          "valueRequired": true
        },
        {
          "operator": "LessThanOrEqual",
          "multipleValuesAllowed": false,
          "valueRequired": true
        },
        {
          "operator": "GreaterThan",
          "multipleValuesAllowed": false,
          "valueRequired": true
        },
        {
          "operator": "GreaterThanOrEqual",
          "multipleValuesAllowed": false,
          "valueRequired": true
        },
        {
          "operator": "Between",
          "multipleValuesAllowed": false,
          "valueRequired": true
        }
      ],
      "valueOptions": []
    },
    {
      "parameter": "Volunteer Opportunity Name",
      "type": "String",
      "operatorOptions": [
        {
          "operator": "Is",
          "multipleValuesAllowed": false,
          "valueRequired": true
        },
        {
          "operator": "Contains",
          "multipleValuesAllowed": false,
          "valueRequired": true
        },
        {
          "operator": "StartsWith",
          "multipleValuesAllowed": false,
          "valueRequired": true
        },
        {
          "operator": "EndsWith",
          "multipleValuesAllowed": false,
          "valueRequired": true
        }
      ],
      "valueOptions": []
    },
    {
      "parameter": "Volunteer Opportunity Description",
      "type": "String",
      "operatorOptions": [
        {
          "operator": "Is",
          "multipleValuesAllowed": false,
          "valueRequired": true
        },
        {
          "operator": "Contains",
          "multipleValuesAllowed": false,
          "valueRequired": true
        },
        {
          "operator": "StartsWith",
          "multipleValuesAllowed": false,
          "valueRequired": true
        },
        {
          "operator": "EndsWith",
          "multipleValuesAllowed": false,
          "valueRequired": true
        }
      ],
      "valueOptions": []
    },
    {
      "parameter": "Volunteer Opportunity Start Date",
      "type": "Date",
      "operatorOptions": [
        {
          "operator": "Is",
          "multipleValuesAllowed": false,
          "valueRequired": true
        },
        {
          "operator": "IsKnown",
          "multipleValuesAllowed": false,
          "valueRequired": false
        },
        {
          "operator": "IsNotKnown",
          "multipleValuesAllowed": false,
          "valueRequired": false
        },
        {
          "operator": "LessThan",
          "multipleValuesAllowed": false,
          "valueRequired": true
        },
        {
          "operator": "LessThanOrEqual",
          "multipleValuesAllowed": false,
          "valueRequired": true
        },
        {
          "operator": "Before",
          "multipleValuesAllowed": false,
          "valueRequired": true
        },
        {
          "operator": "OnOrBefore",
          "multipleValuesAllowed": false,
          "valueRequired": true
        },
        {
          "operator": "GreaterThan",
          "multipleValuesAllowed": false,
          "valueRequired": true
        },
        {
          "operator": "GreaterThanOrEqual",
          "multipleValuesAllowed": false,
          "valueRequired": true
        },
        {
          "operator": "After",
          "multipleValuesAllowed": false,
          "valueRequired": true
        },
        {
          "operator": "OnOrAfter",
          "multipleValuesAllowed": false,
          "valueRequired": true
        },
        {
          "operator": "Between",
          "multipleValuesAllowed": false,
          "valueRequired": true
        }
      ],
      "valueOptions": [
        "180 Days Ago",
        "270 Days Ago",
        "30 Days Ago",
        "60 Days Ago",
        "90 Days Ago",
        "Last Sunday",
        "One week from now",
        "One Year Ago",
        "Start Of This Month",
        "This Calendar Year",
        "Today",
        "Tomorrow",
        "Two Years Ago",
        "Yesterday"
      ]
    },
    {
      "parameter": "Volunteer Opportunity End Date",
      "type": "Date",
      "operatorOptions": [
        {
          "operator": "Is",
          "multipleValuesAllowed": false,
          "valueRequired": true
        },
        {
          "operator": "IsKnown",
          "multipleValuesAllowed": false,
          "valueRequired": false
        },
        {
          "operator": "IsNotKnown",
          "multipleValuesAllowed": false,
          "valueRequired": false
        },
        {
          "operator": "LessThan",
          "multipleValuesAllowed": false,
          "valueRequired": true
        },
        {
          "operator": "LessThanOrEqual",
          "multipleValuesAllowed": false,
          "valueRequired": true
        },
        {
          "operator": "Before",
          "multipleValuesAllowed": false,
          "valueRequired": true
        },
        {
          "operator": "OnOrBefore",
          "multipleValuesAllowed": false,
          "valueRequired": true
        },
        {
          "operator": "GreaterThan",
          "multipleValuesAllowed": false,
          "valueRequired": true
        },
        {
          "operator": "GreaterThanOrEqual",
          "multipleValuesAllowed": false,
          "valueRequired": true
        },
        {
          "operator": "After",
          "multipleValuesAllowed": false,
          "valueRequired": true
        },
        {
          "operator": "OnOrAfter",
          "multipleValuesAllowed": false,
          "valueRequired": true
        },
        {
          "operator": "Between",
          "multipleValuesAllowed": false,
          "valueRequired": true
        }
      ],
      "valueOptions": [
        "180 Days Ago",
        "270 Days Ago",
        "30 Days Ago",
        "60 Days Ago",
        "90 Days Ago",
        "Last Sunday",
        "One week from now",
        "One Year Ago",
        "Start Of This Month",
        "This Calendar Year",
        "Today",
        "Tomorrow",
        "Two Years Ago",
        "Yesterday"
      ]
    },
    {
      "parameter": "Volunteer Opportunity Location",
      "type": "String",
      "operatorOptions": [
        {
          "operator": "Is",
          "multipleValuesAllowed": false,
          "valueRequired": true
        },
        {
          "operator": "Contains",
          "multipleValuesAllowed": false,
          "valueRequired": true
        },
        {
          "operator": "StartsWith",
          "multipleValuesAllowed": false,
          "valueRequired": true
        },
        {
          "operator": "EndsWith",
          "multipleValuesAllowed": false,
          "valueRequired": true
        }
      ],
      "valueOptions": []
    },
    {
      "parameter": "Volunteer Opportunity City",
      "type": "String",
      "operatorOptions": [
        {
          "operator": "Is",
          "multipleValuesAllowed": false,
          "valueRequired": true
        },
        {
          "operator": "Contains",
          "multipleValuesAllowed": false,
          "valueRequired": true
        },
        {
          "operator": "StartsWith",
          "multipleValuesAllowed": false,
          "valueRequired": true
        },
        {
          "operator": "EndsWith",
          "multipleValuesAllowed": false,
          "valueRequired": true
        }
      ],
      "valueOptions": []
    },
    {
      "parameter": "Volunteer Opportunity State",
      "type": "String",
      "operatorOptions": [
        {
          "operator": "Is",
          "multipleValuesAllowed": false,
          "valueRequired": true
        },
        {
          "operator": "IsNot",
          "multipleValuesAllowed": false,
          "valueRequired": true
        },
        {
          "operator": "IsKnown",
          "multipleValuesAllowed": false,
          "valueRequired": false
        },
        {
          "operator": "IsNotKnown",
          "multipleValuesAllowed": false,
          "valueRequired": false
        },
        {
          "operator": "In",
          "multipleValuesAllowed": true,
          "valueRequired": true
        },
        {
          "operator": "NotIn",
          "multipleValuesAllowed": true,
          "valueRequired": true
        }
      ],
      "valueOptions": []
    },
    {
      "parameter": "Title",
      "type": "String",
      "operatorOptions": [
        {
          "operator": "Is",
          "multipleValuesAllowed": false,
          "valueRequired": true
        },
        {
          "operator": "Contains",
          "multipleValuesAllowed": false,
          "valueRequired": true
        },
        {
          "operator": "StartsWith",
          "multipleValuesAllowed": false,
          "valueRequired": true
        },
        {
          "operator": "EndsWith",
          "multipleValuesAllowed": false,
          "valueRequired": true
        }
      ],
      "valueOptions": []
    },
    {
      "parameter": "First Name",
      "type": "String",
      "operatorOptions": [
        {
          "operator": "Is",
          "multipleValuesAllowed": false,
          "valueRequired": true
        },
        {
          "operator": "Contains",
          "multipleValuesAllowed": false,
          "valueRequired": true
        },
        {
          "operator": "StartsWith",
          "multipleValuesAllowed": false,
          "valueRequired": true
        },
        {
          "operator": "EndsWith",
          "multipleValuesAllowed": false,
          "valueRequired": true
        }
      ],
      "valueOptions": []
    },
    {
      "parameter": "Last Name",
      "type": "String",
      "operatorOptions": [
        {
          "operator": "Is",
          "multipleValuesAllowed": false,
          "valueRequired": true
        },
        {
          "operator": "Contains",
          "multipleValuesAllowed": false,
          "valueRequired": true
        },
        {
          "operator": "StartsWith",
          "multipleValuesAllowed": false,
          "valueRequired": true
        },
        {
          "operator": "EndsWith",
          "multipleValuesAllowed": false,
          "valueRequired": true
        }
      ],
      "valueOptions": []
    },
    {
      "parameter": "Middle Name",
      "type": "String",
      "operatorOptions": [
        {
          "operator": "Is",
          "multipleValuesAllowed": false,
          "valueRequired": true
        },
        {
          "operator": "Contains",
          "multipleValuesAllowed": false,
          "valueRequired": true
        },
        {
          "operator": "StartsWith",
          "multipleValuesAllowed": false,
          "valueRequired": true
        },
        {
          "operator": "EndsWith",
          "multipleValuesAllowed": false,
          "valueRequired": true
        }
      ],
      "valueOptions": []
    },
    {
      "parameter": "Suffix",
      "type": "String",
      "operatorOptions": [
        {
          "operator": "Is",
          "multipleValuesAllowed": false,
          "valueRequired": true
        },
        {
          "operator": "Contains",
          "multipleValuesAllowed": false,
          "valueRequired": true
        },
        {
          "operator": "StartsWith",
          "multipleValuesAllowed": false,
          "valueRequired": true
        },
        {
          "operator": "EndsWith",
          "multipleValuesAllowed": false,
          "valueRequired": true
        }
      ],
      "valueOptions": []
    },
    {
      "parameter": "Gender",
      "type": "Lookup",
      "operatorOptions": [
        {
          "operator": "Is",
          "multipleValuesAllowed": false,
          "valueRequired": true
        },
        {
          "operator": "IsKnown",
          "multipleValuesAllowed": false,
          "valueRequired": false
        },
        {
          "operator": "IsNotKnown",
          "multipleValuesAllowed": false,
          "valueRequired": false
        },
        {
          "operator": "Contains",
          "multipleValuesAllowed": false,
          "valueRequired": true
        },
        {
          "operator": "StartsWith",
          "multipleValuesAllowed": false,
          "valueRequired": true
        },
        {
          "operator": "EndsWith",
          "multipleValuesAllowed": false,
          "valueRequired": true
        }
      ],
      "valueOptions": []
    },
    {
      "parameter": "Total Hours",
      "type": "Decimal",
      "operatorOptions": [
        {
          "operator": "Is",
          "multipleValuesAllowed": false,
          "valueRequired": true
        },
        {
          "operator": "LessThan",
          "multipleValuesAllowed": false,
          "valueRequired": true
        },
        {
          "operator": "LessThanOrEqual",
          "multipleValuesAllowed": false,
          "valueRequired": true
        },
        {
          "operator": "GreaterThan",
          "multipleValuesAllowed": false,
          "valueRequired": true
        },
        {
          "operator": "GreaterThanOrEqual",
          "multipleValuesAllowed": false,
          "valueRequired": true
        },
        {
          "operator": "Between",
          "multipleValuesAllowed": false,
          "valueRequired": true
        }
      ],
      "valueOptions": []
    },
    {
      "parameter": "Times Volunteered",
      "type": "Int",
      "operatorOptions": [
        {
          "operator": "Is",
          "multipleValuesAllowed": false,
          "valueRequired": true
        },
        {
          "operator": "LessThan",
          "multipleValuesAllowed": false,
          "valueRequired": true
        },
        {
          "operator": "LessThanOrEqual",
          "multipleValuesAllowed": false,
          "valueRequired": true
        },
        {
          "operator": "GreaterThan",
          "multipleValuesAllowed": false,
          "valueRequired": true
        },
        {
          "operator": "GreaterThanOrEqual",
          "multipleValuesAllowed": false,
          "valueRequired": true
        },
        {
          "operator": "Between",
          "multipleValuesAllowed": false,
          "valueRequired": true
        }
      ],
      "valueOptions": []
    }
  ],
  "operatorOptions": [
    {
      "operator": "Is",
      "multipleValuesAllowed": false,
      "valueRequired": true
    },
    {
      "operator": "IsNot",
      "multipleValuesAllowed": false,
      "valueRequired": true
    },
    {
      "operator": "IsKnown",
      "multipleValuesAllowed": false,
      "valueRequired": false
    },
    {
      "operator": "IsNotKnown",
      "multipleValuesAllowed": false,
      "valueRequired": false
    },
    {
      "operator": "LessThan",
      "multipleValuesAllowed": false,
      "valueRequired": true
    },
    {
      "operator": "LessThanOrEqual",
      "multipleValuesAllowed": false,
      "valueRequired": true
    },
    {
      "operator": "GreaterThan",
      "multipleValuesAllowed": false,
      "valueRequired": true
    },
    {
      "operator": "GreaterThanOrEqual",
      "multipleValuesAllowed": false,
      "valueRequired": true
    },
    {
      "operator": "Contains",
      "multipleValuesAllowed": false,
      "valueRequired": true
    },
    {
      "operator": "StartsWith",
      "multipleValuesAllowed": false,
      "valueRequired": true
    },
    {
      "operator": "EndsWith",
      "multipleValuesAllowed": false,
      "valueRequired": true
    },
    {
      "operator": "IsTrue",
      "multipleValuesAllowed": false,
      "valueRequired": false
    },
    {
      "operator": "IsFalse",
      "multipleValuesAllowed": false,
      "valueRequired": false
    },
    {
      "operator": "IsSet",
      "multipleValuesAllowed": false,
      "valueRequired": false
    },
    {
      "operator": "IsNotSet",
      "multipleValuesAllowed": false,
      "valueRequired": false
    },
    {
      "operator": "In",
      "multipleValuesAllowed": true,
      "valueRequired": true
    },
    {
      "operator": "NotIn",
      "multipleValuesAllowed": true,
      "valueRequired": true
    },
    {
      "operator": "Between",
      "multipleValuesAllowed": false,
      "valueRequired": true
    },
    {
      "operator": "Before",
      "multipleValuesAllowed": false,
      "valueRequired": true
    },
    {
      "operator": "After",
      "multipleValuesAllowed": false,
      "valueRequired": true
    },
    {
      "operator": "IsAnyOf",
      "multipleValuesAllowed": true,
      "valueRequired": true
    },
    {
      "operator": "IsNoneOf",
      "multipleValuesAllowed": true,
      "valueRequired": true
    },
    {
      "operator": "Matches",
      "multipleValuesAllowed": false,
      "valueRequired": true
    },
    {
      "operator": "OnOrBefore",
      "multipleValuesAllowed": false,
      "valueRequired": true
    },
    {
      "operator": "OnOrAfter",
      "multipleValuesAllowed": false,
      "valueRequired": true
    }
  ]
}

Available starting 3/29/2022

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Response headers

Content-Lengthinteger

DatestringOptional

ServerstringOptional

Access-Control-Expose-HeadersstringOptional

Cache-ControlstringOptional

Content-EncodingstringOptional

Expiresinteger

PragmastringOptional

VarystringOptional

X-RateLimit-Limitinteger

X-RateLimit-Remaininginteger

X-RateLimit-Resetinteger

X-AspNet-VersionstringOptional

Request-ContextstringOptional

X-Powered-BystringOptional

Strict-Transport-SecuritystringOptional

Response

optionslist of objectsOptional

operatorOptionslist of objectsOptional