.. This file is auto-generated. Do not edit it by hand! .. _single-xml: XML Elements & Enumerations (Single Page) ========================================= .. contents:: :local: .. _single-xml-elements: Elements -------- .. _single-xml-ballot-measure-contest: BallotMeasureContest ~~~~~~~~~~~~~~~~~~~~ The BallotMeasureContest provides information about a ballot measure before the voters, including summary statements on each side. Extends :ref:`single-xml-contest-base`. +------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Tag | Data Type | Required? | Repeats? | Description | Error Handling | +==================+==========================================+==============+==============+==========================================+==========================================+ | ConStatement | :ref:`single-xml-internationalized-text` | Optional | Single | Specifies a statement in opposition to | | | | | | | the referendum. It does not necessarily | | | | | | | appear on the ballot. | | +------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | EffectOfAbstain | :ref:`single-xml-internationalized-text` | Optional | Single | Specifies what effect abstaining (i.e. | | | | | | | not voting) on this proposition will | | | | | | | have (i.e. whether abstaining is | | | | | | | considered a vote against it). | | +------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | FullText | :ref:`single-xml-internationalized-text` | Optional | Single | Specifies the full text of the | | | | | | | referendum as it appears on the ballot. | | +------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | InfoUri | ``xs:anyURI`` | Optional | Single | Specifies a URI that links to additional | | | | | | | information about the referendum. | | +------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | PassageThreshold | :ref:`single-xml-internationalized-text` | Optional | Single | Specifies the threshold of votes that | | | | | | | the referendum needs in order to pass. | | | | | | | The default is a simple majority (i.e. | | | | | | | 50% plus one vote). Other common | | | | | | | thresholds are "three-fifths" and | | | | | | | "two-thirds". If there are `competing | | | | | | | initiatives`_, information about their | | | | | | | effect on the passage of the | | | | | | | BallotMeasureContest would go here. | | +------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | ProStatement | :ref:`single-xml-internationalized-text` | Optional | Single | Specifies a statement in favor of the | | | | | | | referendum. It does not necessarily | | | | | | | appear on the ballot. | | +------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | SummaryText | :ref:`single-xml-internationalized-text` | Optional | Single | Specifies a short summary of the | | | | | | | referendum that is on the ballot, below | | | | | | | the title, but above the text. | | +------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Type | :ref:`single-xml-ballot-measure-type` | Optional | Single | Specifies the particular type of ballot | | | | | | | measure. Must be one of the valid | | | | | | | :ref:`single-xml-ballot-measure-type` | | | | | | | options. | | +------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | OtherType | ``xs:string`` | Optional | Single | Allows for cataloging a new | | | | | | | :ref:`single-xml-ballot-measure-type` | | | | | | | option, when Type is specified as | | | | | | | "other." | | +------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ .. code-block:: xml :linenos: bms30001a bms30001b State of the State Estado del Estado. ed60129 Referendum on Virginia This is no good. Esto no es bueno. Nothing will happen. Nada pasará. Everything will be great. Todo va a estar bien. referendum .. _competing initiatives: http://ballotpedia.org/Laws_governing_the_initiative_process_in_California#Competing_initiatives .. _single-xml-contest-base: ContestBase ^^^^^^^^^^^ A base model for all Contest types: :ref:`single-xml-ballot-measure-contest`, :ref:`single-xml-candidate-contest`, :ref:`single-xml-party-contest`, and :ref:`single-xml-retention-contest` (NB: the latter because it extends :ref:`single-xml-ballot-measure-contest`). +-------------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Tag | Data Type | Required? | Repeats? | Description | Error Handling | +=========================+==========================================+==============+==============+==========================================+==========================================+ | Abbreviation | ``xs:string`` | Optional | Single | An abbreviation for the contest. | | +-------------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | BallotSelectionIds | ``xs:IDREFS`` | Optional | Single | References a set of BallotSelections, | | | | | | | which could be of any selection type | | | | | | | that extends | | | | | | | :ref:`single-xml-ballot-selection-base`. | | +-------------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | BallotSubTitle | :ref:`single-xml-internationalized-text` | Optional | Single | Subtitle of the contest as it appears on | | | | | | | the ballot. | | +-------------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | BallotTitle | :ref:`single-xml-internationalized-text` | Optional | Single | Title of the contest as it appears on | | | | | | | the ballot. | | +-------------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | ElectoralDistrictId | ``xs:IDREF`` | **Required** | Single | References an | | | | | | | :ref:`single-xml-electoral-district` | | | | | | | element that represents the geographical | | | | | | | scope of the contest. | | +-------------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | ElectorateSpecification | :ref:`single-xml-internationalized-text` | Optional | Single | Specifies any changes to the eligible | | | | | | | electorate for this contest past the | | | | | | | usual, "all registered voters" | | | | | | | electorate. This subtag will most often | | | | | | | be used for primaries and local | | | | | | | elections. In primaries, voters may have | | | | | | | to be registered as a specific party to | | | | | | | vote, or there may be special rules for | | | | | | | which ballot a voter can pull. In some | | | | | | | local elections, non-citizens can vote. | | +-------------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | ExternalIdentifiers | :ref:`single-xml-external-identifiers` | Optional | Single | Other identifiers for a contest that | | | | | | | links to another source of information. | | +-------------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | HasRotation | ``xs:boolean`` | Optional | Single | Indicates whether the selections in the | | | | | | | contest are rotated. | | +-------------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Name | ``xs:string`` | **Required** | Single | Name of the contest, not necessarily how | | | | | | | it appears on the ballot (NB: | | | | | | | BallotTitle should be used for this | | | | | | | purpose). | | +-------------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | SequenceOrder | ``xs:integer`` | Optional | Single | Order in which the contests are listed | | | | | | | on the ballot. This is the default | | | | | | | ordering, and can be overrides by data | | | | | | | in a :ref:`single-xml-ballot-style` | | | | | | | element. | | +-------------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | VoteVariation | :ref:`single-xml-vote-variation` | Optional | Single | Vote variation associated with the | | | | | | | contest (e.g. n-of-m, majority, et al). | | +-------------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | OtherVoteVariation | ``xs:string`` | Optional | Single | If "other" is selected as the | | | | | | | **VoteVariation**, the name of the | | | | | | | variation can be specified here. | | +-------------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ .. _single-xml-ballot-measure-selection: BallotMeasureSelection ~~~~~~~~~~~~~~~~~~~~~~ Represents the possible selection (e.g. yes/no, recall/do not recall, et al) for a :ref:`single-xml-ballot-measure-contest` that would appear on the ballot. BallotMeasureSelection extends :ref:`single-xml-ballot-selection-base`. +--------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Tag | Data Type | Required? | Repeats? | Description | Error Handling | +==============+==========================================+==============+==============+==========================================+==========================================+ | Selection | :ref:`single-xml-internationalized-text` | **Required** | Single | Selection text for a | | | | | | | :ref:`single-xml-ballot-measure-contest` | | +--------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ .. code-block:: xml :linenos: Yes Sí No No .. _single-xml-ballot-selection-base: BallotSelectionBase ^^^^^^^^^^^^^^^^^^^ A base model for all ballot selection types: :ref:`single-xml-ballot-measure-selection`, :ref:`single-xml-candidate-selection`, and :ref:`single-xml-party-selection`. +---------------+----------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Tag | Data Type | Required? | Repeats? | Description | Error Handling | +===============+================+==============+==============+==========================================+==========================================+ | SequenceOrder | ``xs:integer`` | Optional | Single | The order in which a selection can be | | | | | | | listed on the ballot or in results. This | | | | | | | is the default ordering, and can be | | | | | | | overridden by `OrderedBallotSlectionIds` | | | | | | | in :ref:`single-xml-ordered-contest`. | | +---------------+----------------+--------------+--------------+------------------------------------------+------------------------------------------+ .. _single-xml-ballot-selection-base: BallotSelectionBase ~~~~~~~~~~~~~~~~~~~ A base model for all ballot selection types: :ref:`single-xml-ballot-measure-selection`, :ref:`single-xml-candidate-selection`, and :ref:`single-xml-party-selection`. +---------------+----------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Tag | Data Type | Required? | Repeats? | Description | Error Handling | +===============+================+==============+==============+==========================================+==========================================+ | SequenceOrder | ``xs:integer`` | Optional | Single | The order in which a selection can be | | | | | | | listed on the ballot or in results. This | | | | | | | is the default ordering, and can be | | | | | | | overridden by `OrderedBallotSlectionIds` | | | | | | | in :ref:`single-xml-ordered-contest`. | | +---------------+----------------+--------------+--------------+------------------------------------------+------------------------------------------+ .. _single-xml-ballot-style: BallotStyle ~~~~~~~~~~~ A container for the contests/measures on the ballot. +-------------------+---------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Tag | Data Type | Required? | Repeats? | Description | Error Handling | +===================+===============+==============+==============+==========================================+==========================================+ | ImageUri | ``xs:anyURI`` | Optional | Single | Specifies a URI that returns an image of | | | | | | | the sample ballot. | | +-------------------+---------------+--------------+--------------+------------------------------------------+------------------------------------------+ | OrderedContestIds | ``xs:IDREFS`` | Optional | Single | Reference to a set of | | | | | | | :ref:`single-xml-ordered-contest` | | +-------------------+---------------+--------------+--------------+------------------------------------------+------------------------------------------+ | PartyIds | ``xs:IDREFS`` | Optional | Single | Reference to a set of | | | | | | | :ref:`single-xml-party`s. | | +-------------------+---------------+--------------+--------------+------------------------------------------+------------------------------------------+ .. code-block:: xml :linenos: oc20003 oc20004 oc20005 oc20025 oc20355 oc20449 .. _single-xml-candidate: Candidate ~~~~~~~~~ The Candidate object represents a candidate in a contest. If a candidate is running in multiple contests, each contest **must** have its own Candidate object. Candidate objects may **not** be reused between Contests. +---------------------+--------------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Tag | Data Type | Required? | Repeats? | Description | Error Handling | +=====================+==================================================+==============+==============+==========================================+==========================================+ | BallotName | :ref:`single-xml-internationalized-text` | **Required** | Single | The candidate's name as it will be | | | | | | | displayed on the official ballot (e.g. | | | | | | | "Ken T. Cuccinelli II"). | | +---------------------+--------------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | ContactInformation | :ref:`single-xml-contact-information` | Optional | Single | Contact and physical address information | | | | | | | for this Candidate and/or their campaign | | | | | | | (see | | | | | | | :ref:`single-xml-contact-information`). | | +---------------------+--------------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | ExternalIdentifiers | :ref:`single-xml-external-identifiers` | Optional | Single | Another identifier for a candidate that | | | | | | | links to another source of information | | | | | | | (e.g. a campaign committee ID that links | | | | | | | to a campaign finance system). | | +---------------------+--------------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | FileDate | ``xs:date`` | Optional | Single | Date when the candidate filed for the | | | | | | | contest. | | +---------------------+--------------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | IsIncumbent | ``xs:boolean`` | Optional | Single | Indicates whether the candidate is the | | | | | | | incumbent for the office associated with | | | | | | | the contest. | | +---------------------+--------------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | IsTopTicket | ``xs:boolean`` | Optional | Single | Indicates whether the candidate is the | | | | | | | top of a ticket that includes multiple | | | | | | | candidates. | | +---------------------+--------------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | PartyId | ``xs:IDREF`` | Optional | Single | Reference to a :ref:`single-xml-party` | | | | | | | element with additional information | | | | | | | about the candidate's affiliated party. | | | | | | | This is the party affiliation that is | | | | | | | intended to be presented as part of | | | | | | | ballot information. | | +---------------------+--------------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | PersonId | ``xs:IDREF`` | Optional | Single | Reference to a :ref:`single-xml-person` | | | | | | | element with additional information | | | | | | | about the candidate. | | +---------------------+--------------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | PostElectionStatus | :ref:`single-xml-candidate-post-election-status` | Optional | Single | Final status of the candidate (e.g. | | | | | | | winner, withdrawn, etc...). | | +---------------------+--------------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | PreElectionStatus | :ref:`single-xml-candidate-pre-election-status` | Optional | Single | Registration status of the candidate | | | | | | | (e.g. filed, qualified, etc...). | | +---------------------+--------------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ .. code-block:: xml :linenos: Ken T. Cuccinelli II par0001 per10961 .. _single-xml-candidate-contest: CandidateContest ~~~~~~~~~~~~~~~~ CandidateContest extends :ref:`single-xml-contest-base` and represents a contest among candidates. +-----------------+----------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Tag | Data Type | Required? | Repeats? | Description | Error Handling | +=================+================+==============+==============+==========================================+==========================================+ | NumberElected | ``xs:integer`` | Optional | Single | Number of candidates that are elected in | | | | | | | the contest (i.e. "N" of N-of-M). | | +-----------------+----------------+--------------+--------------+------------------------------------------+------------------------------------------+ | OfficeIds | ``xs:IDREFS`` | Optional | Single | References a set of | | | | | | | :ref:`single-xml-office` elements, if | | | | | | | available, which give additional | | | | | | | information about the offices. **Note:** | | | | | | | the order of the office IDs **must** be | | | | | | | in the same order as the candidates | | | | | | | listed in `BallotSelectionIds`. E.g., if | | | | | | | the various `BallotSelectionIds` | | | | | | | reference | | | | | | | :ref:`single-xml-candidate-selection` | | | | | | | elements which reference the candidate | | | | | | | for President first and Vice-President | | | | | | | second, the `OfficeIds` should reference | | | | | | | the office of President first and the | | | | | | | office of Vice-President second. | | +-----------------+----------------+--------------+--------------+------------------------------------------+------------------------------------------+ | PrimaryPartyIds | ``xs:IDREFS`` | Optional | Single | References :ref:`single-xml-party` | | | | | | | elements, if the contest is related to a | | | | | | | particular party. | | +-----------------+----------------+--------------+--------------+------------------------------------------+------------------------------------------+ | VotesAllowed | ``xs:integer`` | Optional | Single | Maximum number of votes/write-ins per | | | | | | | voter in this contest. | | +-----------------+----------------+--------------+--------------+------------------------------------------+------------------------------------------+ .. code-block:: xml :linenos: cs10961 cs10962 cs10963 Governor of Virginia ed60129 Governor 1 off0000 1 .. _single-xml-contest-base: ContestBase ^^^^^^^^^^^ A base model for all Contest types: :ref:`single-xml-ballot-measure-contest`, :ref:`single-xml-candidate-contest`, :ref:`single-xml-party-contest`, and :ref:`single-xml-retention-contest` (NB: the latter because it extends :ref:`single-xml-ballot-measure-contest`). +-------------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Tag | Data Type | Required? | Repeats? | Description | Error Handling | +=========================+==========================================+==============+==============+==========================================+==========================================+ | Abbreviation | ``xs:string`` | Optional | Single | An abbreviation for the contest. | | +-------------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | BallotSelectionIds | ``xs:IDREFS`` | Optional | Single | References a set of BallotSelections, | | | | | | | which could be of any selection type | | | | | | | that extends | | | | | | | :ref:`single-xml-ballot-selection-base`. | | +-------------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | BallotSubTitle | :ref:`single-xml-internationalized-text` | Optional | Single | Subtitle of the contest as it appears on | | | | | | | the ballot. | | +-------------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | BallotTitle | :ref:`single-xml-internationalized-text` | Optional | Single | Title of the contest as it appears on | | | | | | | the ballot. | | +-------------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | ElectoralDistrictId | ``xs:IDREF`` | **Required** | Single | References an | | | | | | | :ref:`single-xml-electoral-district` | | | | | | | element that represents the geographical | | | | | | | scope of the contest. | | +-------------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | ElectorateSpecification | :ref:`single-xml-internationalized-text` | Optional | Single | Specifies any changes to the eligible | | | | | | | electorate for this contest past the | | | | | | | usual, "all registered voters" | | | | | | | electorate. This subtag will most often | | | | | | | be used for primaries and local | | | | | | | elections. In primaries, voters may have | | | | | | | to be registered as a specific party to | | | | | | | vote, or there may be special rules for | | | | | | | which ballot a voter can pull. In some | | | | | | | local elections, non-citizens can vote. | | +-------------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | ExternalIdentifiers | :ref:`single-xml-external-identifiers` | Optional | Single | Other identifiers for a contest that | | | | | | | links to another source of information. | | +-------------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | HasRotation | ``xs:boolean`` | Optional | Single | Indicates whether the selections in the | | | | | | | contest are rotated. | | +-------------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Name | ``xs:string`` | **Required** | Single | Name of the contest, not necessarily how | | | | | | | it appears on the ballot (NB: | | | | | | | BallotTitle should be used for this | | | | | | | purpose). | | +-------------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | SequenceOrder | ``xs:integer`` | Optional | Single | Order in which the contests are listed | | | | | | | on the ballot. This is the default | | | | | | | ordering, and can be overrides by data | | | | | | | in a :ref:`single-xml-ballot-style` | | | | | | | element. | | +-------------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | VoteVariation | :ref:`single-xml-vote-variation` | Optional | Single | Vote variation associated with the | | | | | | | contest (e.g. n-of-m, majority, et al). | | +-------------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | OtherVoteVariation | ``xs:string`` | Optional | Single | If "other" is selected as the | | | | | | | **VoteVariation**, the name of the | | | | | | | variation can be specified here. | | +-------------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ .. _single-xml-candidate-selection: CandidateSelection ~~~~~~~~~~~~~~~~~~ CandidateSelection extends :ref:`single-xml-ballot-selection-base` and represents a ballot selection for a candidate contest. +---------------------+----------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Tag | Data Type | Required? | Repeats? | Description | Error Handling | +=====================+================+==============+==============+==========================================+==========================================+ | CandidateIds | ``xs:IDREFS`` | Optional | Single | References a set of | | | | | | | :ref:`single-xml-candidate` elements. | | | | | | | The number of candidates that can be | | | | | | | references is unbounded in cases where | | | | | | | the ballot selection is for a ticket | | | | | | | (e.g. "President/Vice President", | | | | | | | "Governor/Lt Governor"). | | +---------------------+----------------+--------------+--------------+------------------------------------------+------------------------------------------+ | EndorsementPartyIds | ``xs:IDREFS`` | Optional | Single | References a set of | | | | | | | :ref:`single-xml-party` elements, which | | | | | | | signifies one or more endorsing parties | | | | | | | for the candidate(s). | | +---------------------+----------------+--------------+--------------+------------------------------------------+------------------------------------------+ | IsWriteIn | ``xs:boolean`` | Optional | Single | Signifies if the particular ballot | | | | | | | selection allows for write-in | | | | | | | candidates. If true, one or more | | | | | | | write-in candidates are allowed for this | | | | | | | contest. | | +---------------------+----------------+--------------+--------------+------------------------------------------+------------------------------------------+ .. code-block:: xml :linenos: can10861a can10861b par0001 .. _single-xml-ballot-selection-base: BallotSelectionBase ^^^^^^^^^^^^^^^^^^^ A base model for all ballot selection types: :ref:`single-xml-ballot-measure-selection`, :ref:`single-xml-candidate-selection`, and :ref:`single-xml-party-selection`. +---------------+----------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Tag | Data Type | Required? | Repeats? | Description | Error Handling | +===============+================+==============+==============+==========================================+==========================================+ | SequenceOrder | ``xs:integer`` | Optional | Single | The order in which a selection can be | | | | | | | listed on the ballot or in results. This | | | | | | | is the default ordering, and can be | | | | | | | overridden by `OrderedBallotSlectionIds` | | | | | | | in :ref:`single-xml-ordered-contest`. | | +---------------+----------------+--------------+--------------+------------------------------------------+------------------------------------------+ .. _single-xml-checksum: Checksum ~~~~~~~~ The ``Checksum`` object contains information about a cryptographic checksum, including the raw checksum value and the cryptographic hash algorithm used to compute it. +--------------+--------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Tag | Data Type | Required? | Repeats? | Description | Error Handling | +==============+======================================+==============+==============+==========================================+==========================================+ | Algorithm | :ref:`single-xml-checksum-algorithm` | **Required** | Single | The cryptographic hash algorithm used to | | | | | | | compute the checksum value. | | +--------------+--------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Value | ``xs:string`` | **Required** | Single | The raw cryptographic checksum value | | | | | | | encoded as a non-delimited, lowercase | | | | | | | hexadecimal string. | | +--------------+--------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ .. code-block:: xml :linenos: sha-256 65b634c5037f8a344616020d8060d233daa37b0f032a71d0d15ad7a5d3afa68e .. _single-xml-contact-information: ContactInformation ~~~~~~~~~~~~~~~~~~ For defining contact information about objects such as persons, boards of authorities, organizations, etc. ContactInformation is always a sub-element of another object (e.g. :ref:`single-xml-election-administration`, :ref:`single-xml-office`, :ref:`single-xml-person`, :ref:`single-xml-source`). ContactInformation has an optional attribute ``label``, which allows the feed to refer back to the original label for the information (e.g. if the contact information came from a CSV, ``label`` may refer to a row ID). +------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Tag | Data Type | Required? | Repeats? | Description | Error Handling | +==================+==========================================+==============+==============+==========================================+==========================================+ | AddressLine | ``xs:string`` | Optional | Repeats | The "location" portion of a mailing | | | | | | | address. :ref:`See usage note. | | | | | | | ` | | +------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Directions | :ref:`single-xml-internationalized-text` | Optional | Single | Specifies further instructions for | | | | | | | locating this entity. | | +------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Email | ``xs:string`` | Optional | Repeats | An email address for the contact. | | +------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Fax | ``xs:string`` | Optional | Repeats | A fax line for the contact. | | +------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Hours | :ref:`single-xml-internationalized-text` | Optional | Single | Contains the hours (in local time) that | | | **[deprecated]** | | | | the location is open *(NB: this element | | | | | | | is deprecated in favor of the more | | | | | | | structured :ref:`single-xml-hours-open` | | | | | | | element. It is strongly encouraged that | | | | | | | data providers move toward contributing | | | | | | | hours in this format)*. | | +------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | HoursOpenId | ``xs:IDREF`` | Optional | Single | References an | | | | | | | :ref:`single-xml-hours-open` element, | | | | | | | which lists the hours of operation for a | | | | | | | location. | | +------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | LatLng | :ref:`single-xml-lat-lng` | Optional | Single | Specifies the latitude and longitude of | | | | | | | this entity. | | +------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Name | ``xs:string`` | Optional | Single | The name of the location or contact. | | | | | | | :ref:`See usage note. | | | | | | | ` | | +------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Phone | ``xs:string`` | Optional | Repeats | A phone number for the contact. | | +------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Uri | ``xs:anyURI`` | Optional | Repeats | An informational URI for the contact or | | | | | | | location. | | +------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ .. _single-xml-name-address-line-usage: ``Name`` and ``AddressLine`` Usage Note ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ The ``Name`` and ``AddressLine`` fields should be chosen so that a display or mailing address can be constructed programmatically by joining the ``Name`` and ``AddressLine`` fields together. For example, for the following address:: Department of Elections 1 Dr. Carlton B. Goodlett Place, Room 48 San Francisco, CA 94102 The name could be "Department of Elections" and the first address line could be "1 Dr. Carlton B. Goodlett Place, Room 48." However, VIP does not yet support the representation of mailing addresses whose "name" portion spans more than one line, for example:: California Secretary of State Elections Division 1500 11th Street Sacramento, CA 95814 For addresses like the above, we recommend choosing a name like, "California Secretary of State, Elections Division" with "1500 11th Street" as the first address line. This would result in a programmatically constructed address like the following:: California Secretary of State, Elections Division 1500 11th Street Sacramento, CA 95814 .. code-block:: xml :linenos: 1600 Pennsylvania Ave Washington, DC 20006 president@whitehouse.gov 202-456-1111 202-456-6213 http://www.whitehouse.gov .. _single-xml-contest-base: ContestBase ~~~~~~~~~~~ A base model for all Contest types: :ref:`single-xml-ballot-measure-contest`, :ref:`single-xml-candidate-contest`, :ref:`single-xml-party-contest`, and :ref:`single-xml-retention-contest` (NB: the latter because it extends :ref:`single-xml-ballot-measure-contest`). +-------------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Tag | Data Type | Required? | Repeats? | Description | Error Handling | +=========================+==========================================+==============+==============+==========================================+==========================================+ | Abbreviation | ``xs:string`` | Optional | Single | An abbreviation for the contest. | | +-------------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | BallotSelectionIds | ``xs:IDREFS`` | Optional | Single | References a set of BallotSelections, | | | | | | | which could be of any selection type | | | | | | | that extends | | | | | | | :ref:`single-xml-ballot-selection-base`. | | +-------------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | BallotSubTitle | :ref:`single-xml-internationalized-text` | Optional | Single | Subtitle of the contest as it appears on | | | | | | | the ballot. | | +-------------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | BallotTitle | :ref:`single-xml-internationalized-text` | Optional | Single | Title of the contest as it appears on | | | | | | | the ballot. | | +-------------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | ElectoralDistrictId | ``xs:IDREF`` | **Required** | Single | References an | | | | | | | :ref:`single-xml-electoral-district` | | | | | | | element that represents the geographical | | | | | | | scope of the contest. | | +-------------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | ElectorateSpecification | :ref:`single-xml-internationalized-text` | Optional | Single | Specifies any changes to the eligible | | | | | | | electorate for this contest past the | | | | | | | usual, "all registered voters" | | | | | | | electorate. This subtag will most often | | | | | | | be used for primaries and local | | | | | | | elections. In primaries, voters may have | | | | | | | to be registered as a specific party to | | | | | | | vote, or there may be special rules for | | | | | | | which ballot a voter can pull. In some | | | | | | | local elections, non-citizens can vote. | | +-------------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | ExternalIdentifiers | :ref:`single-xml-external-identifiers` | Optional | Single | Other identifiers for a contest that | | | | | | | links to another source of information. | | +-------------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | HasRotation | ``xs:boolean`` | Optional | Single | Indicates whether the selections in the | | | | | | | contest are rotated. | | +-------------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Name | ``xs:string`` | **Required** | Single | Name of the contest, not necessarily how | | | | | | | it appears on the ballot (NB: | | | | | | | BallotTitle should be used for this | | | | | | | purpose). | | +-------------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | SequenceOrder | ``xs:integer`` | Optional | Single | Order in which the contests are listed | | | | | | | on the ballot. This is the default | | | | | | | ordering, and can be overrides by data | | | | | | | in a :ref:`single-xml-ballot-style` | | | | | | | element. | | +-------------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | VoteVariation | :ref:`single-xml-vote-variation` | Optional | Single | Vote variation associated with the | | | | | | | contest (e.g. n-of-m, majority, et al). | | +-------------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | OtherVoteVariation | ``xs:string`` | Optional | Single | If "other" is selected as the | | | | | | | **VoteVariation**, the name of the | | | | | | | variation can be specified here. | | +-------------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ .. _single-xml-department: Department ~~~~~~~~~~ +--------------------------+---------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Tag | Data Type | Required? | Repeats? | Description | Error Handling | +==========================+=======================================+==============+==============+==========================================+==========================================+ | ContactInformation | :ref:`single-xml-contact-information` | Optional | Single | Contact and physical address information | | | | | | | for the election administration body | | | | | | | (see | | | | | | | :ref:`single-xml-contact-information`). | | +--------------------------+---------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | ElectionOfficialPersonId | ``xs:IDREF`` | Optional | Single | The individual to contact at the | | | | | | | election administration office. The | | | | | | | specified person should be the | | | | | | | :ref:`election official | | | | | | | `. | | +--------------------------+---------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | VoterService | :ref:`single-xml-voter-service` | Optional | Repeats | The types of services and appropriate | | | | | | | contact individual available to voters. | | +--------------------------+---------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ .. _single-xml-voter-service: VoterService ^^^^^^^^^^^^ +--------------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Tag | Data Type | Required? | Repeats? | Description | Error Handling | +==========================+==========================================+==============+==============+==========================================+==========================================+ | ContactInformation | :ref:`single-xml-contact-information` | Optional | Single | The contact for a particular voter | | | | | | | service. | | +--------------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Description | :ref:`single-xml-internationalized-text` | Optional | Single | Long description of the services | | | | | | | available. | | +--------------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | ElectionOfficialPersonId | ``xs:IDREF`` | Optional | Single | The :ref:`authority ` | | | | | | | for a particular voter service. | | +--------------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Type | :ref:`single-xml-voter-service-type` | Optional | Single | The type of :ref:`voter service | | | | | | | `. | | +--------------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | OtherType | ``xs:string`` | Optional | Single | If Type is "other", OtherType allows for | | | | | | | cataloging another type of voter | | | | | | | service. | | +--------------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ .. _single-xml-contact-information: ContactInformation ^^^^^^^^^^^^^^^^^^ For defining contact information about objects such as persons, boards of authorities, organizations, etc. ContactInformation is always a sub-element of another object (e.g. :ref:`single-xml-election-administration`, :ref:`single-xml-office`, :ref:`single-xml-person`, :ref:`single-xml-source`). ContactInformation has an optional attribute ``label``, which allows the feed to refer back to the original label for the information (e.g. if the contact information came from a CSV, ``label`` may refer to a row ID). +------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Tag | Data Type | Required? | Repeats? | Description | Error Handling | +==================+==========================================+==============+==============+==========================================+==========================================+ | AddressLine | ``xs:string`` | Optional | Repeats | The "location" portion of a mailing | | | | | | | address. :ref:`See usage note. | | | | | | | ` | | +------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Directions | :ref:`single-xml-internationalized-text` | Optional | Single | Specifies further instructions for | | | | | | | locating this entity. | | +------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Email | ``xs:string`` | Optional | Repeats | An email address for the contact. | | +------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Fax | ``xs:string`` | Optional | Repeats | A fax line for the contact. | | +------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Hours | :ref:`single-xml-internationalized-text` | Optional | Single | Contains the hours (in local time) that | | | **[deprecated]** | | | | the location is open *(NB: this element | | | | | | | is deprecated in favor of the more | | | | | | | structured :ref:`single-xml-hours-open` | | | | | | | element. It is strongly encouraged that | | | | | | | data providers move toward contributing | | | | | | | hours in this format)*. | | +------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | HoursOpenId | ``xs:IDREF`` | Optional | Single | References an | | | | | | | :ref:`single-xml-hours-open` element, | | | | | | | which lists the hours of operation for a | | | | | | | location. | | +------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | LatLng | :ref:`single-xml-lat-lng` | Optional | Single | Specifies the latitude and longitude of | | | | | | | this entity. | | +------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Name | ``xs:string`` | Optional | Single | The name of the location or contact. | | | | | | | :ref:`See usage note. | | | | | | | ` | | +------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Phone | ``xs:string`` | Optional | Repeats | A phone number for the contact. | | +------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Uri | ``xs:anyURI`` | Optional | Repeats | An informational URI for the contact or | | | | | | | location. | | +------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ .. _single-xml-name-address-line-usage: ``Name`` and ``AddressLine`` Usage Note ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ The ``Name`` and ``AddressLine`` fields should be chosen so that a display or mailing address can be constructed programmatically by joining the ``Name`` and ``AddressLine`` fields together. For example, for the following address:: Department of Elections 1 Dr. Carlton B. Goodlett Place, Room 48 San Francisco, CA 94102 The name could be "Department of Elections" and the first address line could be "1 Dr. Carlton B. Goodlett Place, Room 48." However, VIP does not yet support the representation of mailing addresses whose "name" portion spans more than one line, for example:: California Secretary of State Elections Division 1500 11th Street Sacramento, CA 95814 For addresses like the above, we recommend choosing a name like, "California Secretary of State, Elections Division" with "1500 11th Street" as the first address line. This would result in a programmatically constructed address like the following:: California Secretary of State, Elections Division 1500 11th Street Sacramento, CA 95814 .. code-block:: xml :linenos: 1600 Pennsylvania Ave Washington, DC 20006 president@whitehouse.gov 202-456-1111 202-456-6213 http://www.whitehouse.gov .. _single-xml-election: Election ~~~~~~~~ The Election object represents an Election Day, which usually consists of many individual contests and/or referenda. A feed must contain **exactly one** Election object. All relationships in the feed (e.g., street segment to precinct to polling location) are assumed to relate only to the Election specified by this object. It is permissible, and recommended, to combine unrelated contests (e.g., a special election and a general election) that occur on the same day into one feed with one Election object. +----------------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Tag | Data Type | Required? | Repeats? | Description | Error Handling | +============================+==========================================+==============+==============+==========================================+==========================================+ | Date | ``xs:date`` | **Required** | Single | Specifies when the election is being | | | | | | | held. The `Date` is considered to be in | | | | | | | the timezone local to the state holding | | | | | | | the election. | | +----------------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | ElectionType | :ref:`single-xml-internationalized-text` | Optional | Single | Specifies the highest controlling | | | | | | | authority for election (e.g., federal, | | | | | | | state, county, city, town, etc.) | | +----------------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | StateId | ``xs:IDREF`` | **Required** | Single | Specifies a link to the `State` element | | | | | | | where the election is being held. | | +----------------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | IsStatewide | ``xs:boolean`` | Optional | Single | Indicates whether the election is | If the field is not present or invalid, | | | | | | statewide. | the implementation is required to | | | | | | | default to "yes". | +----------------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Name | :ref:`single-xml-internationalized-text` | Optional | Single | The name for the election (**NB:** while | | | | | | | optional, this element is highly | | | | | | | recommended). | | +----------------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | RegistrationInfo | :ref:`single-xml-internationalized-text` | Optional | Single | Specifies information about registration | | | | | | | for this election either as text or a | | | | | | | URI. | | +----------------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | AbsenteeBallotInfo | :ref:`single-xml-internationalized-text` | Optional | Single | Specifies information about requesting | | | | | | | absentee ballots either as text or a URI | | +----------------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | ResultsUri | ``xs:anyURI`` | Optional | Single | Contains a URI where results for the | | | | | | | election may be found | | +----------------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | PollingHours | :ref:`single-xml-internationalized-text` | Optional | Single | Contains the hours (in local time) that | | | **[deprecated]** | | | | Election Day polling locations are open. | | | | | | | If polling hours differ in specific | | | | | | | polling locations, alternative hours may | | | | | | | be specified in the | | | | | | | :ref:`single-xml-polling-location` | | | | | | | object *(NB: this element is deprecated | | | | | | | in favor of the more structured | | | | | | | :ref:`single-xml-hours-open` element. It | | | | | | | is strongly encouraged that data | | | | | | | providers move toward contributing hours | | | | | | | in this format)*. | | +----------------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | HoursOpenId | ``xs:IDREF`` | Optional | Single | References the | | | | | | | :ref:`single-xml-hours-open` element, | | | | | | | which lists the hours of operation for | | | | | | | polling locations. | | +----------------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | HasElectionDayRegistration | ``xs:boolean`` | Optional | Single | Specifies if a voter can register on the | | | | | | | same day of the election (i.e., the last | | | | | | | day of the election). Valid items are | | | | | | | "yes" and "no". | | +----------------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | RegistrationDeadline | ``xs:date`` | Optional | Single | Specifies the last day to register for | | | | | | | the election with the possible exception | | | | | | | of Election Day registration. | | +----------------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | AbsenteeRequestDeadline | ``xs:date`` | Optional | Single | Specifies the last day to request an | | | | | | | absentee ballot. | | +----------------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ .. code-block:: xml :linenos: 2013-10-30 2013-11-05 General Generales false hours0001 true 2013 Statewide General 2013-10-15 http://www.sbe.virginia.gov/ElectionResults.html st51 .. _single-xml-election-administration: ElectionAdministration ~~~~~~~~~~~~~~~~~~~~~~ The Election Administration represents an institution for serving a locality's (or state's) election functions. +------------------------------+-----------------------------------+--------------+--------------+-------------------------------------------------------------+------------------------------------------+ | Tag | Data Type | Required? | Repeats? | Description | Error Handling | +==============================+===================================+==============+==============+=============================================================+==========================================+ | AbsenteeUri | ``xs:anyURI`` | Optional | Single | Specifies the web address for information on absentee | | | | | | | voting. | | +------------------------------+-----------------------------------+--------------+--------------+-------------------------------------------------------------+------------------------------------------+ | AmIRegisteredUri | ``xs:anyURI`` | Optional | Single | Specifies the web address for information on whether an | | | | | | | individual is registered. | | +------------------------------+-----------------------------------+--------------+--------------+-------------------------------------------------------------+------------------------------------------+ | BallotTrackingUri | ``xs:anyURI`` | Optional | Single | Specifies the web address for tracking information for a | | | | | | | ballot cast by mail | | +------------------------------+-----------------------------------+--------------+--------------+-------------------------------------------------------------+------------------------------------------+ | BallotProvisionalTrackingUri | ``xs:anyURI`` | Optional | Single | Specifies the web address for tracking information for a | | | | | | | provisional ballot. To support EAC guidelines for | | | | | | | "Processing Provisional Ballots" | | | | | | | (https://www.eac.gov/research-and-data/provisional-voting/) | | +------------------------------+-----------------------------------+--------------+--------------+-------------------------------------------------------------+------------------------------------------+ | Department | :ref:`single-xml-department` | Optional | Repeats | Describes the administrative body for a particular voter | | | | | | | service. | | +------------------------------+-----------------------------------+--------------+--------------+-------------------------------------------------------------+------------------------------------------+ | ElectionNotice | :ref:`single-xml-election-notice` | Optional | Single | A place for election administrators to post last minute and | | | | | | | emergency notifications pertaining to the election. | | +------------------------------+-----------------------------------+--------------+--------------+-------------------------------------------------------------+------------------------------------------+ | ElectionsUri | ``xs:anyURI`` | Optional | Single | Specifies web address the administration's website. | | +------------------------------+-----------------------------------+--------------+--------------+-------------------------------------------------------------+------------------------------------------+ | RegistrationUri | ``xs:anyURI`` | Optional | Single | Specifies web address for information on registering to | | | | | | | vote. | | +------------------------------+-----------------------------------+--------------+--------------+-------------------------------------------------------------+------------------------------------------+ | RulesUri | ``xs:anyURI`` | Optional | Single | Specifies a URI for the election rules and laws (if any) | | | | | | | for the jurisdiction of the administration. | | +------------------------------+-----------------------------------+--------------+--------------+-------------------------------------------------------------+------------------------------------------+ | WhatIsOnMyBallotUri | ``xs:anyURI`` | Optional | Single | Specifies web address for information on what is on an | | | | | | | individual's ballot. | | +------------------------------+-----------------------------------+--------------+--------------+-------------------------------------------------------------+------------------------------------------+ | WhereDoIVoteUri | ``xs:anyURI`` | Optional | Single | The Specifies web address for information on where an | | | | | | | individual votes based on their address. | | +------------------------------+-----------------------------------+--------------+--------------+-------------------------------------------------------------+------------------------------------------+ .. code-block:: xml :linenos: http://www.sbe.virginia.gov/absenteevoting.html https://www.vote.virginia.gov/ https://www.vote.virginia.gov/ https://www.vote.virginia.gov/ Washington Building First Floor 1100 Bank Street Richmond, VA 23219 State Board of Elections This is an emergency notification for this election. https://www.yadayada.gov http://www.sbe.virginia.gov/ https://www.vote.virginia.gov/ http://www.sbe.virginia.gov/ https://www.vote.virginia.gov/ https://www.vote.virginia.gov/ .. _single-xml-department: Department ^^^^^^^^^^ +--------------------------+---------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Tag | Data Type | Required? | Repeats? | Description | Error Handling | +==========================+=======================================+==============+==============+==========================================+==========================================+ | ContactInformation | :ref:`single-xml-contact-information` | Optional | Single | Contact and physical address information | | | | | | | for the election administration body | | | | | | | (see | | | | | | | :ref:`single-xml-contact-information`). | | +--------------------------+---------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | ElectionOfficialPersonId | ``xs:IDREF`` | Optional | Single | The individual to contact at the | | | | | | | election administration office. The | | | | | | | specified person should be the | | | | | | | :ref:`election official | | | | | | | `. | | +--------------------------+---------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | VoterService | :ref:`single-xml-voter-service` | Optional | Repeats | The types of services and appropriate | | | | | | | contact individual available to voters. | | +--------------------------+---------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ .. _single-xml-voter-service: VoterService %%%%%%%%%%%% +--------------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Tag | Data Type | Required? | Repeats? | Description | Error Handling | +==========================+==========================================+==============+==============+==========================================+==========================================+ | ContactInformation | :ref:`single-xml-contact-information` | Optional | Single | The contact for a particular voter | | | | | | | service. | | +--------------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Description | :ref:`single-xml-internationalized-text` | Optional | Single | Long description of the services | | | | | | | available. | | +--------------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | ElectionOfficialPersonId | ``xs:IDREF`` | Optional | Single | The :ref:`authority ` | | | | | | | for a particular voter service. | | +--------------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Type | :ref:`single-xml-voter-service-type` | Optional | Single | The type of :ref:`voter service | | | | | | | `. | | +--------------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | OtherType | ``xs:string`` | Optional | Single | If Type is "other", OtherType allows for | | | | | | | cataloging another type of voter | | | | | | | service. | | +--------------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ .. _single-xml-contact-information: ContactInformation %%%%%%%%%%%%%%%%%% For defining contact information about objects such as persons, boards of authorities, organizations, etc. ContactInformation is always a sub-element of another object (e.g. :ref:`single-xml-election-administration`, :ref:`single-xml-office`, :ref:`single-xml-person`, :ref:`single-xml-source`). ContactInformation has an optional attribute ``label``, which allows the feed to refer back to the original label for the information (e.g. if the contact information came from a CSV, ``label`` may refer to a row ID). +------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Tag | Data Type | Required? | Repeats? | Description | Error Handling | +==================+==========================================+==============+==============+==========================================+==========================================+ | AddressLine | ``xs:string`` | Optional | Repeats | The "location" portion of a mailing | | | | | | | address. :ref:`See usage note. | | | | | | | ` | | +------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Directions | :ref:`single-xml-internationalized-text` | Optional | Single | Specifies further instructions for | | | | | | | locating this entity. | | +------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Email | ``xs:string`` | Optional | Repeats | An email address for the contact. | | +------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Fax | ``xs:string`` | Optional | Repeats | A fax line for the contact. | | +------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Hours | :ref:`single-xml-internationalized-text` | Optional | Single | Contains the hours (in local time) that | | | **[deprecated]** | | | | the location is open *(NB: this element | | | | | | | is deprecated in favor of the more | | | | | | | structured :ref:`single-xml-hours-open` | | | | | | | element. It is strongly encouraged that | | | | | | | data providers move toward contributing | | | | | | | hours in this format)*. | | +------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | HoursOpenId | ``xs:IDREF`` | Optional | Single | References an | | | | | | | :ref:`single-xml-hours-open` element, | | | | | | | which lists the hours of operation for a | | | | | | | location. | | +------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | LatLng | :ref:`single-xml-lat-lng` | Optional | Single | Specifies the latitude and longitude of | | | | | | | this entity. | | +------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Name | ``xs:string`` | Optional | Single | The name of the location or contact. | | | | | | | :ref:`See usage note. | | | | | | | ` | | +------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Phone | ``xs:string`` | Optional | Repeats | A phone number for the contact. | | +------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Uri | ``xs:anyURI`` | Optional | Repeats | An informational URI for the contact or | | | | | | | location. | | +------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ .. _single-xml-name-address-line-usage: ``Name`` and ``AddressLine`` Usage Note ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ The ``Name`` and ``AddressLine`` fields should be chosen so that a display or mailing address can be constructed programmatically by joining the ``Name`` and ``AddressLine`` fields together. For example, for the following address:: Department of Elections 1 Dr. Carlton B. Goodlett Place, Room 48 San Francisco, CA 94102 The name could be "Department of Elections" and the first address line could be "1 Dr. Carlton B. Goodlett Place, Room 48." However, VIP does not yet support the representation of mailing addresses whose "name" portion spans more than one line, for example:: California Secretary of State Elections Division 1500 11th Street Sacramento, CA 95814 For addresses like the above, we recommend choosing a name like, "California Secretary of State, Elections Division" with "1500 11th Street" as the first address line. This would result in a programmatically constructed address like the following:: California Secretary of State, Elections Division 1500 11th Street Sacramento, CA 95814 .. code-block:: xml :linenos: 1600 Pennsylvania Ave Washington, DC 20006 president@whitehouse.gov 202-456-1111 202-456-6213 http://www.whitehouse.gov .. _single-xml-election-notice: ElectionNotice ^^^^^^^^^^^^^^ +--------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Tag | Data Type | Required? | Repeats? | Description | Error Handling | +==============+==========================================+==============+==============+==========================================+==========================================+ | NoticeText | :ref:`single-xml-internationalized-text` | **Required** | Single | The last minute or emergency | | | | | | | notification text should be placed here. | | +--------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | NoticeUri | ``xs:anyURI`` | Optional | Single | Optional URL for additional information | | | | | | | related to the last minute or emergency | | | | | | | notification. | | +--------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ .. _single-xml-voter-service: VoterService ^^^^^^^^^^^^ +--------------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Tag | Data Type | Required? | Repeats? | Description | Error Handling | +==========================+==========================================+==============+==============+==========================================+==========================================+ | ContactInformation | :ref:`single-xml-contact-information` | Optional | Single | The contact for a particular voter | | | | | | | service. | | +--------------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Description | :ref:`single-xml-internationalized-text` | Optional | Single | Long description of the services | | | | | | | available. | | +--------------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | ElectionOfficialPersonId | ``xs:IDREF`` | Optional | Single | The :ref:`authority ` | | | | | | | for a particular voter service. | | +--------------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Type | :ref:`single-xml-voter-service-type` | Optional | Single | The type of :ref:`voter service | | | | | | | `. | | +--------------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | OtherType | ``xs:string`` | Optional | Single | If Type is "other", OtherType allows for | | | | | | | cataloging another type of voter | | | | | | | service. | | +--------------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ .. _single-xml-election-notice: ElectionNotice ~~~~~~~~~~~~~~ +--------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Tag | Data Type | Required? | Repeats? | Description | Error Handling | +==============+==========================================+==============+==============+==========================================+==========================================+ | NoticeText | :ref:`single-xml-internationalized-text` | **Required** | Single | The last minute or emergency | | | | | | | notification text should be placed here. | | +--------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | NoticeUri | ``xs:anyURI`` | Optional | Single | Optional URL for additional information | | | | | | | related to the last minute or emergency | | | | | | | notification. | | +--------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ .. _single-xml-electoral-district: ElectoralDistrict ~~~~~~~~~~~~~~~~~ The ``ElectoralDistrict`` object represents the geographic area in which contests are held. Examples of ``ElectoralDistrict`` include: "the state of Maryland", "Virginia's 5th Congressional District", or "Union School District". The geographic area that comprises a ``ElectoralDistrict`` is defined by which precincts link to the ``ElectoralDistrict``. +---------------------+----------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Tag | Data Type | Required? | Repeats? | Description | Error Handling | +=====================+========================================+==============+==============+==========================================+==========================================+ | ExternalIdentifiers | :ref:`single-xml-external-identifiers` | Optional | Single | Other identifiers that link to external | | | | | | | datasets (e.g. `OCD-IDs`_) | | +---------------------+----------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Name | ``xs:string`` | **Required** | Single | Specifies the electoral area's name. | | +---------------------+----------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Number | ``xs:integer`` | Optional | Single | Specifies the district number of the | | | | | | | district (e.g. 34, in the case of the | | | | | | | 34th State Senate District). If a number | | | | | | | is not applicable, instead of leaving | | | | | | | the field blank, leave this field out of | | | | | | | the object; empty strings are not valid | | | | | | | for xs:integer fields. | | +---------------------+----------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Type | :ref:`single-xml-district-type` | **Required** | Single | Specifies the type of electoral area. | | +---------------------+----------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | OtherType | ``xs:string`` | Optional | Single | Allows for cataloging a new | | | | | | | :ref:`single-xml-district-type` option | | | | | | | when ``Type`` is specified as "other". | | +---------------------+----------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ .. _OCD-IDs: http://opencivicdata.readthedocs.org/en/latest/ocdids.html .. code-block:: xml :linenos: ocd-id ocd-division/country:us/state:va fips 51 Commonwealth of Virginia state .. _single-xml-external-file: ExternalFile ~~~~~~~~~~~~ The ``ExternalFile`` object holds a reference to a file external to the feed itself. External files are packaged along with the VIP feed into a single, archived file. +--------------+----------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Tag | Data Type | Required? | Repeats? | Description | Error Handling | +==============+============================+==============+==============+==========================================+==========================================+ | FileUri | ``xs:anyURI`` | **Required** | Single | The URI of the external file. | | +--------------+----------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Checksum | :ref:`single-xml-checksum` | **Required** | Single | The cryptographic checksum of the | | | | | | | referenced external file. | | +--------------+----------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ .. code-block:: xml :linenos: precinct_shapes.zip sha-256 65b634c5037f8a344616020d8060d233daa37b0f032a71d0d15ad7a5d3afa68e .. _single-xml-checksum: Checksum ^^^^^^^^ The ``Checksum`` object contains information about a cryptographic checksum, including the raw checksum value and the cryptographic hash algorithm used to compute it. +--------------+--------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Tag | Data Type | Required? | Repeats? | Description | Error Handling | +==============+======================================+==============+==============+==========================================+==========================================+ | Algorithm | :ref:`single-xml-checksum-algorithm` | **Required** | Single | The cryptographic hash algorithm used to | | | | | | | compute the checksum value. | | +--------------+--------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Value | ``xs:string`` | **Required** | Single | The raw cryptographic checksum value | | | | | | | encoded as a non-delimited, lowercase | | | | | | | hexadecimal string. | | +--------------+--------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ .. code-block:: xml :linenos: sha-256 65b634c5037f8a344616020d8060d233daa37b0f032a71d0d15ad7a5d3afa68e .. _single-xml-external-geospatial-feature: ExternalGeospatialFeature ~~~~~~~~~~~~~~~~~~~~~~~~~ The ``ExternalGeospatialFeature`` object contains a reference to a geospatial feature (one or more shapes) contained in a separate file external to the VIP feed. +-------------------+--------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Tag | Data Type | Required? | Repeats? | Description | Error Handling | +===================+======================================+==============+==============+==========================================+==========================================+ | ExternalFileId | ``xs:IDREF`` | **Required** | Single | Links to the | | | | | | | :ref:`single-xml-external-file` | | | | | | | containing the geospatial shape(s) that | | | | | | | define the feature's boundary. | | +-------------------+--------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | FileFormat | :ref:`single-xml-geospatial-format` | **Required** | Single | The format of the geospatial file. | | +-------------------+--------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | FeatureIdentifier | :ref:`single-xml-feature-identifier` | **Required** | Repeats | Identifiers indicating which specific | | | | | | | shape(s) to use from the geospatial | | | | | | | file. These refer to identifiers within | | | | | | | the referenced external file. This is a | | | | | | | repeated field in the XML specification, | | | | | | | but a scalar field in the CSV | | | | | | | specification. If more than one | | | | | | | identifier is required with the CSV | | | | | | | specifiation, multiple values can be | | | | | | | provided by delimited by space. | | +-------------------+--------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ .. _single-xml-feature-identifier: FeatureIdentifier ^^^^^^^^^^^^^^^^^ +--------------+--------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Tag | Data Type | Required? | Repeats? | Description | Error Handling | +==============+==============+==============+==============+==========================================+==========================================+ | Index | ``xs:int`` | Optional | Single | The index value for the shapefile | | | | | | | feature. | | +--------------+--------------+--------------+--------------+------------------------------------------+------------------------------------------+ .. _single-xml-external-identifier: ExternalIdentifier ~~~~~~~~~~~~~~~~~~ +--------------+-----------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Tag | Data Type | Required? | Repeats? | Description | Error Handling | +==============+===================================+==============+==============+==========================================+==========================================+ | Type | :ref:`single-xml-identifier-type` | **Required** | Single | Specifies the type of identifier. Must | | | | | | | be one of the valid types as defined by | | | | | | | :ref:`single-xml-identifier-type`. | | +--------------+-----------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | OtherType | ``xs:string`` | Optional | Single | Allows for cataloging an | | | | | | | ``ExternalIdentifier`` type that falls | | | | | | | outside the options listed in | | | | | | | :ref:`single-xml-identifier-type`. | | | | | | | ``Type`` should be set to "other" when | | | | | | | using this field. | | +--------------+-----------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Value | ``xs:string`` | **Required** | Single | Specifies the identifier. | | +--------------+-----------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ .. code-block:: xml :linenos: ocd-id ocd-division/country:us/state:nc/county:durham FIPS 37063 OTHER GNIS 1008550 OTHER census 99063 .. _single-xml-external-identifiers: ExternalIdentifiers ~~~~~~~~~~~~~~~~~~~ The ``ExternalIdentifiers`` element allows VIP data to connect with external datasets (e.g. candidates with campaign finance datasets, electoral geographies with `OCD-IDs`_ that allow for greater connectivity with additional datasets, etc...). Examples for ``ExternalIdentifiers`` can be found on the objects that support them: * :ref:`single-xml-candidate` * Any element that extends :ref:`single-xml-contest-base` * :ref:`single-xml-electoral-district` * :ref:`single-xml-locality` * :ref:`single-xml-office` * :ref:`single-xml-party` * :ref:`single-xml-precinct` * :ref:`single-xml-state` .. _OCD-IDs: http://opencivicdata.readthedocs.org/en/latest/ocdids.html +--------------------+---------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Tag | Data Type | Required? | Repeats? | Description | Error Handling | +====================+=======================================+==============+==============+==========================================+==========================================+ | ExternalIdentifier | :ref:`single-xml-external-identifier` | **Required** | Repeats | Defines the identifier and the type of | At least one valid `ExternalIdentifier`_ | | | | | | identifier it is (see | must be present for | | | | | | `ExternalIdentifier`_ for complete | ``ExternalIdentifiers`` to be valid. If | | | | | | information). | no valid `ExternalIdentifier`_ is | | | | | | | present, the implementation is required | | | | | | | to ignore the ``ExternalIdentifiers`` | | | | | | | element. | +--------------------+---------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ .. _single-xml-feature-identifier: FeatureIdentifier ~~~~~~~~~~~~~~~~~ +--------------+--------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Tag | Data Type | Required? | Repeats? | Description | Error Handling | +==============+==============+==============+==============+==========================================+==========================================+ | Index | ``xs:int`` | Optional | Single | The index value for the shapefile | | | | | | | feature. | | +--------------+--------------+--------------+--------------+------------------------------------------+------------------------------------------+ .. _single-xml-hours: Hours ~~~~~ The open and close time for this place. All times must be fully specified, including a timezone offset from UTC. +--------------+----------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Tag | Data Type | Required? | Repeats? | Description | Error Handling | +==============+==================================+==============+==============+==========================================+==========================================+ | StartTime | :ref:`single-xml-time-with-zone` | Optional | Single | The time at which this place opens. | | +--------------+----------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | EndTime | :ref:`single-xml-time-with-zone` | Optional | Single | The time at which this place closes. | | +--------------+----------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ .. _single-xml-time-with-zone: TimeWithZone ^^^^^^^^^^^^ A string pattern restricting the value to a time with an included offset from UTC. The pattern is ``(([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]|(24:00:00))(Z|[+-]((0[0-9]|1[0-3]):[0-5][0-9]|14:00))`` .. code-block:: xml :linenos: 06:00:00-05:00 12:00:00-05:00 13:00:00-05:00 19:00:00-05:00 2013-11-05 2013-11-05 .. _single-xml-hours-open: HoursOpen ~~~~~~~~~ A structured way of describing the days and hours that a place such as a :ref:`single-xml-office` or :ref:`single-xml-polling-location` is open, or that an event such as an :ref:`single-xml-election` is happening. The range of days indicated by the `StartDate` and `EndDate` in each `Schedule`_ element should not overlap with peer `Schedule`_ elements. For example, it is invalid to specify a schedule from 10/01/2016 to 10/31/2016 and also specify a schedule from 10/10/2016 to 10/11/2016 within the same `HoursOpen` element. +--------------+----------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Tag | Data Type | Required? | Repeats? | Description | Error Handling | +==============+============================+==============+==============+==========================================+==========================================+ | Schedule | :ref:`single-xml-schedule` | **Required** | Repeats | Defines a block of days and hours that a | At least one valid `Schedule`_ must be | | | | | | place will be open. | present for ``HoursOpen`` to be valid. | | | | | | | If no valid `Schedule`_ is present, the | | | | | | | implementation is required to ignore the | | | | | | | ``HoursOpen`` element. | +--------------+----------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ .. _single-xml-schedule: Schedule ^^^^^^^^ A sub-portion of the schedule. This describes a range of days, along with one or more set of open and close times for those days, as well as the options describing whether or not appointments are necessary or possible. +---------------------+-------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Tag | Data Type | Required? | Repeats? | Description | Error Handling | +=====================+=========================+==============+==============+==========================================+==========================================+ | Hours | :ref:`single-xml-hours` | Optional | Repeats | Blocks of hours in the date range in | | | | | | | which the place is open. | | +---------------------+-------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | IsOnlyByAppointment | ``xs:boolean`` | Optional | Single | If true, the place is only open during | | | | | | | the specified time window with an | | | | | | | appointment. | | +---------------------+-------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | IsOrByAppointment | ``xs:boolean`` | Optional | Single | If true, the place is open during the | | | | | | | hours specified time window and may also | | | | | | | be open with an appointment. | | +---------------------+-------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | IsSubjectToChange | ``xs:boolean`` | Optional | Single | If true, the place should be open during | | | | | | | the specified time window, but may be | | | | | | | subject to change. People should contact | | | | | | | prior to arrival to confirm hours are | | | | | | | still accurate. | | +---------------------+-------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | StartDate | ``xs:date`` | Optional | Single | The date at which this collection of | | | | | | | start and end times and options begin. | | +---------------------+-------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | EndDate | ``xs:date`` | Optional | Single | The date at which this collection of | | | | | | | start and end times and options end. | | +---------------------+-------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ .. _single-xml-hours: Hours %%%%% The open and close time for this place. All times must be fully specified, including a timezone offset from UTC. +--------------+----------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Tag | Data Type | Required? | Repeats? | Description | Error Handling | +==============+==================================+==============+==============+==========================================+==========================================+ | StartTime | :ref:`single-xml-time-with-zone` | Optional | Single | The time at which this place opens. | | +--------------+----------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | EndTime | :ref:`single-xml-time-with-zone` | Optional | Single | The time at which this place closes. | | +--------------+----------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ .. _single-xml-time-with-zone: TimeWithZone ^^^^^^^^^^^^ A string pattern restricting the value to a time with an included offset from UTC. The pattern is ``(([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]|(24:00:00))(Z|[+-]((0[0-9]|1[0-3]):[0-5][0-9]|14:00))`` .. code-block:: xml :linenos: 06:00:00-05:00 12:00:00-05:00 13:00:00-05:00 19:00:00-05:00 2013-11-05 2013-11-05 .. _single-xml-html-color-string: HtmlColorString ~~~~~~~~~~~~~~~ A restricted string pattern for a six-character hex code representing an HTML color string. The pattern is: ``[0-9a-f]{6}`` .. _single-xml-internationalized-text: InternationalizedText ~~~~~~~~~~~~~~~~~~~~~ ``InternationalizedText`` allows for support of multiple languages for a string. ``InternationalizedText`` has an optional attribute ``label``, which allows the feed to refer back to the original label for the information (e.g. if the contact information came from a CSV, ``label`` may refer to a row ID). Examples of ``InternationalizedText`` can be seen in: * Any element that extends :ref:`single-xml-contest-base` * Any element that extends :ref:`single-xml-ballot-selection-base` * :ref:`single-xml-candidate` * :ref:`single-xml-contact-information` * :ref:`single-xml-election` * :ref:`single-xml-election-administration` * :ref:`single-xml-office` * :ref:`single-xml-party` * :ref:`single-xml-person` * :ref:`single-xml-polling-location` * :ref:`single-xml-source` NOTE: Internationalized Text is not currently supported for CSV submissions. +--------------+-----------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Tag | Data Type | Required? | Repeats? | Description | Error Handling | +==============+===================================+==============+==============+==========================================+==========================================+ | Text | :ref:`single-xml-language-string` | **Required** | Repeats | Contains the translations of a | At least one valid ``Text`` must be | | | | | | particular string of text. | present for ``InternationalizedText`` to | | | | | | | be valid. If no valid ``Text`` is | | | | | | | present, the implementation is required | | | | | | | to ignore the ``InternationalizedText`` | | | | | | | element. | +--------------+-----------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ .. _single-xml-language-string: LanguageString ~~~~~~~~~~~~~~ ``LanguageString`` extends xs:string and can contain text from any language. ``LanguageString`` has one required attribute, ``language``, that must contain the 2-character `language code`_ for the type of language ``LanguageString`` contains. .. _`language code`: http://en.wikipedia.org/wiki/List_of_ISO_639-1_codes .. code-block:: xml :linenos: Retention of Supreme Court Justice La retención de juez de la Corte Suprema .. _single-xml-lat-lng: LatLng ~~~~~~ The latitude and longitude of a polling location in `WGS 84`_ format. Both latitude and longitude values are measured in decimal degrees. +--------------+---------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Tag | Data Type | Required? | Repeats? | Description | Error Handling | +==============+===============+==============+==============+==========================================+==========================================+ | Latitude | ``xs:double`` | **Required** | Single | The latitude of the polling location. | | +--------------+---------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Longitude | ``xs:double`` | **Required** | Single | The longitude of the polling location. | | +--------------+---------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Source | ``xs:string`` | Optional | Single | The system used to perform the lookup | | | | | | | from location name to lat/lng. For | | | | | | | example, this could be the name of a | | | | | | | geocoding service. | | +--------------+---------------+--------------+--------------+------------------------------------------+------------------------------------------+ .. _single-xml-locality: Locality ~~~~~~~~ The Locality object represents the jurisdiction below the :ref:`single-xml-state` (e.g. county). +--------------------------+----------------------------------------+--------------+--------------+-------------------------------------------+------------------------------------------+ | Tag | Data Type | Required? | Repeats? | Description | Error Handling | +==========================+========================================+==============+==============+===========================================+==========================================+ | ElectionAdministrationId | ``xs:IDREF`` | Optional | Single | Links to the locality's | | | | | | | :ref:`single-xml-election-administration` | | | | | | | object. | | +--------------------------+----------------------------------------+--------------+--------------+-------------------------------------------+------------------------------------------+ | ExternalIdentifiers | :ref:`single-xml-external-identifiers` | Optional | Single | Another identifier for a locality that | | | | | | | links to another dataset (e.g. `OCD-ID`_) | | +--------------------------+----------------------------------------+--------------+--------------+-------------------------------------------+------------------------------------------+ | IsMailOnly | ``xs:boolean`` | Optional | Single | Determines if the locality runs mail-only | If the field is missing or invalid, the | | | | | | elections. If this is true, then all | implementation is required to assume | | | | | | precincts a part of the locality will | `IsMailOnly` is false. | | | | | | also run mail-only elections. Drop boxes | | | | | | | may be used in addition to this flag | | | | | | | using a :ref:`polling location | | | | | | | ` record | | | | | | | configured as a Drop Box. | | +--------------------------+----------------------------------------+--------------+--------------+-------------------------------------------+------------------------------------------+ | Name | ``xs:string`` | **Required** | Single | Specifies the name of a locality. | | +--------------------------+----------------------------------------+--------------+--------------+-------------------------------------------+------------------------------------------+ | PollingLocationIds | ``xs:IDREFS`` | Optional | Single | Specifies a link to a set of the | | | | | | | locality's :ref:`polling locations | | | | | | | `s. If early | | | | | | | vote centers or ballot drop locations are | | | | | | | locality-wide, they should be specified | | | | | | | here. | | +--------------------------+----------------------------------------+--------------+--------------+-------------------------------------------+------------------------------------------+ | StateId | ``xs:IDREF`` | **Required** | Single | References the locality's | | | | | | | :ref:`single-xml-state`. | | +--------------------------+----------------------------------------+--------------+--------------+-------------------------------------------+------------------------------------------+ | Type | :ref:`single-xml-district-type` | Optional | Single | Defines the kind of locality (e.g. | | | | | | | county, town, et al.), which is one of | | | | | | | the various :ref:`DistrictType | | | | | | | enumerations `. | | +--------------------------+----------------------------------------+--------------+--------------+-------------------------------------------+------------------------------------------+ | OtherType | ``xs:string`` | Optional | Single | Allows for defining a type of locality | | | | | | | that falls outside the options listed in | | | | | | | :ref:`DistrictType | | | | | | | `. | | +--------------------------+----------------------------------------+--------------+--------------+-------------------------------------------+------------------------------------------+ .. _OCD-ID: http://opencivicdata.readthedocs.org/en/latest/ocdids.html .. code-block:: xml :linenos: ea40001 ocd-id ocd-division/country:us/state:va/county:albemarle true ALBEMARLE COUNTY st51 county .. _single-xml-office: Office ~~~~~~ ``Office`` represents the office associated with a contest or district (e.g. Alderman, Mayor, School Board, et al). +-----------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Tag | Data Type | Required? | Repeats? | Description | Error Handling | +=======================+==========================================+==============+==============+==========================================+==========================================+ | ContactInformation | :ref:`single-xml-contact-information` | Optional | Repeats | Links to the | | | | | | | :ref:`single-xml-contact-information` | | | | | | | element associated with the office. | | +-----------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Description | :ref:`single-xml-internationalized-text` | Optional | Single | A brief description of the office and | | | | | | | its purpose. | | +-----------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | ElectoralDistrictId | ``xs:IDREF`` | **Required** | Single | Links to the | | | | | | | :ref:`single-xml-electoral-district` | | | | | | | element associated with the office. | | +-----------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | ExternalIdentifiers | :ref:`single-xml-external-identifiers` | Optional | Single | Other identifiers that link this office | | | | | | | to other related datasets (e.g. campaign | | | | | | | finance systems, OCD IDs, et al.). | | +-----------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | FilingDeadline | ``xs:date`` | Optional | Single | Specifies the date and time when a | | | | | | | candidate must have filed for the | | | | | | | contest for the office. | | +-----------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | IsPartisan | ``xs:boolean`` | Optional | Single | Indicates whether the office is | | | | | | | partisan. | | +-----------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Name | :ref:`single-xml-internationalized-text` | **Required** | Single | The name of the office. | | +-----------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | OfficeHolderPersonIds | ``xs:IDREFS`` | Optional | Single | Links to the :ref:`single-xml-person` | | | | | | | element(s) that hold additional | | | | | | | information about the current office | | | | | | | holder(s). | | +-----------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Term | :ref:`single-xml-term` | Optional | Single | Defines the term the office can be held. | | +-----------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ .. _single-xml-term: Term ^^^^ +--------------+------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Tag | Data Type | Required? | Repeats? | Description | Error Handling | +==============+====================================+==============+==============+==========================================+==========================================+ | Type | :ref:`single-xml-office-term-type` | **Required** | Single | Specifies the type of office term (see | | | | | | | :ref:`single-xml-office-term-type` for | | | | | | | valid values). | | +--------------+------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | StartDate | ``xs:date`` | Optional | Single | Specifies the start date for the current | | | | | | | term of the office. | | +--------------+------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | EndDate | ``xs:date`` | Optional | Single | Specifies the end date for the current | | | | | | | term of the office. | | +--------------+------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ .. code-block:: xml :linenos: ed60129 2013-01-01 false Governor full-term .. _single-xml-contact-information: ContactInformation ^^^^^^^^^^^^^^^^^^ For defining contact information about objects such as persons, boards of authorities, organizations, etc. ContactInformation is always a sub-element of another object (e.g. :ref:`single-xml-election-administration`, :ref:`single-xml-office`, :ref:`single-xml-person`, :ref:`single-xml-source`). ContactInformation has an optional attribute ``label``, which allows the feed to refer back to the original label for the information (e.g. if the contact information came from a CSV, ``label`` may refer to a row ID). +------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Tag | Data Type | Required? | Repeats? | Description | Error Handling | +==================+==========================================+==============+==============+==========================================+==========================================+ | AddressLine | ``xs:string`` | Optional | Repeats | The "location" portion of a mailing | | | | | | | address. :ref:`See usage note. | | | | | | | ` | | +------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Directions | :ref:`single-xml-internationalized-text` | Optional | Single | Specifies further instructions for | | | | | | | locating this entity. | | +------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Email | ``xs:string`` | Optional | Repeats | An email address for the contact. | | +------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Fax | ``xs:string`` | Optional | Repeats | A fax line for the contact. | | +------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Hours | :ref:`single-xml-internationalized-text` | Optional | Single | Contains the hours (in local time) that | | | **[deprecated]** | | | | the location is open *(NB: this element | | | | | | | is deprecated in favor of the more | | | | | | | structured :ref:`single-xml-hours-open` | | | | | | | element. It is strongly encouraged that | | | | | | | data providers move toward contributing | | | | | | | hours in this format)*. | | +------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | HoursOpenId | ``xs:IDREF`` | Optional | Single | References an | | | | | | | :ref:`single-xml-hours-open` element, | | | | | | | which lists the hours of operation for a | | | | | | | location. | | +------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | LatLng | :ref:`single-xml-lat-lng` | Optional | Single | Specifies the latitude and longitude of | | | | | | | this entity. | | +------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Name | ``xs:string`` | Optional | Single | The name of the location or contact. | | | | | | | :ref:`See usage note. | | | | | | | ` | | +------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Phone | ``xs:string`` | Optional | Repeats | A phone number for the contact. | | +------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Uri | ``xs:anyURI`` | Optional | Repeats | An informational URI for the contact or | | | | | | | location. | | +------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ .. _single-xml-name-address-line-usage: ``Name`` and ``AddressLine`` Usage Note ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ The ``Name`` and ``AddressLine`` fields should be chosen so that a display or mailing address can be constructed programmatically by joining the ``Name`` and ``AddressLine`` fields together. For example, for the following address:: Department of Elections 1 Dr. Carlton B. Goodlett Place, Room 48 San Francisco, CA 94102 The name could be "Department of Elections" and the first address line could be "1 Dr. Carlton B. Goodlett Place, Room 48." However, VIP does not yet support the representation of mailing addresses whose "name" portion spans more than one line, for example:: California Secretary of State Elections Division 1500 11th Street Sacramento, CA 95814 For addresses like the above, we recommend choosing a name like, "California Secretary of State, Elections Division" with "1500 11th Street" as the first address line. This would result in a programmatically constructed address like the following:: California Secretary of State, Elections Division 1500 11th Street Sacramento, CA 95814 .. code-block:: xml :linenos: 1600 Pennsylvania Ave Washington, DC 20006 president@whitehouse.gov 202-456-1111 202-456-6213 http://www.whitehouse.gov .. _single-xml-ordered-contest: OrderedContest ~~~~~~~~~~~~~~ ``OrderedContest`` encapsulates links to the information that comprises a contest and potential ballot selections. ``OrderedContest`` elements can be collected within a :ref:`single-xml-ballot-style` to accurate depict exactly what will show up on a particular ballot in the proper order. +---------------------------+---------------+--------------+--------------+------------------------------------------+--------------------------------------------------+ | Tag | Data Type | Required? | Repeats? | Description | Error Handling | +===========================+===============+==============+==============+==========================================+==================================================+ | ContestId | ``xs:IDREF`` | **Required** | Single | Links to elements that extend | | | | | | | :ref:`single-xml-contest-base`. | | +---------------------------+---------------+--------------+--------------+------------------------------------------+--------------------------------------------------+ | OrderedBallotSelectionIds | ``xs:IDREFS`` | Optional | Single | Links to elements that extend | If the field is invalid or not present, the | | | | | | :ref:`single-xml-ballot-selection-base`. | implementation is required to ignore it. If an | | | | | | | ``OrderedBallotSelectionIds`` element is not | | | | | | | present, the presumed order of the selection | | | | | | | will be the order of | | | | | | | :ref:`single-xml-ballot-selection-base`-extended | | | | | | | elements referenced by the underlying | | | | | | | :ref:`single-xml-contest-base`-extended | | | | | | | elements. | +---------------------------+---------------+--------------+--------------+------------------------------------------+--------------------------------------------------+ .. code-block:: xml :linenos: cc20003 cs10961 cs10962 cs10963 .. _single-xml-party: Party ~~~~~ This element describes a political party and the metadata associated with them. These can also include "dummy" parties to indicate a type of contest (e.g., a Voter Nominated :ref:`single-xml-candidate-contest` can use the **PrimaryPartyIds** field and a dummy Party object to indicate that the contest is a "Top-Two" primary). +---------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Tag | Data Type | Required? | Repeats? | Description | Error Handling | +=====================+==========================================+==============+==============+==========================================+==========================================+ | Abbreviation | ``xs:string`` | Optional | Single | An abbreviation for the party name. | | +---------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Color | :ref:`single-xml-html-color-string` | Optional | Single | The preferred display color for the | | | | | | | party, for use in maps and other | | | | | | | displays. | | +---------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | ExternalIdentifiers | :ref:`single-xml-external-identifiers` | Optional | Single | Other identifiers that link this party | | | | | | | to other related data sets (e.g. a | | | | | | | campaign finance system, etc). | | +---------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | IsWriteIn | ``xs:boolean`` | Optional | Single | Signals if this political party is one | | | | | | | that is officially recognized by a | | | | | | | local, state, or federal organization, | | | | | | | or is a "write-in" in jurisdictions | | | | | | | which allow candidates to free-form | | | | | | | enter their political affiliation. If | | | | | | | this field is not present then it is | | | | | | | assumed to be false. | | +---------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | LeaderPersonIds | ``xs:IDREFS`` | Optional | Single | A reference of :ref:`single-xml-person` | | | | | | | elements which are leaders of the | | | | | | | `Party`. | | +---------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | LogoUri | ``xs:anyURI`` | Optional | Single | Web address of a logo to use in | | | | | | | displays. | | +---------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Name | :ref:`single-xml-internationalized-text` | **Required** | Single | The name of the party. | | +---------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ .. code-block:: xml :linenos: REP e91d0e false per01 Republican .. _single-xml-html-color-string: HtmlColorString ^^^^^^^^^^^^^^^ A restricted string pattern for a six-character hex code representing an HTML color string. The pattern is: ``[0-9a-f]{6}`` .. _single-xml-party-contest: PartyContest ~~~~~~~~~~~~ An extension of :ref:`single-xml-contest-base` which describes a contest in which the possible ballot selections are of type :ref:`single-xml-party-selection`. These could include contests in which straight-party selections are allowed, or party-list contests (although these are more common outside of the United States). .. _single-xml-contest-base: ContestBase ^^^^^^^^^^^ A base model for all Contest types: :ref:`single-xml-ballot-measure-contest`, :ref:`single-xml-candidate-contest`, :ref:`single-xml-party-contest`, and :ref:`single-xml-retention-contest` (NB: the latter because it extends :ref:`single-xml-ballot-measure-contest`). +-------------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Tag | Data Type | Required? | Repeats? | Description | Error Handling | +=========================+==========================================+==============+==============+==========================================+==========================================+ | Abbreviation | ``xs:string`` | Optional | Single | An abbreviation for the contest. | | +-------------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | BallotSelectionIds | ``xs:IDREFS`` | Optional | Single | References a set of BallotSelections, | | | | | | | which could be of any selection type | | | | | | | that extends | | | | | | | :ref:`single-xml-ballot-selection-base`. | | +-------------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | BallotSubTitle | :ref:`single-xml-internationalized-text` | Optional | Single | Subtitle of the contest as it appears on | | | | | | | the ballot. | | +-------------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | BallotTitle | :ref:`single-xml-internationalized-text` | Optional | Single | Title of the contest as it appears on | | | | | | | the ballot. | | +-------------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | ElectoralDistrictId | ``xs:IDREF`` | **Required** | Single | References an | | | | | | | :ref:`single-xml-electoral-district` | | | | | | | element that represents the geographical | | | | | | | scope of the contest. | | +-------------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | ElectorateSpecification | :ref:`single-xml-internationalized-text` | Optional | Single | Specifies any changes to the eligible | | | | | | | electorate for this contest past the | | | | | | | usual, "all registered voters" | | | | | | | electorate. This subtag will most often | | | | | | | be used for primaries and local | | | | | | | elections. In primaries, voters may have | | | | | | | to be registered as a specific party to | | | | | | | vote, or there may be special rules for | | | | | | | which ballot a voter can pull. In some | | | | | | | local elections, non-citizens can vote. | | +-------------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | ExternalIdentifiers | :ref:`single-xml-external-identifiers` | Optional | Single | Other identifiers for a contest that | | | | | | | links to another source of information. | | +-------------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | HasRotation | ``xs:boolean`` | Optional | Single | Indicates whether the selections in the | | | | | | | contest are rotated. | | +-------------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Name | ``xs:string`` | **Required** | Single | Name of the contest, not necessarily how | | | | | | | it appears on the ballot (NB: | | | | | | | BallotTitle should be used for this | | | | | | | purpose). | | +-------------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | SequenceOrder | ``xs:integer`` | Optional | Single | Order in which the contests are listed | | | | | | | on the ballot. This is the default | | | | | | | ordering, and can be overrides by data | | | | | | | in a :ref:`single-xml-ballot-style` | | | | | | | element. | | +-------------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | VoteVariation | :ref:`single-xml-vote-variation` | Optional | Single | Vote variation associated with the | | | | | | | contest (e.g. n-of-m, majority, et al). | | +-------------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | OtherVoteVariation | ``xs:string`` | Optional | Single | If "other" is selected as the | | | | | | | **VoteVariation**, the name of the | | | | | | | variation can be specified here. | | +-------------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ .. _single-xml-party-selection: PartySelection ~~~~~~~~~~~~~~ This element extends :ref:`single-xml-ballot-selection-base` to support contests in which the selections can be groups of one or more parties. +--------------+---------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Tag | Data Type | Required? | Repeats? | Description | Error Handling | +==============+===============+==============+==============+==========================================+==========================================+ | PartyIds | ``xs:IDREFS`` | **Required** | Single | One or more :ref:`single-xml-party` IDs | If one or more parties referenced are | | | | | | which collectively represent a ballot | invalid or not present, the | | | | | | selection. | implementation is required to ignore the | | | | | | | PartySelection containing it. | +--------------+---------------+--------------+--------------+------------------------------------------+------------------------------------------+ .. _single-xml-ballot-selection-base: BallotSelectionBase ^^^^^^^^^^^^^^^^^^^ A base model for all ballot selection types: :ref:`single-xml-ballot-measure-selection`, :ref:`single-xml-candidate-selection`, and :ref:`single-xml-party-selection`. +---------------+----------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Tag | Data Type | Required? | Repeats? | Description | Error Handling | +===============+================+==============+==============+==========================================+==========================================+ | SequenceOrder | ``xs:integer`` | Optional | Single | The order in which a selection can be | | | | | | | listed on the ballot or in results. This | | | | | | | is the default ordering, and can be | | | | | | | overridden by `OrderedBallotSlectionIds` | | | | | | | in :ref:`single-xml-ordered-contest`. | | +---------------+----------------+--------------+--------------+------------------------------------------+------------------------------------------+ .. _single-xml-person: Person ~~~~~~ ``Person`` defines information about a person. The person may be a candidate, election administrator, or elected official. These elements reference ``Person``: * :ref:`single-xml-candidate` * :ref:`single-xml-election-administration` * :ref:`single-xml-office` +---------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Tag | Data Type | Required? | Repeats? | Description | Error Handling | +=====================+==========================================+==============+==============+==========================================+==========================================+ | ContactInformation | :ref:`single-xml-contact-information` | Optional | Repeats | Refers to the associated | | | | | | | :ref:`single-xml-contact-information`. | | +---------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | DateOfBirth | ``xs:date`` | Optional | Single | Represents the individual's date of | | | | | | | birth. | | +---------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | ExternalIdentifiers | :ref:`single-xml-external-identifiers` | Optional | Single | Identifiers for this person. | | +---------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | FirstName | ``xs:string`` | Optional | Single | Represents an individual's first name. | | +---------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | FullName | :ref:`single-xml-internationalized-text` | Optional | Single | Specifies a person's full name (**NB:** | | | | | | | this information is | | | | | | | :ref:`single-xml-internationalized-text` | | | | | | | because it sometimes appears on ballots | | | | | | | in multiple languages). | | +---------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Gender | ``xs:string`` | Optional | Single | Specifies a person's gender. | | +---------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | LastName | ``xs:string`` | Optional | Single | Represents an individual's last name. | | +---------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | MiddleName | ``xs:string`` | Optional | Repeats | Represents any number of names between | | | | | | | an individual's first and last names | | | | | | | (e.g. John **Ronald Reuel** Tolkien). | | +---------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Nickname | ``xs:string`` | Optional | Single | Represents an individual's nickname. | | +---------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | PartyId | ``xs:IDREF`` | Optional | Single | Refers to the associated | | | | | | | :ref:`single-xml-party`. This | | | | | | | information is intended to be used by | | | | | | | feed consumers to help them disambiguate | | | | | | | the person's identity, but not to be | | | | | | | presented as part of any ballot | | | | | | | information. For that see | | | | | | | :ref:`single-xml-candidate` **PartyId**. | | +---------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Prefix | ``xs:string`` | Optional | Single | Specifies a prefix associated with a | | | | | | | person (e.g. Dr.). | | +---------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Profession | :ref:`single-xml-internationalized-text` | Optional | Single | Specifies a person's profession (**NB:** | | | | | | | this information is | | | | | | | :ref:`single-xml-internationalized-text` | | | | | | | because it sometimes appears on ballots | | | | | | | in multiple languages). | | +---------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Suffix | ``xs:string`` | Optional | Single | Specifies a suffix associated with a | | | | | | | person (e.g. Jr.). | | +---------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Title | :ref:`single-xml-internationalized-text` | Optional | Single | A title associated with a person | | | | | | | (**NB:** this information is | | | | | | | :ref:`single-xml-internationalized-text` | | | | | | | because it sometimes appears on ballots | | | | | | | in multiple languages). | | +---------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ .. code-block:: xml :linenos: rwashburne@albemarle.org 4349724173 RICHARD WASHBURNE J. JAKE <Text language="en">General Registrar Physical</Text> .. _single-xml-contact-information: ContactInformation ^^^^^^^^^^^^^^^^^^ For defining contact information about objects such as persons, boards of authorities, organizations, etc. ContactInformation is always a sub-element of another object (e.g. :ref:`single-xml-election-administration`, :ref:`single-xml-office`, :ref:`single-xml-person`, :ref:`single-xml-source`). ContactInformation has an optional attribute ``label``, which allows the feed to refer back to the original label for the information (e.g. if the contact information came from a CSV, ``label`` may refer to a row ID). +------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Tag | Data Type | Required? | Repeats? | Description | Error Handling | +==================+==========================================+==============+==============+==========================================+==========================================+ | AddressLine | ``xs:string`` | Optional | Repeats | The "location" portion of a mailing | | | | | | | address. :ref:`See usage note. | | | | | | | ` | | +------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Directions | :ref:`single-xml-internationalized-text` | Optional | Single | Specifies further instructions for | | | | | | | locating this entity. | | +------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Email | ``xs:string`` | Optional | Repeats | An email address for the contact. | | +------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Fax | ``xs:string`` | Optional | Repeats | A fax line for the contact. | | +------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Hours | :ref:`single-xml-internationalized-text` | Optional | Single | Contains the hours (in local time) that | | | **[deprecated]** | | | | the location is open *(NB: this element | | | | | | | is deprecated in favor of the more | | | | | | | structured :ref:`single-xml-hours-open` | | | | | | | element. It is strongly encouraged that | | | | | | | data providers move toward contributing | | | | | | | hours in this format)*. | | +------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | HoursOpenId | ``xs:IDREF`` | Optional | Single | References an | | | | | | | :ref:`single-xml-hours-open` element, | | | | | | | which lists the hours of operation for a | | | | | | | location. | | +------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | LatLng | :ref:`single-xml-lat-lng` | Optional | Single | Specifies the latitude and longitude of | | | | | | | this entity. | | +------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Name | ``xs:string`` | Optional | Single | The name of the location or contact. | | | | | | | :ref:`See usage note. | | | | | | | ` | | +------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Phone | ``xs:string`` | Optional | Repeats | A phone number for the contact. | | +------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Uri | ``xs:anyURI`` | Optional | Repeats | An informational URI for the contact or | | | | | | | location. | | +------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ .. _single-xml-name-address-line-usage: ``Name`` and ``AddressLine`` Usage Note ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ The ``Name`` and ``AddressLine`` fields should be chosen so that a display or mailing address can be constructed programmatically by joining the ``Name`` and ``AddressLine`` fields together. For example, for the following address:: Department of Elections 1 Dr. Carlton B. Goodlett Place, Room 48 San Francisco, CA 94102 The name could be "Department of Elections" and the first address line could be "1 Dr. Carlton B. Goodlett Place, Room 48." However, VIP does not yet support the representation of mailing addresses whose "name" portion spans more than one line, for example:: California Secretary of State Elections Division 1500 11th Street Sacramento, CA 95814 For addresses like the above, we recommend choosing a name like, "California Secretary of State, Elections Division" with "1500 11th Street" as the first address line. This would result in a programmatically constructed address like the following:: California Secretary of State, Elections Division 1500 11th Street Sacramento, CA 95814 .. code-block:: xml :linenos: 1600 Pennsylvania Ave Washington, DC 20006 president@whitehouse.gov 202-456-1111 202-456-6213 http://www.whitehouse.gov .. _single-xml-polling-location: PollingLocation ~~~~~~~~~~~~~~~ The PollingLocation object represents a site where voters cast or drop off ballots. +-------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Tag | Data Type | Required? | Repeats? | Description | Error Handling | +===================+==========================================+==============+==============+==========================================+==========================================+ | AddressStructured | :ref:`single-xml-simple-address-type` | Optional | Single | Represents the various structured parts | One of **AddressStructured** and | | | | | | of an address to a polling location. | **AddressLine** should be present for a | | | | | | | given Polling Location. If none is | | | | | | | present, the implementation is required | | | | | | | to ignore the ``PollingLocation`` | | | | | | | element containing it. | +-------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | AddressLine | ``xs:string`` | Optional | Repeats | Represents the various parts of an | One of AddressStructured and AddressLine | | | | | | address to a polling location. | should be present for a given Polling | | | | | | | Location. If none is present, the | | | | | | | implementation is required to ignore the | | | | | | | ``PollingLocation`` element containing | | | | | | | it. | +-------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Directions | :ref:`single-xml-internationalized-text` | Optional | Single | Specifies further instructions for | | | | | | | locating the polling location. | | +-------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Hours | :ref:`single-xml-internationalized-text` | Optional | Single | Contains the hours (in local time) that | | | **[deprecated]** | | | | the polling location is open (**NB:** | | | | | | | this element is deprecated in favor of | | | | | | | the more structured | | | | | | | :ref:`single-xml-hours-open` element. It | | | | | | | is strongly encouraged that data | | | | | | | providers move toward contributing hours | | | | | | | in this format). | | +-------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | HoursOpenId | ``xs:IDREF`` | Optional | Single | Links to an :ref:`single-xml-hours-open` | | | | | | | element, which is a schedule of dates | | | | | | | and hours during which the polling | | | | | | | location is available. | | +-------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | IsDropBox | ``xs:boolean`` | Optional | Single | Indicates if this polling location is a | | | | | | | drop box. | | +-------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | IsEarlyVoting | ``xs:boolean`` | Optional | Single | Indicates if this polling location is an | | | | | | | early vote site. | | +-------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | LatLng | :ref:`single-xml-lat-lng` | Optional | Single | Specifies the latitude and longitude of | | | | | | | this polling location. | | +-------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Name | ``xs:string`` | Optional | Single | Name of the polling location. | | +-------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | PhotoUri | ``xs:anyURI`` | Optional | Single | Contains a link to an image of the | | | | | | | polling location. | | +-------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ .. code-block:: xml :linenos: 2775 Hydraulic Rd Charlottesville, VA 22901 hours0002 true true 38.009939 -78.506204 ALBERMARLE HIGH SCHOOL 2775 Hydraulic Rd CHARLOTTESVILLE VA 22901 hours0002 true true 38.009939 -78.506204 ALBERMARLE HIGH SCHOOL .. _single-xml-lat-lng: LatLng ^^^^^^ The latitude and longitude of a polling location in `WGS 84`_ format. Both latitude and longitude values are measured in decimal degrees. +--------------+---------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Tag | Data Type | Required? | Repeats? | Description | Error Handling | +==============+===============+==============+==============+==========================================+==========================================+ | Latitude | ``xs:double`` | **Required** | Single | The latitude of the polling location. | | +--------------+---------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Longitude | ``xs:double`` | **Required** | Single | The longitude of the polling location. | | +--------------+---------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Source | ``xs:string`` | Optional | Single | The system used to perform the lookup | | | | | | | from location name to lat/lng. For | | | | | | | example, this could be the name of a | | | | | | | geocoding service. | | +--------------+---------------+--------------+--------------+------------------------------------------+------------------------------------------+ .. _single-xml-simple-address-type: SimpleAddressType ^^^^^^^^^^^^^^^^^ A ``SimpleAddressType`` represents a structured address. +--------------+---------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Tag | Data Type | Required? | Repeats? | Description | Error Handling | +==============+===============+==============+==============+==========================================+==========================================+ | Line1 | ``xs:string`` | **Required** | Single | The address line for a structured | | | | | | | address. Should include the street | | | | | | | number, street name, and any prefix and | | | | | | | suffix. | | +--------------+---------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Line2 | ``xs:string`` | Optional | Single | Additional field for an address | | +--------------+---------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Line3 | ``xs:string`` | Optional | Single | Additional field for an address | | +--------------+---------------+--------------+--------------+------------------------------------------+------------------------------------------+ | City | ``xs:string`` | **Required** | Single | The City value of a structured address. | | +--------------+---------------+--------------+--------------+------------------------------------------+------------------------------------------+ | State | ``xs:string`` | **Required** | Single | The State value of a structured address. | | +--------------+---------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Zip | ``xs:string`` | Optional | Single | The ZIP code of a structured address. | | +--------------+---------------+--------------+--------------+------------------------------------------+------------------------------------------+ .. _single-xml-precinct: Precinct ~~~~~~~~ The Precinct object represents a precinct, which is contained within a Locality. While the id attribute does not have to be static across feeds for one election, the combination of :ref:`Source.VipId `, :ref:`Locality.Name `, :ref:`Precinct.Ward `, :ref:`Precinct.Name `, and :ref:`Precinct.Number ` should remain constant across feeds for one election (NB: not all of the fields just mentioned are required -- omitting those non-required fields is fine). Voters can be assigned to a precinct in two ways. A voter location modeled by :doc:`StreetSegment ` is assigned to a precinct by :doc:`StreetSegment.PrecinctId `. Alternatively, a precinct's spatial boundary can be modeled with :doc:`Precinct.SpatialBoundary `. Any registered voter address contained within the spatial boundary of the precinct is assigned to that precinct. +----------------------+----------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Tag | Data Type | Required? | Repeats? | Description | Error Handling | +======================+========================================+==============+==============+==========================================+==========================================+ | BallotStyleId | ``xs:IDREF`` | Optional | Single | Links to the | | | | | | | :ref:`single-xml-ballot-style`, which a | | | | | | | person who lives in this precinct will | | | | | | | vote. | | +----------------------+----------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | ElectoralDistrictIds | ``xs:IDREFS`` | Optional | Single | Links to the | | | | | | | :ref:`single-xml-electoral-district`s | | | | | | | (e.g., congressional district, state | | | | | | | house district, school board district) | | | | | | | to which the entire precinct/precinct | | | | | | | split belongs. **Highly Recommended** if | | | | | | | candidate information is to be provided. | | +----------------------+----------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | ExternalIdentifiers | :ref:`single-xml-external-identifiers` | Optional | Single | Other identifier for the precinct that | | | | | | | relates to another dataset (e.g. | | | | | | | `OCD-ID`_). | | +----------------------+----------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | IsMailOnly | ``xs:boolean`` | Optional | Single | Determines if the precinct runs | If the field is missing or invalid, the | | | | | | mail-only elections. | implementation is required to assume | | | | | | | `IsMailOnly` is false. | +----------------------+----------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | LocalityId | ``xs:IDREF`` | **Required** | Single | Links to the :ref:`single-xml-locality` | | | | | | | that comprises the precinct. | | +----------------------+----------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Name | ``xs:string`` | **Required** | Single | Specifies the precinct's name (or number | | | | | | | if no name exists). | | +----------------------+----------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Number | ``xs:string`` | Optional | Single | Specifies the precinct's number (e.g., | | | | | | | 32 or 32A -- alpha characters are | | | | | | | legal). Should be used if the `Name` | | | | | | | field is populated by a name and not a | | | | | | | number. | | +----------------------+----------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | PollingLocationIds | ``xs:IDREFS`` | Optional | Single | Specifies a link to the precinct's | | | | | | | :ref:`single-xml-polling-location` | | | | | | | object(s). | | +----------------------+----------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | PrecinctSplitName | ``xs:string`` | Optional | Single | If this field is empty, then this | | | | | | | `Precinct` object represents a full | | | | | | | precinct. If this field is present, then | | | | | | | this `Precinct` object represents one | | | | | | | portion of a split precinct. Each | | | | | | | `Precinct` object that represents one | | | | | | | portion of a split precinct **must** | | | | | | | have the same `Name` value, but | | | | | | | different `PrecinctSplitName` values. | | | | | | | See the `sample_feed.xml` file for | | | | | | | examples. | | +----------------------+----------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | SpatialBoundary | :ref:`single-xml-spatial-boundary` | Optional | Single | Defines the spatial boundary of the | | | | | | | precinct. All voter addresses contained | | | | | | | within this boundary are assigned to the | | | | | | | precinct. If a voter address also maps | | | | | | | to a :doc:`StreetSegment | | | | | | | `, then the precinct | | | | | | | assignment from the StreetSegment will | | | | | | | be preferred over the assignment from | | | | | | | the spatial boundary. | | +----------------------+----------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Ward | ``xs:string`` | Optional | Single | Specifies the ward the precinct is | | | | | | | contained within. | | +----------------------+----------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ .. _OCD-ID: http://opencivicdata.readthedocs.org/en/latest/ocdids.html .. code-block:: xml :linenos: bs00010 ed60129 ed60311 ed60054 false loc70001 203 - GEORGETOWN 0203 pl81274 ef1 shp 3 bs00002 ed60129 ed60054 ed60150 false loc70001 201 - JACK JOUETT 0201 pl00000 pl81273 pl81662 0000 bs00015 ed60129 ed60054 ed60267 false loc70001 201 - JACK JOUETT 0201 pl00000 pl81273 pl81662 0001 .. _single-xml-spatial-boundary: SpatialBoundary ^^^^^^^^^^^^^^^ The ``SpatialBoundary`` object defines a boundary in space. This boundary is usually defined by one or more discrete, closed polygonal shapes. +---------------------------+-----------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Tag | Data Type | Required? | Repeats? | Description | Error Handling | +===========================+===============================================+==============+==============+==========================================+==========================================+ | ExternalGeospatialFeature | :ref:`single-xml-external-geospatial-feature` | **Required** | Single | The spatial boundary defined by a | | | | | | | geospatial feature that is external to | | | | | | | the VIP feed. | | +---------------------------+-----------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ .. code-block:: xml :linenos: ef1 shp 3 .. _single-xml-external-geospatial-feature: ExternalGeospatialFeature %%%%%%%%%%%%%%%%%%%%%%%%% The ``ExternalGeospatialFeature`` object contains a reference to a geospatial feature (one or more shapes) contained in a separate file external to the VIP feed. +-------------------+--------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Tag | Data Type | Required? | Repeats? | Description | Error Handling | +===================+======================================+==============+==============+==========================================+==========================================+ | ExternalFileId | ``xs:IDREF`` | **Required** | Single | Links to the | | | | | | | :ref:`single-xml-external-file` | | | | | | | containing the geospatial shape(s) that | | | | | | | define the feature's boundary. | | +-------------------+--------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | FileFormat | :ref:`single-xml-geospatial-format` | **Required** | Single | The format of the geospatial file. | | +-------------------+--------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | FeatureIdentifier | :ref:`single-xml-feature-identifier` | **Required** | Repeats | Identifiers indicating which specific | | | | | | | shape(s) to use from the geospatial | | | | | | | file. These refer to identifiers within | | | | | | | the referenced external file. This is a | | | | | | | repeated field in the XML specification, | | | | | | | but a scalar field in the CSV | | | | | | | specification. If more than one | | | | | | | identifier is required with the CSV | | | | | | | specifiation, multiple values can be | | | | | | | provided by delimited by space. | | +-------------------+--------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ .. _single-xml-feature-identifier: FeatureIdentifier ^^^^^^^^^^^^^^^^^ +--------------+--------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Tag | Data Type | Required? | Repeats? | Description | Error Handling | +==============+==============+==============+==============+==========================================+==========================================+ | Index | ``xs:int`` | Optional | Single | The index value for the shapefile | | | | | | | feature. | | +--------------+--------------+--------------+--------------+------------------------------------------+------------------------------------------+ .. _single-xml-retention-contest: RetentionContest ~~~~~~~~~~~~~~~~ ``RetentionContest`` extends :ref:`single-xml-ballot-measure-contest` and represents a contest where a candidate is retained in a position (e.g. a judge). +--------------+--------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Tag | Data Type | Required? | Repeats? | Description | Error Handling | +==============+==============+==============+==============+==========================================+==========================================+ | CandidateId | ``xs:IDREF`` | **Required** | Single | Links to the :ref:`single-xml-candidate` | | | | | | | being retained. | | +--------------+--------------+--------------+--------------+------------------------------------------+------------------------------------------+ | OfficeId | ``xs:IDREF`` | Optional | Single | Links to the information about the | | | | | | | office. | | +--------------+--------------+--------------+--------------+------------------------------------------+------------------------------------------+ .. code-block:: xml :linenos: rc40001a rc40001b Retention of Supreme Court Justice La retención de juez de la Corte Suprema ed60129 Judicial Retention, Supreme Court can14444 off20006 .. _single-xml-schedule: Schedule ~~~~~~~~ A sub-portion of the schedule. This describes a range of days, along with one or more set of open and close times for those days, as well as the options describing whether or not appointments are necessary or possible. +---------------------+-------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Tag | Data Type | Required? | Repeats? | Description | Error Handling | +=====================+=========================+==============+==============+==========================================+==========================================+ | Hours | :ref:`single-xml-hours` | Optional | Repeats | Blocks of hours in the date range in | | | | | | | which the place is open. | | +---------------------+-------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | IsOnlyByAppointment | ``xs:boolean`` | Optional | Single | If true, the place is only open during | | | | | | | the specified time window with an | | | | | | | appointment. | | +---------------------+-------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | IsOrByAppointment | ``xs:boolean`` | Optional | Single | If true, the place is open during the | | | | | | | hours specified time window and may also | | | | | | | be open with an appointment. | | +---------------------+-------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | IsSubjectToChange | ``xs:boolean`` | Optional | Single | If true, the place should be open during | | | | | | | the specified time window, but may be | | | | | | | subject to change. People should contact | | | | | | | prior to arrival to confirm hours are | | | | | | | still accurate. | | +---------------------+-------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | StartDate | ``xs:date`` | Optional | Single | The date at which this collection of | | | | | | | start and end times and options begin. | | +---------------------+-------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | EndDate | ``xs:date`` | Optional | Single | The date at which this collection of | | | | | | | start and end times and options end. | | +---------------------+-------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ .. _single-xml-hours: Hours ^^^^^ The open and close time for this place. All times must be fully specified, including a timezone offset from UTC. +--------------+----------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Tag | Data Type | Required? | Repeats? | Description | Error Handling | +==============+==================================+==============+==============+==========================================+==========================================+ | StartTime | :ref:`single-xml-time-with-zone` | Optional | Single | The time at which this place opens. | | +--------------+----------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | EndTime | :ref:`single-xml-time-with-zone` | Optional | Single | The time at which this place closes. | | +--------------+----------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ .. _single-xml-time-with-zone: TimeWithZone %%%%%%%%%%%% A string pattern restricting the value to a time with an included offset from UTC. The pattern is ``(([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]|(24:00:00))(Z|[+-]((0[0-9]|1[0-3]):[0-5][0-9]|14:00))`` .. code-block:: xml :linenos: 06:00:00-05:00 12:00:00-05:00 13:00:00-05:00 19:00:00-05:00 2013-11-05 2013-11-05 .. _single-xml-simple-address-type: SimpleAddressType ~~~~~~~~~~~~~~~~~ A ``SimpleAddressType`` represents a structured address. +--------------+---------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Tag | Data Type | Required? | Repeats? | Description | Error Handling | +==============+===============+==============+==============+==========================================+==========================================+ | Line1 | ``xs:string`` | **Required** | Single | The address line for a structured | | | | | | | address. Should include the street | | | | | | | number, street name, and any prefix and | | | | | | | suffix. | | +--------------+---------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Line2 | ``xs:string`` | Optional | Single | Additional field for an address | | +--------------+---------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Line3 | ``xs:string`` | Optional | Single | Additional field for an address | | +--------------+---------------+--------------+--------------+------------------------------------------+------------------------------------------+ | City | ``xs:string`` | **Required** | Single | The City value of a structured address. | | +--------------+---------------+--------------+--------------+------------------------------------------+------------------------------------------+ | State | ``xs:string`` | **Required** | Single | The State value of a structured address. | | +--------------+---------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Zip | ``xs:string`` | Optional | Single | The ZIP code of a structured address. | | +--------------+---------------+--------------+--------------+------------------------------------------+------------------------------------------+ .. _single-xml-source: Source ~~~~~~ The Source object represents the organization that is publishing the information. This object is the only required object in the feed file, and only one source object is allowed to be present. +------------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Tag | Data Type | Required? | Repeats? | Description | Error Handling | +========================+==========================================+==============+==============+==========================================+==========================================+ | Name | ``xs:string`` | **Required** | Single | Specifies the name of the organization | | | | | | | that is providing the information. | | +------------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | VipId | ``xs:string`` | **Required** | Single | Specifies the ID of the organization. | | | | | | | VIP uses FIPS_ codes for this ID. | | +------------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | DateTime | ``xs:dateTime`` | **Required** | Single | Specifies the date and time of the feed | | | | | | | production. The date/time is considered | | | | | | | to be in the timezone local to the | | | | | | | organization. | | +------------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Description | :ref:`single-xml-internationalized-text` | Optional | Single | Specifies both the nature of the | | | | | | | organization providing the data and what | | | | | | | data is in the feed. | | +------------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | OrganizationUri | ``xs:string`` | Optional | Single | Specifies a URI to the home page of the | | | | | | | organization publishing the data. | | +------------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | FeedContactInformation | :ref:`single-xml-contact-information` | Optional | Single | Reference to the | | | | | | | :ref:`single-xml-person` who will | | | | | | | respond to inquiries about the | | | | | | | information contained within the file. | | +------------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | TouUri | ``xs:anyURI`` | Optional | Single | Specifies the website where the Terms of | | | | | | | Use for the information in this file can | | | | | | | be found. | | +------------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Version | ``xs:string`` | Optional | Single | Specifies the version of the data | | +------------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ .. _FIPS: https://www.census.gov/geo/reference/codes/cou.html .. code-block:: xml :linenos: 2013-10-24T14:25:28 SBE is the official source for Virginia data State Board of Elections, Commonwealth of Virginia http://www.sbe.virginia.gov/ 51 5.0 .. _single-xml-spatial-boundary: SpatialBoundary ~~~~~~~~~~~~~~~ The ``SpatialBoundary`` object defines a boundary in space. This boundary is usually defined by one or more discrete, closed polygonal shapes. +---------------------------+-----------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Tag | Data Type | Required? | Repeats? | Description | Error Handling | +===========================+===============================================+==============+==============+==========================================+==========================================+ | ExternalGeospatialFeature | :ref:`single-xml-external-geospatial-feature` | **Required** | Single | The spatial boundary defined by a | | | | | | | geospatial feature that is external to | | | | | | | the VIP feed. | | +---------------------------+-----------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ .. code-block:: xml :linenos: ef1 shp 3 .. _single-xml-external-geospatial-feature: ExternalGeospatialFeature ^^^^^^^^^^^^^^^^^^^^^^^^^ The ``ExternalGeospatialFeature`` object contains a reference to a geospatial feature (one or more shapes) contained in a separate file external to the VIP feed. +-------------------+--------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Tag | Data Type | Required? | Repeats? | Description | Error Handling | +===================+======================================+==============+==============+==========================================+==========================================+ | ExternalFileId | ``xs:IDREF`` | **Required** | Single | Links to the | | | | | | | :ref:`single-xml-external-file` | | | | | | | containing the geospatial shape(s) that | | | | | | | define the feature's boundary. | | +-------------------+--------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | FileFormat | :ref:`single-xml-geospatial-format` | **Required** | Single | The format of the geospatial file. | | +-------------------+--------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | FeatureIdentifier | :ref:`single-xml-feature-identifier` | **Required** | Repeats | Identifiers indicating which specific | | | | | | | shape(s) to use from the geospatial | | | | | | | file. These refer to identifiers within | | | | | | | the referenced external file. This is a | | | | | | | repeated field in the XML specification, | | | | | | | but a scalar field in the CSV | | | | | | | specification. If more than one | | | | | | | identifier is required with the CSV | | | | | | | specifiation, multiple values can be | | | | | | | provided by delimited by space. | | +-------------------+--------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ .. _single-xml-feature-identifier: FeatureIdentifier %%%%%%%%%%%%%%%%% +--------------+--------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Tag | Data Type | Required? | Repeats? | Description | Error Handling | +==============+==============+==============+==============+==========================================+==========================================+ | Index | ``xs:int`` | Optional | Single | The index value for the shapefile | | | | | | | feature. | | +--------------+--------------+--------------+--------------+------------------------------------------+------------------------------------------+ .. _single-xml-state: State ~~~~~ The State object includes state-wide election information. The ID attribute is recommended to be the state's FIPS code, along with the prefix "st". +--------------------------+----------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Tag | Data Type | Required? | Repeats? | Description | Error Handling | +==========================+========================================+==============+==============+==========================================+==========================================+ | ElectionAdministrationId | ``xs:IDREF`` | Optional | Single | Links to the state's election | | | | | | | administration object. | | +--------------------------+----------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | ExternalIdentifiers | :ref:`single-xml-external-identifiers` | Optional | Single | Other identifier for the state that | | | | | | | relates to another dataset (e.g. | | | | | | | `OCD-ID`_). | | +--------------------------+----------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Name | ``xs:string`` | **Required** | Single | Specifiers the name of a state, such as | | | | | | | Alabama. | | +--------------------------+----------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | PollingLocationIds | ``xs:IDREFS`` | Optional | Single | Specifies a link to the state's | | | | | | | :ref:`polling locations | | | | | | | `. If early | | | | | | | vote centers or ballot drop locations | | | | | | | are state-wide (e.g., anyone in the | | | | | | | state can use them), they can be | | | | | | | specified here, but you are encouraged | | | | | | | to only use the | | | | | | | :ref:`single-xml-precinct` element. | | +--------------------------+----------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ .. _OCD-ID: http://opencivicdata.readthedocs.org/en/latest/ocdids.html .. code-block:: xml :linenos: ea40133 ocd-id ocd-division/country:us/state:va Virginia .. _single-xml-street-segment: StreetSegment ~~~~~~~~~~~~~ A Street Segment objection represents a portion of a street and the links to the precinct that this geography (i.e., segment) is contained within. The start address house number must be less than the end address house number unless the segment consists of only one address, in which case these values are equal. +----------------------+----------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Tag | Data Type | Required? | Repeats? | Description | Error Handling | +======================+============================+==============+==============+==========================================+==========================================+ | AddressDirection | ``xs:string`` | Optional | Single | Specifies the (inter-)cardinal direction | | | | | | | of the entire address. An example is | | | | | | | "NE" for the address "100 E Capitol St | | | | | | | NE." | | +----------------------+----------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | City | ``xs:string`` | **Required** | Single | The city specifies the city or town of | | | | | | | the address. | | +----------------------+----------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | IncludesAllAddresses | ``xs:boolean`` | Optional | Single | Specifies if the segment covers every | | | | | | | address on this street. If this is | | | | | | | *true*, then the values of | | | | | | | **StartHouseNumber** and | | | | | | | **EndHouseNumber** should be ignored. | | | | | | | The value of **OddEvenBoth** must be | | | | | | | *both*. | | +----------------------+----------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | IncludesAllStreets | ``xs:boolean`` | Optional | Single | Specifies if the segment covers every | | | | | | | street in this city. If this is *true*, | | | | | | | then the values of **OddEvenBoth**, | | | | | | | **StartHouseNumber**, | | | | | | | **EndHouseNumber**, **StreetName**, and | | | | | | | **Zip** should be ignored. | | +----------------------+----------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | OddEvenBoth | :ref:`single-xml-oeb-enum` | **Required** | Single | Specifies whether the odd side of the | If the field is not present or invalid, | | | | | | street (in terms of house numbers), the | the implementation is required to ignore | | | | | | even side, or both are in included in | the StreetSegment containing it. | | | | | | the street segment. | | +----------------------+----------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | PrecinctId | ``xs:IDREF`` | **Required** | Single | References the | | | | | | | :ref:`single-xml-precinct` that contains | | | | | | | the entire street segment. If a precinct | | | | | | | has a :ref:`single-xml-spatial-boundary` | | | | | | | which also contains the entire street | | | | | | | segment, then the precinct assignment | | | | | | | from the segment will be preferred over | | | | | | | the assignment defined by the spatial | | | | | | | boundary. | | +----------------------+----------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | StartHouseNumber | ``xs:integer`` | Optional | Single | The house number at which the street | Unless **IncludesAllAddresses** or | | | | | | segment starts. This value is necessary | **IncludesAllStreets** are true, if the | | | | | | for the street segment to make any | field is not present or invalid, the | | | | | | sense. Unless **IncludesAllAddresses** | implementation is required to ignore the | | | | | | or **IncludesAllStreets** are true, this | StreetSegment element containing it. If | | | | | | value must be less than or equal to | the **StartHouseNumber** is greater than | | | | | | **EndHouseNumber**. If | the **EndHouseNumber**, the | | | | | | **IncludesAllAddresses** or | implementation should ignore the element | | | | | | **IncludesAllStreets** are true, this | containing them. | | | | | | value is ignored. | | +----------------------+----------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | EndHouseNumber | ``xs:integer`` | Optional | Single | The house number at which the street | Unless **IncludesAllAddresses** or | | | | | | segment ends. This value is necessary | **IncludesAllStreets** are true, if the | | | | | | for the street segment to make any | field is not present or invalid, the | | | | | | sense. Unless **IncludesAllAddresses** | implementation is required to ignore the | | | | | | or **IncludesAllStreets** are true, it | StreetSegment element containing it. If | | | | | | must be greater than or equal to | the **EndHouseNumber** is less than the | | | | | | **StartHouseNumber**. If | **StartHouseNumber**, the implementation | | | | | | **IncludesAllAddresses** or | should ignore the element containing it. | | | | | | **IncludesAllStreets** are true, this | | | | | | | value is ignored. | | +----------------------+----------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | HouseNumberPrefix | ``xs:string`` | Optional | Single | Part of a street address. It may contain | | | | | | | letters or slashes (e.g., 'B' in 'B22 | | | | | | | Main St'). If this value is present then | | | | | | | **StartHouseNumber** must be equal to | | | | | | | **EndHouseNumber**. This field cannot be | | | | | | | used if **IncludesAllAddresses** or | | | | | | | **IncludesAllStreets** are true. | | +----------------------+----------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | HouseNumberSuffix | ``xs:string`` | Optional | Single | Part of a street address. It may contain | | | | | | | letters or slashes (e.g., 1/2 in '22 1/2 | | | | | | | Main St'). If this value is present then | | | | | | | **StartHouseNumber** must be equal to | | | | | | | **EndHouseNumber**. This field cannot be | | | | | | | used if **IncludesAllAddresses** or | | | | | | | **IncludesAllStreets** are true. | | +----------------------+----------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | State | ``xs:string`` | **Required** | Single | Specifies the two-letter state | | | | | | | abbreviation of the address. | | +----------------------+----------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | StreetDirection | ``xs:string`` | Optional | Single | Specifies the (inter-)cardinal direction | | | | | | | of the street address (e.g., the "E" in | | | | | | | "100 E Capitol St NE"). | | +----------------------+----------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | StreetName | ``xs:string`` | Optional | Single | Represents the name of the street for | | | | | | | the address. A special wildcard, "*", | | | | | | | denotes every street in the given | | | | | | | city/town. It optionally may contain | | | | | | | street direction, street suffix or | | | | | | | address direction (e.g., both "Capitol" | | | | | | | and "E Capitol St NE" are acceptable for | | | | | | | the address "100 E Capitol St NE"), | | | | | | | however this is not preferred. Preferred | | | | | | | is street name alone (e.g. "Capitol"). | | +----------------------+----------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | StreetSuffix | ``xs:string`` | Optional | Single | Represents the abbreviated, | | | | | | | non-directional suffix to the street | | | | | | | name. An example is "St" for the address | | | | | | | "100 E Capitol St NE." | | +----------------------+----------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | UnitNumber | ``xs:string`` | Optional | Repeats | The apartment/unit number for a street | | | | | | | segment. If this value is present then | | | | | | | **StartHouseNumber** must be equal to | | | | | | | **EndHouseNumber**. This field cannot be | | | | | | | used if **IncludesAllAddresses** or | | | | | | | **IncludesAllStreets** are true. | | +----------------------+----------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Zip | ``xs:string`` | Optional | Single | Specifies the zip code of the address. | | | | | | | It may be 5 or 9 digits, and it may | | | | | | | include a hyphen ('-'). It is required | | | | | | | as it helps with geocoding, which is | | | | | | | crucial for distributors. | | +----------------------+----------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ .. code-block:: xml :linenos: Charlottesville true both pre99999 VA CHAPEL HILL RD 22901 GREENWOOD both pre92145 1 201 VA MISTY MOUNTAIN RD 22943 GREENWOOD both pre92145 1 1 B 1/2 VA MISTY MOUNTAIN RD 22943 .. _single-xml-term: Term ~~~~ +--------------+------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Tag | Data Type | Required? | Repeats? | Description | Error Handling | +==============+====================================+==============+==============+==========================================+==========================================+ | Type | :ref:`single-xml-office-term-type` | **Required** | Single | Specifies the type of office term (see | | | | | | | :ref:`single-xml-office-term-type` for | | | | | | | valid values). | | +--------------+------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | StartDate | ``xs:date`` | Optional | Single | Specifies the start date for the current | | | | | | | term of the office. | | +--------------+------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | EndDate | ``xs:date`` | Optional | Single | Specifies the end date for the current | | | | | | | term of the office. | | +--------------+------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ .. code-block:: xml :linenos: ed60129 2013-01-01 false Governor full-term .. _single-xml-time-with-zone: TimeWithZone ~~~~~~~~~~~~ A string pattern restricting the value to a time with an included offset from UTC. The pattern is ``(([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]|(24:00:00))(Z|[+-]((0[0-9]|1[0-3]):[0-5][0-9]|14:00))`` .. code-block:: xml :linenos: 06:00:00-05:00 12:00:00-05:00 13:00:00-05:00 19:00:00-05:00 2013-11-05 2013-11-05 .. _single-xml-voter-service: VoterService ~~~~~~~~~~~~ +--------------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Tag | Data Type | Required? | Repeats? | Description | Error Handling | +==========================+==========================================+==============+==============+==========================================+==========================================+ | ContactInformation | :ref:`single-xml-contact-information` | Optional | Single | The contact for a particular voter | | | | | | | service. | | +--------------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Description | :ref:`single-xml-internationalized-text` | Optional | Single | Long description of the services | | | | | | | available. | | +--------------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | ElectionOfficialPersonId | ``xs:IDREF`` | Optional | Single | The :ref:`authority ` | | | | | | | for a particular voter service. | | +--------------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | Type | :ref:`single-xml-voter-service-type` | Optional | Single | The type of :ref:`voter service | | | | | | | `. | | +--------------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ | OtherType | ``xs:string`` | Optional | Single | If Type is "other", OtherType allows for | | | | | | | cataloging another type of voter | | | | | | | service. | | +--------------------------+------------------------------------------+--------------+--------------+------------------------------------------+------------------------------------------+ .. _single-xml-enumerations: Enumerations ------------ .. _single-xml-ballot-measure-type: BallotMeasureType ~~~~~~~~~~~~~~~~~ A list of the various types of ballot measures. States may have different legal definitions of each type; Wikipedia_ has more details about each type. These values are to help states with multiple types of non-candidate-based contests distinguish between each type; as such, the definitions in this table are simple guidelines. Ultimately it is up to the state or local election official to choose the value which best describes the ballot measure(s) in their jurisdiction. +----------------+----------------------------------------------------+ | Tag | Description | +================+====================================================+ | ballot-measure | A catch-all for generic types of | | | non-candidate-based contests. | +----------------+----------------------------------------------------+ | initiative | These are usually citizen-driven measures to be | | | placed on the ballot. These could include both | | | statutory changes and constitutional amendments. | +----------------+----------------------------------------------------+ | referendum | These could include measures to repeal existing | | | acts of legislation, legislative referrals, and | | | legislatively-referred state constitutional | | | amendments. | +----------------+----------------------------------------------------+ | other | Anything that does not fall into the above | | | categories. | +----------------+----------------------------------------------------+ .. _Wikipedia: http://en.wikipedia.org/wiki/Initiatives_and_referendums_in_the_United_States .. _single-xml-candidate-post-election-status: CandidatePostElectionStatus ~~~~~~~~~~~~~~~~~~~~~~~~~~~ +--------------------+----------------------------------------------------+ | Tag | Description | +====================+====================================================+ | advanced-to-runoff | For contests in which the top *N* candidates | | | advance to the next round. | +--------------------+----------------------------------------------------+ | projected-winner | A candidate is expected to win, but official | | | results are not yet complete. | +--------------------+----------------------------------------------------+ | winner | The candidate has officially won. | +--------------------+----------------------------------------------------+ | withdrawn | The candidate has withdrawn from the contest. | +--------------------+----------------------------------------------------+ .. _single-xml-candidate-pre-election-status: CandidatePreElectionStatus ~~~~~~~~~~~~~~~~~~~~~~~~~~ +--------------+----------------------------------------------------+ | Tag | Description | +==============+====================================================+ | filed | The candidate has filed for office but not yet | | | been qualified. | +--------------+----------------------------------------------------+ | qualified | The candidate has qualified for the contest. | +--------------+----------------------------------------------------+ | withdrawn | The candidate has withdrawn from the contest (but | | | may still be on the ballot). | +--------------+----------------------------------------------------+ | write-in | | +--------------+----------------------------------------------------+ .. _single-xml-checksum-algorithm: ChecksumAlgorithm ~~~~~~~~~~~~~~~~~ +--------------+----------------------------------------------------+ | Tag | Description | +==============+====================================================+ | sha-256 | 256-bit cryptographic hash algorithm of the SHA-2 | | | family | +--------------+----------------------------------------------------+ | sha-512 | 512-bit cryptographic hash algorithm of the SHA-2 | | | family | +--------------+----------------------------------------------------+ .. _single-xml-district-type: DistrictType ~~~~~~~~~~~~ Enumeration describing the set of possible jurisdiction and district types. Please use the enumeration value which most accurately reflects the type of district or jurisdiction in your state or county. For example, "town" and "township" may mean different things -- or not be defined at all -- in your state, so please use the definition which best matches your local meaning. +----------------+----------------------------------------------------+ | Tag | Description | +================+====================================================+ | borough | A borough | +----------------+----------------------------------------------------+ | city | A city. | +----------------+----------------------------------------------------+ | city-council | A specific seat/jurisdiction for a city, town, or | | | village council. | +----------------+----------------------------------------------------+ | congressional | A United States congressional district. | +----------------+----------------------------------------------------+ | county | A county. | +----------------+----------------------------------------------------+ | county-council | A county council district, either in its entirety | | | or for a specific seat. | +----------------+----------------------------------------------------+ | judicial | A judicial district. | +----------------+----------------------------------------------------+ | municipality | A civil division which is not a town, city, | | | village, or county. | +----------------+----------------------------------------------------+ | national | The United States. | +----------------+----------------------------------------------------+ | school | A school district. | +----------------+----------------------------------------------------+ | special | A `special-purpose district`_ that exist separate | | | from general-purpose districts. | +----------------+----------------------------------------------------+ | state | A state, district, commonwealth, or U.S. | | | territory. | +----------------+----------------------------------------------------+ | state-house | The lower house of a state legislature. | +----------------+----------------------------------------------------+ | state-senate | The upper house of a state legislature. | +----------------+----------------------------------------------------+ | town | A town_. | +----------------+----------------------------------------------------+ | township | A township, which may be different than a town. | | | See the `Wikipedia article`_. | +----------------+----------------------------------------------------+ | utility | A non-water public or municipal utility district. | +----------------+----------------------------------------------------+ | village | A village district. | +----------------+----------------------------------------------------+ | ward | A ward. | +----------------+----------------------------------------------------+ | water | A water district. | +----------------+----------------------------------------------------+ | other | Any district not described above. Use the | | | *OtherType* field to describe it. | +----------------+----------------------------------------------------+ .. _`special-purpose district`: http://en.wikipedia.org/wiki/Special-purpose_district .. _town: http://en.wikipedia.org/wiki/Town#United_States .. _`Wikipedia article`: http://en.wikipedia.org/wiki/Town#United_States .. _single-xml-geospatial-format: GeospatialFormat ~~~~~~~~~~~~~~~~ Geospatial file formats that are supported by the VIP specification. +--------------+---------------------------------------------------------------------------+ | Tag | Description | +==============+===========================================================================+ | shp | ESRI Shapefile (`reference | | | `_) | +--------------+---------------------------------------------------------------------------+ .. _single-xml-identifier-type: IdentifierType ~~~~~~~~~~~~~~ +----------------+----------------------------------------------------+ | Tag | Description | +================+====================================================+ | fips | Federal Information Processing Standards codes for | | | states_, counties_, and cities_. | +----------------+----------------------------------------------------+ | local-level | An identifier generated or used by local | | | governments or organizations. | +----------------+----------------------------------------------------+ | national-level | An identifier generated or used by national | | | organizations. | +----------------+----------------------------------------------------+ | ocd-id | An `Open Civic Data Division Identifier`_. | +----------------+----------------------------------------------------+ | state-level | An identifier generated or used by state | | | governments or organizations. | +----------------+----------------------------------------------------+ | other | Any identifier which doesn't fall into any of the | | | above categories. | +----------------+----------------------------------------------------+ .. _states: http://en.wikipedia.org/wiki/Federal_Information_Processing_Standard_state_code .. _counties: http://en.wikipedia.org/wiki/FIPS_county_code .. _cities: http://geonames.usgs.gov/domestic/fips55codedef.html .. _`Open Civic Data Division Identifier`: http://docs.opencivicdata.org/en/latest/proposals/0002.html .. _single-xml-oeb-enum: OebEnum ~~~~~~~ +--------------+----------------------------------------------------+ | Tag | Description | +==============+====================================================+ | both | Both even and odd addresses within the range. | +--------------+----------------------------------------------------+ | even | Only even-numbered addresses within the range. | +--------------+----------------------------------------------------+ | odd | Only odd-numbered addresses within the range. | +--------------+----------------------------------------------------+ .. _single-xml-office-term-type: OfficeTermType ~~~~~~~~~~~~~~ +----------------+----------------------------------------------------+ | Tag | Description | +================+====================================================+ | full-term | This election is for an office for which the | | | existing term has been completed. | +----------------+----------------------------------------------------+ | unexpired-term | This election is for an office for which the | | | original term is not yet complete. | +----------------+----------------------------------------------------+ .. _single-xml-vote-variation: VoteVariation ~~~~~~~~~~~~~ Note that the descriptions below describe what the enumeration names stand for in the context of the VIP spec, rather than provide general definitions of the election terms that the names correspond to. For example, even though there are majority voting methods that are not "1-of-m" (e.g. ranked choice voting), we constrain "majority" to 1-of-m. We do this to eliminate any source of ambiguity when a single enumeration value needs to be assigned to a contest. +----------------+----------------------------------------------------+ | Tag | Description | +================+====================================================+ | 1-of-m | A method where each voter can select up to one | | | option. | +----------------+----------------------------------------------------+ | approval | `Approval voting`_, where each voter can select as | | | many options as desired. | +----------------+----------------------------------------------------+ | borda | `Borda count`_, where each voter can rank the | | | options, and the rankings are assigned point | | | values. | +----------------+----------------------------------------------------+ | cumulative | `Cumulative voting`_, where each voter can | | | distribute their vote to up to *N* options. | +----------------+----------------------------------------------------+ | majority | A 1-of-m method where the winner needs more than | | | 50% of the vote to be elected. | +----------------+----------------------------------------------------+ | n-of-m | A method where each voter can select up to *N* | | | options. | +----------------+----------------------------------------------------+ | plurality | A 1-of-m method where the option with the most | | | votes is elected, regardless of whether the option | | | has more than 50% of the vote. | +----------------+----------------------------------------------------+ | proportional | A `proportional representation`_ method (other | | | than STV), which is any system that elects winners | | | in proportion to the total vote. | +----------------+----------------------------------------------------+ | range | `Range voting`_, where each voter can select a | | | score for each option. | +----------------+----------------------------------------------------+ | rcv | `Ranked choice voting`_ (RCV), where each voter | | | can rank the options, and the ballots are counted | | | in rounds. Also known as instant-runoff voting | | | (IRV) and the single transferable vote (STV). | +----------------+----------------------------------------------------+ | super-majority | A 1-of-m method where the winner needs more than | | | some predetermined fraction of the vote to be | | | elected, where the fraction is more than 50% (e.g. | | | three-fifths or two-thirds). | +----------------+----------------------------------------------------+ | other | Used when the vote variation type is not included | | | in this enumeration. | +----------------+----------------------------------------------------+ .. _`Approval voting`: http://en.wikipedia.org/wiki/Approval_voting .. _`Borda count`: http://en.wikipedia.org/wiki/Borda_count .. _`Cumulative voting`: http://en.wikipedia.org/wiki/Cumulative_voting .. _`proportional representation`: https://en.wikipedia.org/wiki/Proportional_representation .. _`Range voting`: http://en.wikipedia.org/wiki/Range_voting .. _`Ranked choice voting`: http://http://en.wikipedia.org/wiki/Ranked_Choice_Voting .. _single-xml-voter-service-type: VoterServiceType ~~~~~~~~~~~~~~~~ +--------------------+----------------------------------------------------+ | Tag | Description | +====================+====================================================+ | absentee-ballots | This department handles the dispatch, tracking, | | | and return of absentee ballots. | +--------------------+----------------------------------------------------+ | overseas-voting | The department for overseas, military, and other | | | outside-the-U.S. voters. | +--------------------+----------------------------------------------------+ | polling-places | This deparment handles the selection and | | | management of polling places. | +--------------------+----------------------------------------------------+ | voter-registration | The deparment that manages voter registration. | +--------------------+----------------------------------------------------+ | other | Any other service not covered by the above | | | descriptions. | +--------------------+----------------------------------------------------+