Use ElectionReport
as the root entity. It defines items that pertain to the
status and format of the report and when it was generated.
ElectionReport
includes the following major elements:
As with Election
, ElectionReport
"wraps" occurrences of the elements, except
for Election
, in container elements. This makes it easier to manipulate the
instance files in XML viewers and editors.
Sometimes, it's important to preserve a particular ordering scheme of items, such as offices or political parties. In these cases, we expect the generating application to define those elements in accordance with any ordering scheme already in place.
Elements
The following table lists elements for ElectionReport
:
Element | Multiplicity | Type | Description |
---|---|---|---|
CommitteeCollection |
0 or 1 | N/A | Wrapper element for
Committee
definitions. For more details, read
Collection entities. |
Election |
0 or more | Election |
Associates elections with the report. |
ExternalIdentifiers |
0 or 1 | ExternalIdentifiers |
Associates an ID with the report. |
Format |
1 | ReportDetailLevel |
Provides the detail level of the report, such as if it's a contest summary or precinct-level results. |
GeneratedDate |
1 | dateTime |
Identifies the date and time that the election report was generated. |
GpUnitCollection |
0 or 1 | N/A | Wrapper element for
GpUnit
definitions. For more details, read
Collection entities. |
Issuer |
1 | string |
Identification of the report issuer. |
IssuerAbbreviation |
1 | string |
An abbreviation for the report issuer, such as an abbreviation of the state or constituency for which results are being reported. |
IsTest |
0 or 1 | boolean |
Indicates whether the report is a test report. If this element isn't
present, the default value is false . |
Notes |
0 or 1 | string |
Used to include an arbitrary message with the report. |
OfficeCollection |
0 or 1 | N/A | Wrapper element for
Office
definitions. For more details, read
Collection entities. |
PartyCollection |
0 or 1 | N/A | Wrapper element for
Party
definitions. For more details, read
Collection entities. |
PersonCollection |
0 or 1 | N/A | Wrapper element for
Person
definitions. For more details, read
Collection entities. |
SequenceStart |
1 | integer |
The report's number as part of a sequence of reports. This element is
used with SequenceEnd to be read as, for example, "1 of 1",
"1 of 2", or "2 of 2". Starts with 1 . |
SequenceEnd |
1 | integer |
The upper bound of a sequence of reports. For example, this is
1 if there's only one report, or 2 if there
are two reports in the sequence. |
Status |
1 | ResultsStatus |
Status of the election report, such as pre-election or unofficial. |
TestType |
0 or 1 | string |
A description of the type of test, such as pre-election or logic and accuracy. |
VendorApplicationID |
1 | string |
An identifier of the vendor application that generates the election
report. For example, X-EMS version 3.1.a . |
Examples
XML
<ElectionReport xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <Election>…</Election> <GpUnitCollection> <GpUnit objectId="ru-gpu0">…</GpUnit> <GpUnit objectId="ru-gpu1">…</GpUnit> </GpUnitCollection> <OfficeCollection> <Office objectId="off0001a">…</Office> </OfficeCollection> <PartyCollection> <Party objectId="par001">…</Party> <Party objectId="par002">…</Party> </PartyCollection> <PersonCollection> <Person objectId="per001">…</Person> <Person objectId="per002">…</Person> </PersonCollection> <Issuer>Example Data Provider</Issuer> <IssuerAbbreviation>EDP</IssuerAbbreviation> <Format>summary-contest</Format> <GeneratedDate>2013-11-05T14:25:28</GeneratedDate> <Status>unofficial-partial</Status> <VendorApplicationId>Hand-Generated v0.1</VendorApplicationId> <SequenceStart>1</SequenceStart> <SequenceEnd>1</SequenceEnd> </ElectionReport>
JSON
{ "@type": "ElectionReport", "Election": [ ... ], "GpUnitCollection": { "GpUnit": [ {...}, {...} ] }, "OfficeCollection": { "Office": [ { "objectId": "off0001a", ... } ] }, "PartyCollection": { "Party": [ { "objectId": "par001", ... }, { "objectId": "par002", ... } ] }, "PersonCollection": { "Person": [ { "objectId": "per001", ... }, { "objectId": "per002", ... } ] }, "Issuer": "Example Data Provider", "IssuerAbbreviation": "EDP", "Format": "summary-contest", 'GeneratedDate": "2013-11-05T14:25:28", "Status": "unofficial-partial", "VendorApplicationId": "Hand-Generated v0.1", "SequenceStart": 1, "SequenceEnd": 1 }