Powered by Redocly

Legislative Stance

The endpoint for managing your organization's stance (Support, Oppose, Neutral, etc.) on a piece of legislation. Stances may be associated with a bill, amendment, vote, regulation, document, docket, project, or article.

Creating or updating a stance (POST): the following fields are required on every POST:

  • data_type — the QuorumDataType value describing what the stance is for (e.g. 2 for bill, 3 for vote, 4 for amendment). This disambiguates which related object the stance points to.
  • organization — the URI of the organization the stance belongs to (e.g. /api/organization/1/).
  • last_user — the URI of the API user recording the stance (e.g. /api/user/1/).
You must also include the resource URI for the object the stance is about — bill, amendment, vote, regulation, etc. — matching the data_type. The correct related-object field for a given data_type is that type's related_field.

A POST missing any of these required fields returns HTTP 422.

If a stance already exists for the same (organization, related_object) pair, the POST is treated as an update for stance, archived, and last_user — you do not need to look up the existing record first.

Retrieve multiple Legislative Stances based on search criteria passed as GET arguments

get/legislativestance/
Securityapi_key and username
Request
query Parameters
amendment_id
integer <int64>

The newamendment with which this legislativestance is associated.

NOTE: Parameter accepts additional qualifiers appended to the end:
amendment__in - The value for the record is in the provided array parameter (comma-separated values).
amendment__isnull - The value for the record is null (if true) or is not null.

archived
boolean
article
integer <int64>

NOTE: Parameter accepts additional qualifiers appended to the end:
article__in - The value for the record is in the provided array parameter (comma-separated values).
article__gt, article__gte, article__lt, article__lte - The value for the record is greater than/less than (or equal to) the provided parameter.
article__isnull - The value for the record is null (if true) or is not null.

bill_id
integer <int64>

The newbill with which this legislativestance is associated.

NOTE: Parameter accepts additional qualifiers appended to the end:
bill__in - The value for the record is in the provided array parameter (comma-separated values).
bill__isnull - The value for the record is null (if true) or is not null.

docket_id
integer <int64>

The docket with which this legislativestance is associated.

NOTE: Parameter accepts additional qualifiers appended to the end:
docket__in - The value for the record is in the provided array parameter (comma-separated values).
docket__isnull - The value for the record is null (if true) or is not null.

document_id
integer <int64>

The newdocument with which this legislativestance is associated.

NOTE: Parameter accepts additional qualifiers appended to the end:
document__in - The value for the record is in the provided array parameter (comma-separated values).
document__isnull - The value for the record is null (if true) or is not null.

id
integer <int64>

Quorum ID (Primary Key)

project_id
integer <int64>

The project with which this legislativestance is associated.

NOTE: Parameter accepts additional qualifiers appended to the end:
project__in - The value for the record is in the provided array parameter (comma-separated values).
project__isnull - The value for the record is null (if true) or is not null.

regulation_id
integer <int64>

The regulation with which this legislativestance is associated.

NOTE: Parameter accepts additional qualifiers appended to the end:
regulation__in - The value for the record is in the provided array parameter (comma-separated values).
regulation__isnull - The value for the record is null (if true) or is not null.

stance
integer <int64>

NOTE: Parameter accepts additional qualifiers appended to the end:
stance__in - The value for the record is in the provided array parameter (comma-separated values).

See the Enumeration Documentation CSV file located at Quorum_API_Enumeration_Values.csv, name LegislativeStanceType, for an explanation of values.

Enum: 0 1 2 3 4
vote_id
integer <int64>

The vote with which this legislativestance is associated.

NOTE: Parameter accepts additional qualifiers appended to the end:
vote__in - The value for the record is in the provided array parameter (comma-separated values).
vote__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.
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 Value: "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).

Responses
200

LegislativeStance retrieved successfully

400

improperly configured request

401

authorization failure

500

internal server error

Response samples
application/json
{
  • "_extra": { },
  • "amendment": "/api/newamendment/1/",
  • "amendment_id": "/api/newamendment/1/",
  • "archived": false,
  • "article": 0,
  • "bill": "/api/newbill/1/",
  • "bill_id": "/api/newbill/1/",
  • "created": "2019-08-24T14:15:22Z",
  • "data_type": 2,
  • "docket": "/api/regulationdocket/1/",
  • "document": "/api/newdocument/1/",
  • "document_id": "/api/newdocument/1/",
  • "id": 0,
  • "last_user": "/api/user/1/",
  • "organization": "/api/organization/1/",
  • "project": "/api/project/1/",
  • "regulation": "/api/regulation/1/",
  • "resource_uri": "string",
  • "stance": 0,
  • "stance_type": 1,
  • "updated": "2019-08-24T14:15:22Z",
  • "vote": "/api/vote/1/",
  • "vote_id": "/api/vote/1/"
}

Create a single Legislative Stance

post/legislativestance/
Securityapi_key and username
Request
path Parameters
id
required
integer <int64>

Quorum ID (Primary Key)

Request Body schema: application/json
archived
boolean
last_user_id
string <{"id": QUORUM_ID}>

The quorumuser with which this legislativestance is associated.

stance
integer <int64>

See the Enumeration Documentation CSV file located at Quorum_API_Enumeration_Values.csv, name LegislativeStanceType, for an explanation of values.

Enum: 0 1 2 3 4
Responses
200

LegislativeStance retrieved successfully

400

improperly configured request

401

authorization failure

500

internal server error

Request samples
application/json
{
  • "archived": true,
  • "last_user_id": "string",
  • "stance": 0
}
Response samples
application/json
{
  • "_extra": { },
  • "amendment": "/api/newamendment/1/",
  • "amendment_id": "/api/newamendment/1/",
  • "archived": false,
  • "article": 0,
  • "bill": "/api/newbill/1/",
  • "bill_id": "/api/newbill/1/",
  • "created": "2019-08-24T14:15:22Z",
  • "data_type": 2,
  • "docket": "/api/regulationdocket/1/",
  • "document": "/api/newdocument/1/",
  • "document_id": "/api/newdocument/1/",
  • "id": 0,
  • "last_user": "/api/user/1/",
  • "organization": "/api/organization/1/",
  • "project": "/api/project/1/",
  • "regulation": "/api/regulation/1/",
  • "resource_uri": "string",
  • "stance": 0,
  • "stance_type": 1,
  • "updated": "2019-08-24T14:15:22Z",
  • "vote": "/api/vote/1/",
  • "vote_id": "/api/vote/1/"
}

Retrieve a single Legislative Stance by ID

get/legislativestance/{id}/
Securityapi_key and username
Request
path Parameters
id
required
integer <int64>

Quorum ID (Primary Key)

query Parameters
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.
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 Value: "resource_uri"
Responses
200

LegislativeStance retrieved successfully

400

improperly configured request

401

authorization failure

500

internal server error

Response samples
application/json
{
  • "_extra": { },
  • "amendment": "/api/newamendment/1/",
  • "amendment_id": "/api/newamendment/1/",
  • "archived": false,
  • "article": 0,
  • "bill": "/api/newbill/1/",
  • "bill_id": "/api/newbill/1/",
  • "created": "2019-08-24T14:15:22Z",
  • "data_type": 2,
  • "docket": "/api/regulationdocket/1/",
  • "document": "/api/newdocument/1/",
  • "document_id": "/api/newdocument/1/",
  • "id": 0,
  • "last_user": "/api/user/1/",
  • "organization": "/api/organization/1/",
  • "project": "/api/project/1/",
  • "regulation": "/api/regulation/1/",
  • "resource_uri": "string",
  • "stance": 0,
  • "stance_type": 1,
  • "updated": "2019-08-24T14:15:22Z",
  • "vote": "/api/vote/1/",
  • "vote_id": "/api/vote/1/"
}

Update a single Legislative Stance by ID

patch/legislativestance/{id}/
Securityapi_key and username
Request
path Parameters
id
required
integer <int64>

Quorum ID (Primary Key)

Request Body schema: application/json
archived
boolean
last_user_id
string <{"id": QUORUM_ID}>

The quorumuser with which this legislativestance is associated.

stance
integer <int64>

See the Enumeration Documentation CSV file located at Quorum_API_Enumeration_Values.csv, name LegislativeStanceType, for an explanation of values.

Enum: 0 1 2 3 4
Responses
200

LegislativeStance retrieved successfully

400

improperly configured request

401

authorization failure

500

internal server error

Request samples
application/json
{
  • "archived": true,
  • "last_user_id": "string",
  • "stance": 0
}
Response samples
application/json
{
  • "_extra": { },
  • "amendment": "/api/newamendment/1/",
  • "amendment_id": "/api/newamendment/1/",
  • "archived": false,
  • "article": 0,
  • "bill": "/api/newbill/1/",
  • "bill_id": "/api/newbill/1/",
  • "created": "2019-08-24T14:15:22Z",
  • "data_type": 2,
  • "docket": "/api/regulationdocket/1/",
  • "document": "/api/newdocument/1/",
  • "document_id": "/api/newdocument/1/",
  • "id": 0,
  • "last_user": "/api/user/1/",
  • "organization": "/api/organization/1/",
  • "project": "/api/project/1/",
  • "regulation": "/api/regulation/1/",
  • "resource_uri": "string",
  • "stance": 0,
  • "stance_type": 1,
  • "updated": "2019-08-24T14:15:22Z",
  • "vote": "/api/vote/1/",
  • "vote_id": "/api/vote/1/"
}
➔ Next to Organization