POST api/OnlineVoter/PostOnlineVoterBatch

Post a batch of Online Voters

Request Information

URI Parameters

None.

Body Parameters

OnlineVoterBatchRequest

Name	Description	Type	Additional information
SenderName		string	Required Matching regular expression pattern: ^[a-zA-Z0-9 _#/',.-]*$ Max length: 100
BatchVoters		Collection of OnlineVoter	None.

Name

Description

Type

Additional information

SenderName

string

Required

Matching regular expression pattern: ^[a-zA-Z0-9 _#/',.-]*$

Max length: 100

BatchVoters

Collection of OnlineVoter

None.

Request Formats

application/json, text/json

Sample:

{
  "SenderName": "sample string 1",
  "BatchVoters": [
    {
      "SenderRecordId": "sample string 1",
      "StatusId": 1.0,
      "DLNAddressUpdate": "sample string 2",
      "DLNDuplicate": "sample string 3",
      "IsCitizen": "sample string 4",
      "IsEighteen": "sample string 5",
      "IsThirtyDayResident": "sample string 6",
      "RegistrationCancellationAuthorized": "sample string 7",
      "DigitalSignatureAuthorized": "sample string 8",
      "FullName": "sample string 9",
      "DLN": "sample string 10",
      "BirthMonth": 11.0,
      "BirthDay": 12.0,
      "BirthYear": 13.0,
      "EyeColor": "sample string 14",
      "SSNFour": "sample string 15",
      "AddressLine1": "sample string 16",
      "AddressLine2": "sample string 17",
      "City": "sample string 18",
      "Zip": "sample string 19",
      "PhoneNumber": "sample string 20",
      "EmailAddress": "sample string 21",
      "MailingAddressIsInternational": "sample string 22",
      "MailingAddressLineOne": "sample string 23",
      "MailingAddressLineTwo": "sample string 24",
      "MailingAddressLineThree": "sample string 25",
      "MailingAddressLineFour": "sample string 26",
      "MailingAddressLineFive": "sample string 27"
    },
    {
      "SenderRecordId": "sample string 1",
      "StatusId": 1.0,
      "DLNAddressUpdate": "sample string 2",
      "DLNDuplicate": "sample string 3",
      "IsCitizen": "sample string 4",
      "IsEighteen": "sample string 5",
      "IsThirtyDayResident": "sample string 6",
      "RegistrationCancellationAuthorized": "sample string 7",
      "DigitalSignatureAuthorized": "sample string 8",
      "FullName": "sample string 9",
      "DLN": "sample string 10",
      "BirthMonth": 11.0,
      "BirthDay": 12.0,
      "BirthYear": 13.0,
      "EyeColor": "sample string 14",
      "SSNFour": "sample string 15",
      "AddressLine1": "sample string 16",
      "AddressLine2": "sample string 17",
      "City": "sample string 18",
      "Zip": "sample string 19",
      "PhoneNumber": "sample string 20",
      "EmailAddress": "sample string 21",
      "MailingAddressIsInternational": "sample string 22",
      "MailingAddressLineOne": "sample string 23",
      "MailingAddressLineTwo": "sample string 24",
      "MailingAddressLineThree": "sample string 25",
      "MailingAddressLineFour": "sample string 26",
      "MailingAddressLineFive": "sample string 27"
    }
  ]
}

text/html

Sample:

{"SenderName":"sample string 1","BatchVoters":[{"SenderRecordId":"sample string 1","StatusId":1.0,"DLNAddressUpdate":"sample string 2","DLNDuplicate":"sample string 3","IsCitizen":"sample string 4","IsEighteen":"sample string 5","IsThirtyDayResident":"sample string 6","RegistrationCancellationAuthorized":"sample string 7","DigitalSignatureAuthorized":"sample string 8","FullName":"sample string 9","DLN":"sample string 10","BirthMonth":11.0,"BirthDay":12.0,"BirthYear":13.0,"EyeColor":"sample string 14","SSNFour":"sample string 15","AddressLine1":"sample string 16","AddressLine2":"sample string 17","City":"sample string 18","Zip":"sample string 19","PhoneNumber":"sample string 20","EmailAddress":"sample string 21","MailingAddressIsInternational":"sample string 22","MailingAddressLineOne":"sample string 23","MailingAddressLineTwo":"sample string 24","MailingAddressLineThree":"sample string 25","MailingAddressLineFour":"sample string 26","MailingAddressLineFive":"sample string 27"},{"SenderRecordId":"sample string 1","StatusId":1.0,"DLNAddressUpdate":"sample string 2","DLNDuplicate":"sample string 3","IsCitizen":"sample string 4","IsEighteen":"sample string 5","IsThirtyDayResident":"sample string 6","RegistrationCancellationAuthorized":"sample string 7","DigitalSignatureAuthorized":"sample string 8","FullName":"sample string 9","DLN":"sample string 10","BirthMonth":11.0,"BirthDay":12.0,"BirthYear":13.0,"EyeColor":"sample string 14","SSNFour":"sample string 15","AddressLine1":"sample string 16","AddressLine2":"sample string 17","City":"sample string 18","Zip":"sample string 19","PhoneNumber":"sample string 20","EmailAddress":"sample string 21","MailingAddressIsInternational":"sample string 22","MailingAddressLineOne":"sample string 23","MailingAddressLineTwo":"sample string 24","MailingAddressLineThree":"sample string 25","MailingAddressLineFour":"sample string 26","MailingAddressLineFive":"sample string 27"}]}

application/xml, text/xml

Sample:

<OnlineVoterBatchRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OnlineVoterAPI.Models">
  <BatchVoters xmlns:d2p1="http://schemas.datacontract.org/2004/07/QVF.Data.ViewModels.OnlineVoter">
    <d2p1:OnlineVoter>
      <d2p1:AddressLine1>sample string 16</d2p1:AddressLine1>
      <d2p1:AddressLine2>sample string 17</d2p1:AddressLine2>
      <d2p1:BirthDay>12</d2p1:BirthDay>
      <d2p1:BirthMonth>11</d2p1:BirthMonth>
      <d2p1:BirthYear>13</d2p1:BirthYear>
      <d2p1:City>sample string 18</d2p1:City>
      <d2p1:DLN>sample string 10</d2p1:DLN>
      <d2p1:DLNAddressUpdate>sample string 2</d2p1:DLNAddressUpdate>
      <d2p1:DLNDuplicate>sample string 3</d2p1:DLNDuplicate>
      <d2p1:DigitalSignatureAuthorized>sample string 8</d2p1:DigitalSignatureAuthorized>
      <d2p1:EmailAddress>sample string 21</d2p1:EmailAddress>
      <d2p1:EyeColor>sample string 14</d2p1:EyeColor>
      <d2p1:FullName>sample string 9</d2p1:FullName>
      <d2p1:IsCitizen>sample string 4</d2p1:IsCitizen>
      <d2p1:IsEighteen>sample string 5</d2p1:IsEighteen>
      <d2p1:IsThirtyDayResident>sample string 6</d2p1:IsThirtyDayResident>
      <d2p1:MailingAddressIsInternational>sample string 22</d2p1:MailingAddressIsInternational>
      <d2p1:MailingAddressLineFive>sample string 27</d2p1:MailingAddressLineFive>
      <d2p1:MailingAddressLineFour>sample string 26</d2p1:MailingAddressLineFour>
      <d2p1:MailingAddressLineOne>sample string 23</d2p1:MailingAddressLineOne>
      <d2p1:MailingAddressLineThree>sample string 25</d2p1:MailingAddressLineThree>
      <d2p1:MailingAddressLineTwo>sample string 24</d2p1:MailingAddressLineTwo>
      <d2p1:PhoneNumber>sample string 20</d2p1:PhoneNumber>
      <d2p1:RegistrationCancellationAuthorized>sample string 7</d2p1:RegistrationCancellationAuthorized>
      <d2p1:SSNFour>sample string 15</d2p1:SSNFour>
      <d2p1:SenderRecordId>sample string 1</d2p1:SenderRecordId>
      <d2p1:StatusId>1</d2p1:StatusId>
      <d2p1:Zip>sample string 19</d2p1:Zip>
    </d2p1:OnlineVoter>
    <d2p1:OnlineVoter>
      <d2p1:AddressLine1>sample string 16</d2p1:AddressLine1>
      <d2p1:AddressLine2>sample string 17</d2p1:AddressLine2>
      <d2p1:BirthDay>12</d2p1:BirthDay>
      <d2p1:BirthMonth>11</d2p1:BirthMonth>
      <d2p1:BirthYear>13</d2p1:BirthYear>
      <d2p1:City>sample string 18</d2p1:City>
      <d2p1:DLN>sample string 10</d2p1:DLN>
      <d2p1:DLNAddressUpdate>sample string 2</d2p1:DLNAddressUpdate>
      <d2p1:DLNDuplicate>sample string 3</d2p1:DLNDuplicate>
      <d2p1:DigitalSignatureAuthorized>sample string 8</d2p1:DigitalSignatureAuthorized>
      <d2p1:EmailAddress>sample string 21</d2p1:EmailAddress>
      <d2p1:EyeColor>sample string 14</d2p1:EyeColor>
      <d2p1:FullName>sample string 9</d2p1:FullName>
      <d2p1:IsCitizen>sample string 4</d2p1:IsCitizen>
      <d2p1:IsEighteen>sample string 5</d2p1:IsEighteen>
      <d2p1:IsThirtyDayResident>sample string 6</d2p1:IsThirtyDayResident>
      <d2p1:MailingAddressIsInternational>sample string 22</d2p1:MailingAddressIsInternational>
      <d2p1:MailingAddressLineFive>sample string 27</d2p1:MailingAddressLineFive>
      <d2p1:MailingAddressLineFour>sample string 26</d2p1:MailingAddressLineFour>
      <d2p1:MailingAddressLineOne>sample string 23</d2p1:MailingAddressLineOne>
      <d2p1:MailingAddressLineThree>sample string 25</d2p1:MailingAddressLineThree>
      <d2p1:MailingAddressLineTwo>sample string 24</d2p1:MailingAddressLineTwo>
      <d2p1:PhoneNumber>sample string 20</d2p1:PhoneNumber>
      <d2p1:RegistrationCancellationAuthorized>sample string 7</d2p1:RegistrationCancellationAuthorized>
      <d2p1:SSNFour>sample string 15</d2p1:SSNFour>
      <d2p1:SenderRecordId>sample string 1</d2p1:SenderRecordId>
      <d2p1:StatusId>1</d2p1:StatusId>
      <d2p1:Zip>sample string 19</d2p1:Zip>
    </d2p1:OnlineVoter>
  </BatchVoters>
  <SenderName>sample string 1</SenderName>
</OnlineVoterBatchRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

OnlineVoterBatchResponse

Name	Type	Additional information
BatchId	decimal number	None.
SenderName	string	None.
BatchStatusId	decimal number	None.
IsValid	boolean	None.
VoterErrors	Collection of OnlineVoterError	None.
HasError	boolean	None.
ErrorMessage	string	None.

Response Formats

application/json, text/json

Sample:

{
  "BatchId": 1.0,
  "SenderName": "sample string 1",
  "BatchStatusId": 2.0,
  "IsValid": true,
  "VoterErrors": [
    {
      "SenderRecordId": "sample string 1",
      "IsValid": true,
      "ValidationMessage": [
        "sample string 1",
        "sample string 2"
      ]
    },
    {
      "SenderRecordId": "sample string 1",
      "IsValid": true,
      "ValidationMessage": [
        "sample string 1",
        "sample string 2"
      ]
    }
  ],
  "HasError": true,
  "ErrorMessage": "sample string 5"
}

text/html

Sample:

{"BatchId":1.0,"SenderName":"sample string 1","BatchStatusId":2.0,"IsValid":true,"VoterErrors":[{"SenderRecordId":"sample string 1","IsValid":true,"ValidationMessage":["sample string 1","sample string 2"]},{"SenderRecordId":"sample string 1","IsValid":true,"ValidationMessage":["sample string 1","sample string 2"]}],"HasError":true,"ErrorMessage":"sample string 5"}

application/xml, text/xml

Sample:

<OnlineVoterBatchResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OnlineVoterAPI.Models">
  <BatchId>1</BatchId>
  <BatchStatusId>2</BatchStatusId>
  <ErrorMessage>sample string 5</ErrorMessage>
  <HasError>true</HasError>
  <IsValid>true</IsValid>
  <SenderName>sample string 1</SenderName>
  <VoterErrors xmlns:d2p1="http://schemas.datacontract.org/2004/07/QVF.Data.ViewModels.OnlineVoter">
    <d2p1:OnlineVoterError>
      <d2p1:IsValid>true</d2p1:IsValid>
      <d2p1:SenderRecordId>sample string 1</d2p1:SenderRecordId>
      <d2p1:ValidationMessage xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </d2p1:ValidationMessage>
    </d2p1:OnlineVoterError>
    <d2p1:OnlineVoterError>
      <d2p1:IsValid>true</d2p1:IsValid>
      <d2p1:SenderRecordId>sample string 1</d2p1:SenderRecordId>
      <d2p1:ValidationMessage xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </d2p1:ValidationMessage>
    </d2p1:OnlineVoterError>
  </VoterErrors>
</OnlineVoterBatchResponse>