Skip to content

Latest commit

 

History

History
496 lines (475 loc) · 12.3 KB

PLATFORM-DATAOBJECTS.md

File metadata and controls

496 lines (475 loc) · 12.3 KB
Raw

Open Parliament Platform Data Objects (Examples)

1 Media

/api/v1/media/MEDIAID

Example Response

"data": {
  "type": "media",
  "id": "DE-019021012",
  "attributes": {
    "originID": "9786865",
    "originMediaID": "7502148",
    "creator": "Deutscher Bundestag",
    "license": "CC-BY-SA",
    "parliament": "DE",
    "parliamentLabel": "Deutscher Bundestag",
    "order": 2,
    "aligned": true,
    "dateStart": "2007-08-31T16:47+00:00",
    "dateEnd": "2007-08-31T16:58+00:00",
    "duration": 340.32134,
    "videoFileURI": "https://example.com/media.mp4"
    "audioFileURI": "https://example.com/media.mp3",
    "sourcePage": "https://dbtg.tv/fvid/7502148",
    "thumbnailURI": "https://example.com/thumb.png"
    "thumbnailCreator": "Deutscher Bundestag",
    "thumbnailLicense": "CC-BY-SA",
    "additionalInformation": {},
    "lastChanged": "2021-03-18T03:22+00:00",
    "textContents": [
      {
        "id": 34,
        "type": "text",
        "textBody": [
          {
            "type": "speech",
            "text": "Sehr geehrte Damen und Herren, ..."
          },
          {
            "type": "comment",
            "text": "(Beifall bei der CDU/CSU, der FDP und dem BÜNDNIS 90/DIE GRÜNEN sowie bei Abgeordneten der SPD und der AfD)"
          }
        ],
        "sourceURI": "https://www.bundestag.de/resource/blob/813c4/19203-data.xml",
        "creator": "Deutscher Bundestag",
        "license": "Public Domain",
        "language": "DE-de",
        "originTextID": "9786865",
        "lastChanged": "2021-03-18T03:22+00:00"
      }
    ]
  },
  "links": {
    "self": "https://de.openparliament.tv/api/v1/media/DE-019021012"
  },
  "relationships": {
    "electoralPeriod": {
      "data": {
        "type": "electoralPeriod",
        "id": "DE-019",
        "attributes": {
          "number": 19
        },
        "links": {
          "self": "https://de.openparliament.tv/api/v1/electoralPeriod/DE-019"
        }
      }
    },
    "session": {
      "data": {
        "type": "session",
        "id": "DE-019110",
        "attributes": {
            "number": 110
        },
        "links": {
          "self": "https://de.openparliament.tv/api/v1/session/DE-019110"
        }
      }
    },
    "agendaItem": {
      "data": {
        "type": "agendaItem",
        "id": 3,
        "attributes": {
          "officialTitle": "Tagesordnungspunkt 1",
          "title": "Bundeswehreinsatz in Afghanistan"
        },
        "links": {
          "self": "https://de.openparliament.tv/api/v1/agendaItem/DE-3"
        }
      }
    },
    "documents": {
      "data": [
        {
          "type": "document",
          "id": 201,
          "attributes": {
            "context": null,
            "type": "officialDocument",
            "label": "Drucksache 12/2",
            "labelAlternative": "12/2",
            "thumbnailURI": null
            "thumbnailCreator": null,
            "thumbnailLicense": null,
          },
          "links": {
            "self": "https://de.openparliament.tv/api/v1/document/201"
          }
        }
      ],
      "links": {
        "self": "https://de.openparliament.tv/api/v1/searchAnnotations?mediaID=DE-019021012&type=document"
      }
    },
    "organisations": {
        "data": [
          {
            "type": "organisation",
            "id": "Q356465",
            "attributes": {
              "context": null,
              "type": "party",
              "label": "CDU",
              "alternativeLabel": "Christlich Demokratische Union",
              "thumbnailURI": "https://example.com/thumb.png",
              "thumbnailCreator": "Deutscher Bundestag",
              "thumbnailLicense": "CC-BY-SA",
              "color": "#00ff00"
            },
            "links": {
              "self": "https://de.openparliament.tv/api/v1/organisation/Q356465"
            }
          },
          {
            "type": "organisation",
            "id": "Q45345",
            "attributes": {
              "context": null,
              "type": "faction",
              "label": "CDU/CSU",
              "alternativeLabel": "CDU/CSU Fraktion",
              "thumbnailURI": "https://example.com/thumb.png",
              "thumbnailCreator": "Deutscher Bundestag",
              "thumbnailLicense": "CC-BY-SA",
              "color": "#ff0000"
            },
            "links": {
              "self": "https://de.openparliament.tv/api/v1/organisation/Q45345"
            }
          }
        ],
        "links": {
            "self": "https://de.openparliament.tv/api/v1/searchAnnotations?mediaID=DE-019021012&type=person"
        }
    },
    "people": {
        "data": [
          {
            "type": "person",
            "id": "Q2889",
            "attributes": {
              "context": "speaker",
              "type": "memberOfParliament",
              "label": "Angela Merkel",
              "degree": "Dr.",
              "thumbnailURI": "https://example.com/thumb.png",
              "thumbnailCreator": "Deutscher Bundestag",
              "thumbnailLicense": "CC-BY-SA",
              "party": {
                "id": "Q356465",
                "label": "CDU"
              },
              "faction": {
                "id": "Q45345",
                "label": "CDU/CSU"
              }
            },
            "links": {
              "self": "https://de.openparliament.tv/api/v1/person/Q2889"
            }
          }
        ],
        "links": {
            "self": "https://de.openparliament.tv/api/v1/searchAnnotations?mediaID=DE-019021012&type=person"
        }
    },
    "annotations": {
      "links": {
        "self": "https://de.openparliament.tv/api/v1/searchAnnotations?mediaID=DE-019021012"
      }
    },
    "terms": {
      "links": {
        "self": "https://de.openparliament.tv/api/v1/searchAnnotations?mediaID=DE-019021012&type=terms"
      }
    }
  }
}

2 Person

/api/v1/person/PERSONID

Example Response

"data": {
  "type": "person",
  "id": "Q567",
  "attributes": {
    "type": "memberOfParliament",
    "label": "Angela Merkel",
    "firstName": "Angela",
    "lastName": "Merkel",
    "degree": "Dr.",
    "birthDate": "1954-07-17",
    "gender": "female",
    "abstract": "Bundeskanzlerin der Bundesrepublik Deutschland",
    "thumbnailURI": "https://example.com/image.png",
    "thumbnailCreator": "Deutscher Bundestag",
    "thumbnailLicense": "CC-BY-SA",
    "embedURI": "https://example.com/mobile/Angela_Merkel",
    "websiteURI": "https://www.angela-merkel.de/",
    "originID": "969768675",
    "socialMediaIDs": [
      {
        "label": "Instagram",
        "id": "Merkel"
      }
    ],
    "additionalInformation": {
      "abgeordnetenwatchID": "7643642"
    },
    "lastChanged": "2021-03-18T03:22+00:00"
  },
  "links": {
    "self": "https://de.openparliament.tv/api/v1/person/Q1267"
  },
  "relationships": {
    "party": {
      "data": {
        "type": "organisation",
        "id": "Q53467",
        "attributes": {
          "label": "CDU",
          "labelAlternative": "Christlich Demokratische Union",
          "thumbnailURI": "https://example.com/image.png",
          "thumbnailCreator": "Deutscher Bundestag",
          "thumbnailLicense": "CC-BY-SA",
          "websiteURI": "https://example.com/"
        },
        "links": {
          "self": "https://de.openparliament.tv/api/v1/organisations/Q53467"
        }
      }
    },
    "faction": {
      "data": {
        "type": "organisation",
        "id": "Q98634",
        "attributes": {
          "label": "CDU/CSU",
          "labelAlternative": "CDU/CSU Fraktion",
          "thumbnailURI": "https://example.com/image.png",
          "thumbnailCreator": "Deutscher Bundestag",
          "thumbnailLicense": "CC-BY-SA",
          "websiteURI": "https://example.com/"
        },
        "links": {
          "self": "https://de.openparliament.tv/api/v1/organisations/Q98634"
        }
      }
    },
    "media": {
      "links": {
        "self": "https://de.openparliament.tv/api/v1/searchMedia?personID=Q1267"
      }
    }
  }
}

3 Organisation

/api/v1/organisation/ORGANISATIONID

Example Response

"data": {
  "type": "organisation",
  "id": "Q53467",
  "attributes": {
    "type": "party",
    "label": "CDU",
    "labelAlternative": "Christlich Demokratische Union",
    "abstract": "Partei in Deutschland",
    "thumbnailURI": "https://example.com/image.png",
    "thumbnailCreator": "CDU Deutschland",
    "thumbnailLicense": "CC-BY-SA",
    "embedURI": null,
    "websiteURI": "https://cdu.de",
    "socialMediaIDs": [
      {
        "label": "Twitter",
        "id": "CDU"
      },
      {
        "label": "Facebook",
        "id": "CDU"
      },
      {
        "label": "Instagram",
        "id": "cdu"
      }
    ],
    "color": "#0000ff",
    "additionalInformation": {},
    "lastChanged": "2021-03-18T03:22+00:00"
  },
  "links": {
    "self": "https://de.openparliament.tv/api/v1/organisation/Q53467"
  },
  "relationships": {
    "media": {
      "links": {
        "self": "https://de.openparliament.tv/api/v1/searchMedia?organisationID=Q53467"
      }
    },
    "people": {
      "links": {
        "self": "https://de.openparliament.tv/api/v1/searchPeople?organisationID=Q53467"
      }
    }
  }
}

4 Document

/api/v1/document/DOCUMENTID

Example Response

"data": {
  "type": "document",
  "id": "3",
  "attributes": {
    "type": "officialDocument",
    "wikidataID": null,
    "label": "Drucksache 12/2",
    "labelAlternative": "12/2",
    "abstract": "",
    "thumbnailURI": "https://example.com/image.png",
    "thumbnailCreator": "system",
    "thumbnailLicense": "Public Domain",
    "sourceURI": "https://dserver.bundestag.de/btd/19/000/1900002.pdf"
    "embedURI": null,
    "additionalInformation": {},
    "lastChanged": "2021-03-18T03:22+00:00"
  },
  "links": {
    "self": "https://de.openparliament.tv/api/v1/document/3"
  },
  "relationships": {
    "media": {
      "links": {
        "self": "https://de.openparliament.tv/api/v1/searchMedia?documentID=3"
      }
    }
  }
}

5 Term

/api/v1/term/TERMID

Example Response

"data": {
  "type": "term",
  "id": "165",
  "attributes": {
    "type": null,
    "wikidataID": null,
    "label": "Subsidiaritätsprinzip",
    "labelAlternative": null,
    "abstract": null,
    "thumbnailURI": "https://example.com/image.png",
    "thumbnailCreator": "system",
    "thumbnailLicense": "Public Domain",
    "sourceURI": null,
    "embedURI": null,
    "additionalInformation": {},
    "lastChanged": "2021-03-18T03:22+00:00"
  },
  "links": {
    "self": "https://de.openparliament.tv/api/v1/term/165"
  },
  "relationships": {
    "media": {
      "links": {
        "self": "https://de.openparliament.tv/api/v1/searchMedia?termID=165"
      }
    }
  }
}

6 Electoral Period

/api/v1/electoralPeriod/ELECTORALPERIODID

Example Response

"data": {
  "type": "electoralPeriod",
  "id": "DE-019",
  "attributes": {
    "number": 19,
    "dateStart": "2017-06-21",
    "dateEnd": null,
    "parliament": "DE",
    "parliamentLabel": "Deutscher Bundestag"
  },
  "links": {
    "self": "https://de.openparliament.tv/api/v1/electoralPeriod/DE-019"
  },
  "relationships": {
    "media": {
      "links": {
        "self": "https://de.openparliament.tv/api/v1/searchMedia?electoralPeriodID=DE-019"
      }
    }
  }
}

7 Session

/api/v1/session/SESSIONID

Example Response

"data": {
  "type": "session",
  "id": "DE-0190084",
  "attributes": {
    "number": 84,
    "dateStart": "2017-10-24 09:03:00",
    "dateEnd": "2017-10-24 17:25:00",
    "parliament": "DE",
    "parliamentLabel": "Deutscher Bundestag"
  },
  "links": {
    "self": "https://de.openparliament.tv/api/v1/session/DE-0190084"
  },
  "relationships": {
    "media": {
      "links": {
        "self": "https://de.openparliament.tv/api/v1/searchMedia?sessionID=DE-0190084"
      }
    }
  }
}

8 Agenda Item

/api/v1/agendaItem/AGENDAITEMID

Example Response

"data": {
  "type": "agendaItem",
  "id": 3,
  "attributes": {
    "officialTitle": "Tagesordnungspunkt 1",
    "title": "Bundeswehreinsatz in Afghanistan",
    "order": null,
    "parliament": "DE",
    "parliamentLabel": "Deutscher Bundestag"
  },
  "links": {
    "self": "https://de.openparliament.tv/api/v1/agendaItem/DE-3"
  },
  "relationships": {
    "media": {
      "links": {
        "self": "https://de.openparliament.tv/api/v1/searchMedia?agendaItemID=DE-3"
      }
    }
  }
}