GET api/OnlineVoter/GetOnlineVoterStreetMatch

Checks for possible street index matches in the State of Michigan QVF system for a given address/city/zip.

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
SenderName	string	Required Matching regular expression pattern: ^[a-zA-Z0-9 _#/',.-]*$ Max length: 100
AddressLine1	string	Required Matching regular expression pattern: ^[a-zA-Z0-9 _#/',.-]*$ Max length: 50
City	string	Required Matching regular expression pattern: ^[a-zA-Z0-9 _#/',.-]*$ Max length: 100
ZipCode	string	Required Matching regular expression pattern: ^[0-9]{5}$ Max length: 5

Request Formats

application/json, text/json

Sample:

{
  "SenderName": "sample string 1",
  "AddressLine1": "sample string 2",
  "City": "sample string 3",
  "ZipCode": "sample string 4"
}

text/html

Sample:

{"SenderName":"sample string 1","AddressLine1":"sample string 2","City":"sample string 3","ZipCode":"sample string 4"}

application/xml, text/xml

Sample:

<OnlineVoterStreetMatchRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OnlineVoterAPI.Models">
  <AddressLine1>sample string 2</AddressLine1>
  <City>sample string 3</City>
  <SenderName>sample string 1</SenderName>
  <ZipCode>sample string 4</ZipCode>
</OnlineVoterStreetMatchRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

OnlineVoterStreetMatchResponse

Name	Type	Additional information
HasMatch	boolean	None.
HasError	boolean	None.
IsValid	boolean	None.
MatchingStreets	Collection of OnlineVoterStreetRange	None.
ValidationMessage	Collection of string	None.
ErrorMessage	string	None.

Response Formats

application/json, text/json

Sample:

{
  "HasMatch": true,
  "HasError": true,
  "IsValid": true,
  "MatchingStreets": [
    {
      "HouseNumberLow": 1.0,
      "HouseNumberHigh": 1.0,
      "ExtensionLow": "sample string 1",
      "ExtensionHigh": "sample string 2",
      "StreetPrefix": "sample string 3",
      "StreetSuffix": "sample string 4",
      "StreetName": "sample string 5",
      "StreetType": "sample string 6",
      "City": "sample string 7",
      "ZipCode": "sample string 8",
      "JurisdictionName": "sample string 9",
      "OddEvenIndicator": "sample string 10",
      "HouseNumberCharacter": "sample string 11",
      "AliasName": "sample string 12",
      "AliasPrefix": "sample string 13",
      "AliasSuffix": "sample string 14"
    },
    {
      "HouseNumberLow": 1.0,
      "HouseNumberHigh": 1.0,
      "ExtensionLow": "sample string 1",
      "ExtensionHigh": "sample string 2",
      "StreetPrefix": "sample string 3",
      "StreetSuffix": "sample string 4",
      "StreetName": "sample string 5",
      "StreetType": "sample string 6",
      "City": "sample string 7",
      "ZipCode": "sample string 8",
      "JurisdictionName": "sample string 9",
      "OddEvenIndicator": "sample string 10",
      "HouseNumberCharacter": "sample string 11",
      "AliasName": "sample string 12",
      "AliasPrefix": "sample string 13",
      "AliasSuffix": "sample string 14"
    }
  ],
  "ValidationMessage": [
    "sample string 1",
    "sample string 2"
  ],
  "ErrorMessage": "sample string 4"
}

text/html

Sample:

{"HasMatch":true,"HasError":true,"IsValid":true,"MatchingStreets":[{"HouseNumberLow":1.0,"HouseNumberHigh":1.0,"ExtensionLow":"sample string 1","ExtensionHigh":"sample string 2","StreetPrefix":"sample string 3","StreetSuffix":"sample string 4","StreetName":"sample string 5","StreetType":"sample string 6","City":"sample string 7","ZipCode":"sample string 8","JurisdictionName":"sample string 9","OddEvenIndicator":"sample string 10","HouseNumberCharacter":"sample string 11","AliasName":"sample string 12","AliasPrefix":"sample string 13","AliasSuffix":"sample string 14"},{"HouseNumberLow":1.0,"HouseNumberHigh":1.0,"ExtensionLow":"sample string 1","ExtensionHigh":"sample string 2","StreetPrefix":"sample string 3","StreetSuffix":"sample string 4","StreetName":"sample string 5","StreetType":"sample string 6","City":"sample string 7","ZipCode":"sample string 8","JurisdictionName":"sample string 9","OddEvenIndicator":"sample string 10","HouseNumberCharacter":"sample string 11","AliasName":"sample string 12","AliasPrefix":"sample string 13","AliasSuffix":"sample string 14"}],"ValidationMessage":["sample string 1","sample string 2"],"ErrorMessage":"sample string 4"}

application/xml, text/xml

Sample:

<OnlineVoterStreetMatchResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OnlineVoterAPI.Models">
  <ErrorMessage>sample string 4</ErrorMessage>
  <HasError>true</HasError>
  <HasMatch>true</HasMatch>
  <IsValid>true</IsValid>
  <MatchingStreets>
    <OnlineVoterStreetRange>
      <AliasName>sample string 12</AliasName>
      <AliasPrefix>sample string 13</AliasPrefix>
      <AliasSuffix>sample string 14</AliasSuffix>
      <City>sample string 7</City>
      <ExtensionHigh>sample string 2</ExtensionHigh>
      <ExtensionLow>sample string 1</ExtensionLow>
      <HouseNumberCharacter>sample string 11</HouseNumberCharacter>
      <HouseNumberHigh>1</HouseNumberHigh>
      <HouseNumberLow>1</HouseNumberLow>
      <JurisdictionName>sample string 9</JurisdictionName>
      <OddEvenIndicator>sample string 10</OddEvenIndicator>
      <StreetName>sample string 5</StreetName>
      <StreetPrefix>sample string 3</StreetPrefix>
      <StreetSuffix>sample string 4</StreetSuffix>
      <StreetType>sample string 6</StreetType>
      <ZipCode>sample string 8</ZipCode>
    </OnlineVoterStreetRange>
    <OnlineVoterStreetRange>
      <AliasName>sample string 12</AliasName>
      <AliasPrefix>sample string 13</AliasPrefix>
      <AliasSuffix>sample string 14</AliasSuffix>
      <City>sample string 7</City>
      <ExtensionHigh>sample string 2</ExtensionHigh>
      <ExtensionLow>sample string 1</ExtensionLow>
      <HouseNumberCharacter>sample string 11</HouseNumberCharacter>
      <HouseNumberHigh>1</HouseNumberHigh>
      <HouseNumberLow>1</HouseNumberLow>
      <JurisdictionName>sample string 9</JurisdictionName>
      <OddEvenIndicator>sample string 10</OddEvenIndicator>
      <StreetName>sample string 5</StreetName>
      <StreetPrefix>sample string 3</StreetPrefix>
      <StreetSuffix>sample string 4</StreetSuffix>
      <StreetType>sample string 6</StreetType>
      <ZipCode>sample string 8</ZipCode>
    </OnlineVoterStreetRange>
  </MatchingStreets>
  <ValidationMessage xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ValidationMessage>
</OnlineVoterStreetMatchResponse>