OfficeScope

Page Summary

• OfficeScope entities are used in metadata feeds to specify which offices an ElectionEvent and OfficeholderSubFeed entity correspond to.

• Key elements include Office Level, Jurisdiction OCD ID, and Office Roles to define the scope.

• ElectoralDistrictCollection can be used to specify the electoral districts voting for a listed office role.

Note: This entity is only used in metadata feeds. It isn't used with pre-election, election, or officeholder feeds.

OfficeScope entities are used to specify which offices an ElectionEvent and OfficeholderSubFeed entity correspond to.

Elements

Name	Tag	Type	Notes	Multiplicity
Debug name	DebugName	string	Descriptive name used for the office.	0 or 1
Office level	OfficeLevel	OfficeLevel	Specifies the level of the offices within this scope: Country for national, Administrative Area 1 for a state or province, etc.	1
Jurisdiction OCD ID	JurisdictionOcdId	Ocd Id	Optional if OfficeLevel is Country, otherwise required. Use this field to specify the political geography. For example, if the state is Virginia versus Pennsylvania, or Manitoba versus Ontario.	0 or 1
Office roles	OfficeRoles	OfficeRole	A list of the roles contained in the data set, specifically limited to those being elected for this office level, jurisdiction OCD ID, etc.	1 or more
ElectoralDistrictCollection	ElectoralDistrictCollection	Ocd Id	The OCD ID list of the electoral districts voting for the listed office role. An empty list implies that the scope includes all possible districts for the specified election location or officeholder.	0 or 1

Examples

The following example is a Feed that contains an ElectionEvent with OfficeScope. It indicates that the Feed contains (or is expected to contain) data about a set of one or more elections to elect the national-level President, one or more Lower House seats, and one or more Upper House seats:

XML

<OfficeScope>
  <DebugName>Scope of US general election</DebugName>
  <OfficeLevel>Country</OfficeLevel>
  <JurisdictionOcdId>ocd-division/country:us</JurisdictionOcdId>
  <OfficeRoles>president</OfficeRoles>
  <OfficeRoles>lower house</OfficeRoles>
  <OfficeRoles>upper house</OfficeRoles>
</OfficeScope>

JSON

{
 "OfficeScope": {
   "DebugName": "Scope of US general election",
   "OfficeLevel": "Country",
   "JurisdictionOcdId": "ocd-division/country:us",
   "OfficeRoles": [
     "president",
     "lower house",
     "upper house"
   ]
 }
}
    

The same ElectionEvent can contain additional OfficeScope entities that indicate several state-level elections within Virginia and Pennsylvania for different state-level roles:

XML

<OfficeScope>
  <DebugName>Virginia election scope</DebugName>
  <OfficeLevel>Administrative Area 1</OfficeLevel>
  <JurisdictionOcdId>ocd-division/country:us/state:va</JurisdictionOcdId>
  <OfficeRoles>attorney general</OfficeRoles>
  <OfficeRoles>state executive</OfficeRoles>
</OfficeScope>
<OfficeScope>
  <DebugName>Pennsylvania election scope</DebugName>
  <OfficeLevel>Administrative Area 1</OfficeLevel>
  <JurisdictionOcdId>ocd-division/country:us/state:pa</JurisdictionOcdId>
  <OfficeRoles>state lower house</OfficeRoles>
  <OfficeRoles>state upper house</OfficeRoles>
  <OfficeRoles>state executive</OfficeRoles>
</OfficeScope>

JSON

{
 "OfficeScope": {
 "DebugName": "Virginia election scope",
 "OfficeLevel": "Administrative Area 1",
 "JurisdictionOcdId": "ocd-division/country:us/state:va",
 "OfficeRoles": [
   "attorney general",
   "state executive"
 ]
 }
}
{
 "OfficeScope": {
 "DebugName": "Pennsylvania election scope",
 "OfficeLevel": "Administrative Area 1",
 "JurisdictionOcdId": "ocd-division/country:us/state:pa",
 "OfficeRoles": [
   "state lower house",
   "state upper house",
   "state executive"
 ]
 }
}
    

The ElectionEvent can, if needed, contain OfficeScope entities that specify the electoral districts voting for the listed office role:

XML

<OfficeScope>
  <DebugName>US general election scope</DebugName>
  <OfficeLevel>National</OfficeLevel>
  <JurisdictionOcdId>ocd-division/country:us</JurisdictionOcdId>
  <OfficeRoles>upper house</OfficeRoles>
  <ElectoralDistrictCollection>
    <OcdId>ocd-division/country:us/state:ar</OcdId>
    <OcdId>ocd-division/country:us/state:ca</OcdId>
    <OcdId>ocd-division/country:us/state:ct</OcdId>
    <OcdId>ocd-division/country:us/state:de</OcdId>
    <OcdId>ocd-division/country:us/state:fl</OcdId>
  </ElectoralDistrictCollection>
</OfficeScope>

JSON

{
 "OfficeScope": {
   "DebugName" : "US general election scope",
   "OfficeLevel": "National",
   "JurisdictionOcdId": "ocd-division/country:us",
   "OfficeRoles": "upper house",
   "ElectoralDistrictCollection": {
     "OcdId" : [
     "ocd-division/country:us/state:ar",
     "ocd-division/country:us/state:ca",
     "ocd-division/country:us/state:ct",
     "ocd-division/country:us/state:de",
     "ocd-division/country:us/state:fl"
     ]
   }
 }
}