org.ballotready.constituent.endorsement

ballotready.org

Documentation

An endorsement of a candidate for office declared by a constituent.

main record

An endorsement of a candidate for office declared by a constituent.

Record Key tid Timestamp-based ID

Properties

candidacy ref #candidacy Optional

No description available.

comment string Optional

Custom comment regarding this endorsement.

maxLength: 2560 bytesmaxGraphemes: 256 graphemes

createdAt string datetime Required

Timestamp when this record was originally created.

organization ref #organization Optional

No description available.

View raw schema

{
  "description": "An endorsement of a candidate for office declared by a constituent.",
  "key": "tid",
  "record": {
    "properties": {
      "candidacy": {
        "ref": "#candidacy",
        "type": "ref"
      },
      "comment": {
        "description": "Custom comment regarding this endorsement.",
        "maxGraphemes": 256,
        "maxLength": 2560,
        "type": "string"
      },
      "createdAt": {
        "description": "Timestamp when this record was originally created.",
        "format": "datetime",
        "type": "string"
      },
      "organization": {
        "ref": "#organization",
        "type": "ref"
      }
    },
    "required": [
      "createdAt"
    ],
    "type": "object"
  },
  "type": "record"
}

candidacy object

A candidate in the running for a specific office in a specific election.

Properties

civicEngineId string Required

CivicEngine API identifier for the candidacy.

election string Optional

Election name.

name string Optional

Candidate name.

position string Optional

Position name.

View raw schema

{
  "description": "A candidate in the running for a specific office in a specific election.",
  "properties": {
    "civicEngineId": {
      "description": "CivicEngine API identifier for the candidacy.",
      "type": "string"
    },
    "election": {
      "description": "Election name.",
      "type": "string"
    },
    "name": {
      "description": "Candidate name.",
      "type": "string"
    },
    "position": {
      "description": "Position name.",
      "type": "string"
    }
  },
  "required": [
    "civicEngineId"
  ],
  "type": "object"
}

organization object

An organization with verified endorsements.

Properties

civicEngineId string Required

CivicEngine API identifier for the candidacy.

name string Optional

Organization name.

View raw schema

{
  "description": "An organization with verified endorsements.",
  "properties": {
    "civicEngineId": {
      "description": "CivicEngine API identifier for the candidacy.",
      "type": "string"
    },
    "name": {
      "description": "Organization name.",
      "type": "string"
    }
  },
  "required": [
    "civicEngineId"
  ],
  "type": "object"
}