GET api/OnlineVoter/GetOnlineVoterBatchStatus

Get the status of a batch and associated voters.

Request Information

URI Parameters

None.

Body Parameters

OnlineVoterBatchStatusRequest

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

Name

Description

Type

Additional information

SenderName

string

Required

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

Max length: 100

BatchId

decimal number

Required

Request Formats

application/json, text/json

Sample:

{
  "SenderName": "sample string 1",
  "BatchId": 2.0
}

text/html

Sample:

{"SenderName":"sample string 1","BatchId":2.0}

application/xml, text/xml

Sample:

<OnlineVoterBatchStatusRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OnlineVoterAPI.Models">
  <BatchId>2</BatchId>
  <SenderName>sample string 1</SenderName>
</OnlineVoterBatchStatusRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

OnlineVoterBatchStatusResponse

Name	Type	Additional information
BatchId	decimal number	None.
BatchStatusId	decimal number	None.
StatusDescription	string	None.
BatchVoters	Collection of VoterStatus	None.

Response Formats

application/json, text/json

Sample:

{
  "BatchId": 1.0,
  "BatchStatusId": 2.0,
  "StatusDescription": "sample string 3",
  "BatchVoters": [
    {
      "SenderRecordId": "sample string 1",
      "RecordStatusId": 2.0,
      "RecordStatusDescription": "sample string 3"
    },
    {
      "SenderRecordId": "sample string 1",
      "RecordStatusId": 2.0,
      "RecordStatusDescription": "sample string 3"
    }
  ]
}

text/html

Sample:

{"BatchId":1.0,"BatchStatusId":2.0,"StatusDescription":"sample string 3","BatchVoters":[{"SenderRecordId":"sample string 1","RecordStatusId":2.0,"RecordStatusDescription":"sample string 3"},{"SenderRecordId":"sample string 1","RecordStatusId":2.0,"RecordStatusDescription":"sample string 3"}]}

application/xml, text/xml

Sample:

<OnlineVoterBatchStatusResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OnlineVoterAPI.Models">
  <BatchId>1</BatchId>
  <BatchStatusId>2</BatchStatusId>
  <BatchVoters>
    <VoterStatus>
      <RecordStatusDescription>sample string 3</RecordStatusDescription>
      <RecordStatusId>2</RecordStatusId>
      <SenderRecordId>sample string 1</SenderRecordId>
    </VoterStatus>
    <VoterStatus>
      <RecordStatusDescription>sample string 3</RecordStatusDescription>
      <RecordStatusId>2</RecordStatusId>
      <SenderRecordId>sample string 1</SenderRecordId>
    </VoterStatus>
  </BatchVoters>
  <StatusDescription>sample string 3</StatusDescription>
</OnlineVoterBatchStatusResponse>