The endpoint for Official & Staffer roles (periods of time in a specific office / job).
Retrieve multiple Roles based on search critera passed as GET Arguments
get/newpersonrole/
Securityapi_key and username
Request
query Parameters
current
boolean
district
integer <int64>
NOTE: Parameter accepts additional qualifiers appended to the end: district__in - The value for the record is in the provided array parameter (comma-separated values). district__gt, district__gte, district__lt, district__lte - The value for the record is greater than/less than (or equal to) the provided parameter. district__isnull - The value for the record is null (if true) or is not null.
district_obj_id
integer <int64>
The district with which this personrole is associated.
NOTE: Parameter accepts additional qualifiers appended to the end: district_obj__in - The value for the record is in the provided array parameter (comma-separated values). district_obj__isnull - The value for the record is null (if true) or is not null.
electcode
integer <int64>
NOTE: Parameter accepts additional qualifiers appended to the end: electcode__in - The value for the record is in the provided array parameter (comma-separated values). electcode__isnull - The value for the record is null (if true) or is not null.
See the Enumeration Documentation CSV file located at Quorum_API_Enumeration_Values.csv, name ElectCode, for an explanation of values.
Enum:12345678
enddate
string <date-time>
NOTE: Parameter accepts additional qualifiers appended to the end: enddate__year, enddate__month, enddate__day - The value for the record matches the provided year/month/day (note that week_day, hour, minute, and second are also available following similar patterns).
id
integer <int64>
Quorum ID (Primary Key)
kw_seat_status
string
NOTE: Parameter accepts additional qualifiers appended to the end: kw_seat_status__in - The value for the record is in the provided array parameter (comma-separated values). kw_seat_status__contains, kw_seat_status__icontains - The value for the record contains the string provided as a parameter within it (partial match). (Use 'icontains' for matching to be done case-insensitive) kw_seat_status__startswith, kw_seat_status__istartswith - The value for the record starts with the string provided as a parameter. (Use 'istartswith' for matching to be done case-insensitive) kw_seat_status__endswith, kw_seat_status__iendswith - The value for the record ends with the string provided as a parameter within it (partial match). (Use 'iendswith' for matching to be done case-insensitive) kw_seat_status__iexact - The value for the record is a case-insensitive exact match to the provided parameter. kw_seat_status__isnull - The value for the record is null (if true) or is not null.
kw_seat_status_code
boolean
lastelection
number <decimal>
NOTE: Parameter accepts additional qualifiers appended to the end: lastelection__in - The value for the record is in the provided array parameter (comma-separated values). lastelection__gt, lastelection__gte, lastelection__lt, lastelection__lte - The value for the record is greater than/less than (or equal to) the provided parameter. lastelection__isnull - The value for the record is null (if true) or is not null.
leadership_title
string
NOTE: Parameter accepts additional qualifiers appended to the end: leadership_title__in - The value for the record is in the provided array parameter (comma-separated values). leadership_title__contains, leadership_title__icontains - The value for the record contains the string provided as a parameter within it (partial match). (Use 'icontains' for matching to be done case-insensitive) leadership_title__startswith, leadership_title__istartswith - The value for the record starts with the string provided as a parameter. (Use 'istartswith' for matching to be done case-insensitive) leadership_title__endswith, leadership_title__iendswith - The value for the record ends with the string provided as a parameter within it (partial match). (Use 'iendswith' for matching to be done case-insensitive) leadership_title__iexact - The value for the record is a case-insensitive exact match to the provided parameter. leadership_title__isnull - The value for the record is null (if true) or is not null.
lower_district_obj_id
integer <int64>
The lowerld with which this personrole is associated.
NOTE: Parameter accepts additional qualifiers appended to the end: lower_district_obj__in - The value for the record is in the provided array parameter (comma-separated values). lower_district_obj__isnull - The value for the record is null (if true) or is not null.
office
string
NOTE: Parameter accepts additional qualifiers appended to the end: office__in - The value for the record is in the provided array parameter (comma-separated values). office__contains, office__icontains - The value for the record contains the string provided as a parameter within it (partial match). (Use 'icontains' for matching to be done case-insensitive) office__startswith, office__istartswith - The value for the record starts with the string provided as a parameter. (Use 'istartswith' for matching to be done case-insensitive) office__endswith, office__iendswith - The value for the record ends with the string provided as a parameter within it (partial match). (Use 'iendswith' for matching to be done case-insensitive) office__iexact - The value for the record is a case-insensitive exact match to the provided parameter. office__isnull - The value for the record is null (if true) or is not null.
party
integer <int64>
NOTE: Parameter accepts additional qualifiers appended to the end: party__in - The value for the record is in the provided array parameter (comma-separated values). party__isnull - The value for the record is null (if true) or is not null.
NOTE: Parameter accepts additional qualifiers appended to the end: party_name__in - The value for the record is in the provided array parameter (comma-separated values). party_name__contains, party_name__icontains - The value for the record contains the string provided as a parameter within it (partial match). (Use 'icontains' for matching to be done case-insensitive) party_name__startswith, party_name__istartswith - The value for the record starts with the string provided as a parameter. (Use 'istartswith' for matching to be done case-insensitive) party_name__endswith, party_name__iendswith - The value for the record ends with the string provided as a parameter within it (partial match). (Use 'iendswith' for matching to be done case-insensitive) party_name__iexact - The value for the record is a case-insensitive exact match to the provided parameter.
person_id
integer <int64>
The newperson with which this personrole is associated.
NOTE: Parameter accepts additional qualifiers appended to the end: person__in - The value for the record is in the provided array parameter (comma-separated values). person__isnull - The value for the record is null (if true) or is not null.
phone
string
NOTE: Parameter accepts additional qualifiers appended to the end: phone__in - The value for the record is in the provided array parameter (comma-separated values). phone__contains, phone__icontains - The value for the record contains the string provided as a parameter within it (partial match). (Use 'icontains' for matching to be done case-insensitive) phone__startswith, phone__istartswith - The value for the record starts with the string provided as a parameter. (Use 'istartswith' for matching to be done case-insensitive) phone__endswith, phone__iendswith - The value for the record ends with the string provided as a parameter within it (partial match). (Use 'iendswith' for matching to be done case-insensitive) phone__iexact - The value for the record is a case-insensitive exact match to the provided parameter. phone__isnull - The value for the record is null (if true) or is not null.
reelectionyear
integer <int64>
NOTE: Parameter accepts additional qualifiers appended to the end: reelectionyear__in - The value for the record is in the provided array parameter (comma-separated values). reelectionyear__gt, reelectionyear__gte, reelectionyear__lt, reelectionyear__lte - The value for the record is greater than/less than (or equal to) the provided parameter. reelectionyear__isnull - The value for the record is null (if true) or is not null.
region
integer <int64>
NOTE: Parameter accepts additional qualifiers appended to the end: region__in - The value for the record is in the provided array parameter (comma-separated values).
NOTE: Parameter accepts additional qualifiers appended to the end: role_type__in - The value for the record is in the provided array parameter (comma-separated values). role_type__isnull - The value for the record is null (if true) or is not null.
See the Enumeration Documentation CSV file located at Quorum_API_Enumeration_Values.csv, name RoleType, for an explanation of values.
Enum:1256789101112212223242526272829303839999
senator_class
integer <int64>
NOTE: Parameter accepts additional qualifiers appended to the end: senator_class__in - The value for the record is in the provided array parameter (comma-separated values). senator_class__isnull - The value for the record is null (if true) or is not null.
See the Enumeration Documentation CSV file located at Quorum_API_Enumeration_Values.csv, name SenatorClass, for an explanation of values.
Enum:123
senator_rank
integer <int64>
NOTE: Parameter accepts additional qualifiers appended to the end: senator_rank__in - The value for the record is in the provided array parameter (comma-separated values). senator_rank__isnull - The value for the record is null (if true) or is not null.
See the Enumeration Documentation CSV file located at Quorum_API_Enumeration_Values.csv, name SenatorRank, for an explanation of values.
Enum:12
startdate
string <date-time>
NOTE: Parameter accepts additional qualifiers appended to the end: startdate__year, startdate__month, startdate__day - The value for the record matches the provided year/month/day (note that week_day, hour, minute, and second are also available following similar patterns).
state
string
NOTE: Parameter accepts additional qualifiers appended to the end: state__in - The value for the record is in the provided array parameter (comma-separated values).
The state with which this personrole is associated.
NOTE: Parameter accepts additional qualifiers appended to the end: state_obj__in - The value for the record is in the provided array parameter (comma-separated values). state_obj__isnull - The value for the record is null (if true) or is not null.
travelviz_latitude
number <decimal>
NOTE: Parameter accepts additional qualifiers appended to the end: travelviz_latitude__in - The value for the record is in the provided array parameter (comma-separated values). travelviz_latitude__gt, travelviz_latitude__gte, travelviz_latitude__lt, travelviz_latitude__lte - The value for the record is greater than/less than (or equal to) the provided parameter. travelviz_latitude__isnull - The value for the record is null (if true) or is not null.
travelviz_longitude
number <decimal>
NOTE: Parameter accepts additional qualifiers appended to the end: travelviz_longitude__in - The value for the record is in the provided array parameter (comma-separated values). travelviz_longitude__gt, travelviz_longitude__gte, travelviz_longitude__lt, travelviz_longitude__lte - The value for the record is greater than/less than (or equal to) the provided parameter. travelviz_longitude__isnull - The value for the record is null (if true) or is not null.
updated
string <date-time>
NOTE: Parameter accepts additional qualifiers appended to the end: updated__year, updated__month, updated__day - The value for the record matches the provided year/month/day (note that week_day, hour, minute, and second are also available following similar patterns).
upper_district_obj_id
integer <int64>
The upperld with which this personrole is associated.
NOTE: Parameter accepts additional qualifiers appended to the end: upper_district_obj__in - The value for the record is in the provided array parameter (comma-separated values). upper_district_obj__isnull - The value for the record is null (if true) or is not null.
website
string
NOTE: Parameter accepts additional qualifiers appended to the end: website__in - The value for the record is in the provided array parameter (comma-separated values). website__contains, website__icontains - The value for the record contains the string provided as a parameter within it (partial match). (Use 'icontains' for matching to be done case-insensitive) website__startswith, website__istartswith - The value for the record starts with the string provided as a parameter. (Use 'istartswith' for matching to be done case-insensitive) website__endswith, website__iendswith - The value for the record ends with the string provided as a parameter within it (partial match). (Use 'iendswith' for matching to be done case-insensitive) website__iexact - The value for the record is a case-insensitive exact match to the provided parameter. website__isnull - The value for the record is null (if true) or is not null.
dehydrate
Array of strings
Option to provide additional detail for certain fields, either by expanding those fields with additional details from the related model or by substituting more informative values for the actual database values. reelectionyear - expand reelectionyear with additional details. resource_uri - expand resource_uri with additional details. NOTE: This parameter can accept one or more comma-separated values; it is not limited to a single value.
Items Enum:"reelectionyear""resource_uri"
limit
integer <int64>
Default: 20
The number of records to return (for pagination).
offset
integer <int64>
Default: 0
The number of records to offset the start of the data being returned (for pagination).
Option to provide additional detail for certain fields, either by expanding those fields with additional details from the related model or by substituting more informative values for the actual database values. reelectionyear - expand reelectionyear with additional details. resource_uri - expand resource_uri with additional details. NOTE: This parameter can accept one or more comma-separated values; it is not limited to a single value.