Sign in

v1

latestOpenAPI 3.0.22026-07-17373198641.7 KB
extract
v1

Citation Usage List

GET params:

  • document_id: int
  • text_unit_id: int
  • citation_str: str
  • citation_str_contains: str
  • year_str: str
  • reporter: str
  • court: str
get/api/v1/extract/citation-usage/

Query parameters

jq_filtersobject

Filter params similar to JQWidgets grid filter params: filterscount=1, filterdatafield0="a", filtervalue0="b", filtercondition0="CONTAINS", filteroperator0=1, sortdatafied="c", sortorder="asc"

Response

volumeinteger required
reporterstring required
reporter_full_namestring nullable
pageinteger required
page2string nullable
courtstring nullable
yearinteger nullable
citation_strstring required
countinteger
pkinteger
text_unit__pkstring
text_unit__unit_typestring
text_unit__location_startstring
text_unit__location_endstring
text_unit__document__pkstring
text_unit__document__namestring
text_unit__document__descriptionstring
text_unit__document__document_typestring

Example response

[
  {
    "text_unit__document__description": "text_unit__document__description",
    "year": 4803,
    "text_unit__location_end": "text_unit__location_end",
    "text_unit__document__pk": "text_unit__document__pk",
    "citation_str": "citation_str",
    "count": 413233370,
    "reporter": "reporter",
    "court": "court",
    "text_unit__unit_type": "text_unit__unit_type",
    "text_unit__document__name": "text_unit__document__name",
    "text_unit__document__document_type": "text_unit__document__document_type",
    "volume": 171976544,
    "reporter_full_name": "reporter_full_name",
    "page2": "page2",
    "text_unit__pk": "text_unit__pk",
    "page": 1294386358,
    "pk": 5,
    "text_unit__location_start": "text_unit__location_start"
  }
]