Common Models

The following is an overview of the Voter Registration Batch:

{
  "voterRegistrationBatchId": 100,
  "name": "VR Batch",
  "description": "VR Batch Description",
  "stateCode": "MA",
  "form": {
    "formId": 101,
    "name": "VR Form"
  },
  "status": "Entering",
  "programType": {
    "programTypeId": 201,
    "name": "VR Program"
  },
  "personType": "Applicant",
  "dateCreated": "2019-08-01T00:00:00Z"
}

The following is an overview of the Voter Registration Batch object and its related objects.

Voter Registration Batch

Property	Type	Description
`voterRegistrationBatchId`	int	Read-only; Unique identifier for a VR Batch in this context.
`name`	string	Required. Full display name of the batch
`description`	string	Description of the batch.
`stateCode`	string	Required. The US state of the batch. Must be a valid two letter US state abbreviation.
`form`	object	Required. The voter registration form to associate with this batch.
`status`	string	A string representing the status of the batch. See below for valid values of Batch Status.
`programType`	object	The “Program” for this batch.
`personType`	string	A string representing the type of persons to be added to this batch. See below for valid values of Person Type.
`dateCreated`	date	The date created of the batch.

Form

Property	Type	Description
`formId`	int	Read-only; Unique identifier for a Voter Registration Form in this context.
`name`	string	The name of this form.

Program Type

Property	Type	Description
`programTypeId`	int	Read-only; Unique identifier for a Program Type in this context.
`name`	string	The name of this program type.

Batch Status

One of

Unknown
Entering
Completed
Committed
Processed

Person Type

One of

Applicants
Pledges