Get measure by ID

Path Parameters

id*string

Measure id.

Match^[a-fA-F0-9]{24}$

Organization overlay id. When supplied, the service merges the organization's measure overrides into global measures, includes organization-created measures, excludes organization-deleted measures, and may return overlay metadata such as overlayOrganizationId, overlayDocumentId, globalId, numberOverlayFields, and resolutionStatus. The same overlay context may also be supplied with the X-Organization-Id header.

Match^[a-fA-F0-9]{24}$

Header Parameters

X-Organization-Id?string

Organization id used as the overlay organization context. Equivalent to overlayOrganizationId; when both are supplied, the query parameter takes precedence.

Match^[a-fA-F0-9]{24}$

Response Body

`application/json`

Measure response.

TypeScript Definitions

Use the response body type in TypeScript.

_id?schemas-ObjectId

MongoDB ObjectId serialized as a string.

Match^[a-fA-F0-9]{24}$

election?|

Election key in storage; populated election object in normal public responses.

key?string

Stable measure key generated from election, district, and title.

district?|

Populated district for this measure, with pretty names applied.

parentDistrict?schemas-ObjectId

MongoDB ObjectId serialized as a string.

Match^[a-fA-F0-9]{24}$

districtType?DistrictType

District type from the shared districtTypes constants.

Value in

"country" | "state" | "congressional" | "state-utilities" | "state-utilities-subdistrict" | "state-legislative" | "state-senate" | "state-house" | "state-school" | "state-school-subdistrict" | "state-school-bond-district" | "county" | "county-district" | "county-super-district" | "county-school-district" | "county-school-super-district" | "state-transportation" | "county-district-court" | "city" | "city-council" | "city-school-board" | "city-super-school-board" | "judicial-circuit" | "judicial-district" | "superior-court" | "prosecutorial" | "supreme-court" | "court-of-appeals" | "us-judicial-district" | "fire-advisory" | "fire-protection" | "magisterial" | "park" | "hospital" | "water" | "soil" | "community" | "reservation" | "community-council" | "soil-conservation" | "precinct" | "county-utilities" | "justice-precinct" | "appellate-sub-division" | "elementary" | "technical-education" | "technical-education-subdistrict" | "community-college" | "community-college-subdistrict" | "township" | "municipal-court-district" | "city-court" | "state-water" | "state-board-of-education" | "healthcare" | "healthcare-subdistrict" | "county-library" | "library" | "borough" | "city-parks" | "village" | "town" | "village-district" | "town-council" | "natural-resource-district" | "natural-resource-subdistrict" | "board-of-regents" | "public-service-commission"

cities?array<>

City districts copied from the measure district for querying.

counties?array<>

County districts copied from the measure district for querying.

additionalDistricts?array<|>

excludedDistricts?array<>

originalDistrict?|

Original district when a representative district measure is rolled up to its parent district.

supportedDistrictId?schemas-ObjectId

MongoDB ObjectId serialized as a string.

Match^[a-fA-F0-9]{24}$

title?string

descriptionShort?string

ballotText?string

actNumbers?string

whatItMeans?string

whatItMeansHtml?string

commentaryAvailable?boolean

Defaultfalse

supportersSay?string

opponentsSay?string

sources?array<>

status?MeasureCompletionStatus

Value in"incomplete" | "complete"

coveragePlan?MeasureCoveragePlan

Value in"auto-coverage" | "no-coverage"

coverageDefault?MeasureCoveragePlan

Value in"auto-coverage" | "no-coverage"

coveragePlanIsDefault?boolean

Defaulttrue

coverageStatus?MeasureCoverageStatus

Value in"published" | "not-published"

attributedOrganizations?array<>

priority?number

Default0

expectedReaders?number

districtSearchTerm?string

Search text derived from district naming fields.

result?|

Public result summary when election results are available; otherwise false or omitted. Raw result storage is omitted from the public read contract.

overlayOrganizationId?schemas-ObjectId

MongoDB ObjectId serialized as a string.

Match^[a-fA-F0-9]{24}$

globalId?schemas-ObjectId

MongoDB ObjectId serialized as a string.

Match^[a-fA-F0-9]{24}$

overlayDocumentId?schemas-ObjectId

MongoDB ObjectId serialized as a string.

Match^[a-fA-F0-9]{24}$

numberOverlayFields?integer

Number of overlay-specific fields applied to the merged response.

resolutionStatus?string

Review/resolution state for an overlay document.

createdAt?string

Formatdate-time

updatedAt?string

Formatdate-time

`application/json`

Core data reads require an organization overlay context.

TypeScript Definitions

Use the response body type in TypeScript.

name?string

message?string

code?integer

className?string

data?

errors?

`application/json`

Measure was not found.

TypeScript Definitions

Use the response body type in TypeScript.

name?string

message?string

code?integer

className?string

data?

errors?

curl -X GET "https://example.com/measures/65d4f20f8f5a4d7e9a123456" \  -H "X-Organization-Id: org_123"

{
  "_id": "65d4f20f8f5a4d7e9a123456",
  "election": "string",
  "key": "string",
  "district": "65d4f20f8f5a4d7e9a123456",
  "parentDistrict": "65d4f20f8f5a4d7e9a123456",
  "districtType": "county",
  "cities": [
    "65d4f20f8f5a4d7e9a123456"
  ],
  "counties": [
    "65d4f20f8f5a4d7e9a123456"
  ],
  "additionalDistricts": [
    "65d4f20f8f5a4d7e9a123456"
  ],
  "excludedDistricts": [
    "65d4f20f8f5a4d7e9a123456"
  ],
  "originalDistrict": "65d4f20f8f5a4d7e9a123456",
  "supportedDistrictId": "65d4f20f8f5a4d7e9a123456",
  "title": "string",
  "descriptionShort": "string",
  "ballotText": "string",
  "actNumbers": "string",
  "whatItMeans": "string",
  "whatItMeansHtml": "string",
  "commentaryAvailable": false,
  "supportersSay": "string",
  "opponentsSay": "string",
  "sources": [
    {
      "url": "http://example.com",
      "type": "string",
      "sourceType": "website",
      "directQuote": "string",
      "title": "string"
    }
  ],
  "status": "incomplete",
  "coveragePlan": "auto-coverage",
  "coverageDefault": "auto-coverage",
  "coveragePlanIsDefault": true,
  "coverageStatus": "published",
  "attributedOrganizations": [
    {
      "key": "string",
      "coveragePlan": "no-coverage"
    }
  ],
  "priority": 0,
  "expectedReaders": 0,
  "districtSearchTerm": "string",
  "result": false,
  "overlayOrganizationId": "65d4f20f8f5a4d7e9a123456",
  "globalId": "65d4f20f8f5a4d7e9a123456",
  "overlayDocumentId": "65d4f20f8f5a4d7e9a123456",
  "numberOverlayFields": 0,
  "resolutionStatus": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}

Path Parameters

Query Parameters

Header Parameters

Response Body

200application/json

401application/json

404application/json

`application/json`

`application/json`

`application/json`