Legislation (v1)
Download OpenAPI specification:Download
Handles all high-level Legislation information, including search capabilities
Gets a list of Public Legislation
Authorizations:
header Parameters
WebAPIKey | string Partner WebAPIKey |
Request Body schema: application/json-patch+jsonapplication/json-patch+jsonapplication/jsontext/jsonapplication/*+json
AdvancedSearch
EventControlID | integer or null <int32> Unique identifier for Event Control |
StartDate | string or null <date-time> Start Date associated with status dropdown |
EndDate | string or null <date-time> End Date associated with status dropdown |
EventStartDate | string or null <date-time> End Event Date, associated with Event Control dropdown |
EventEndDate | string or null <date-time> Start Event Date, associated with Event Control dropdown |
IntroductionDate | string or null <date-time> |
LegislationTitle | string or null |
Description | string or null Bill description |
Chambercode | string or null Chamber code (H/S) |
LegislationStatusID | integer or null <int32> Unique identifier for Legislation Status |
LegislationCategoryID | integer or null <int32> Unique identifier for Legislation Category |
CommitteeID | integer or null <int32> Unique identifier for Committee |
SessionID | integer or null <int32> Unique identifier for Session |
SessionCode | integer or null <int32> Session code (e.g. 20181) |
LegislationEventTypeID | integer or null <int32> Unique identifier for Legislation Event Type |
SummaryLength | integer or null <int32> Limitation on summary length |
PatronTypes | Array of integers or null <int32> List of Patron Types |
MemberID | integer or null <int32> Unique identifier for Member |
SubjectIndexID | integer or null <int32> Unique identifier for Subject Index |
MostFrequent | boolean Return most frequently accessed bills? |
IsPending | boolean Return pending bills? |
KeywordExpression | string or null Keyword search - supports operators and parentheses |
KeywordLocation | string or null Where to perform the Keyword search (Summary/Bill Text) |
KeywordSummaryVersionID | integer or null <int32> Unique identifier of Keyword Summary Version |
KeywordLegislationVersionID | integer or null <int32> Unique identifier of Keyword Legislation Version |
KeywordUseGlobalSessionSearch | boolean Should the keyword search search across all sessions? |
SkipLegislationTextCalls | boolean or null Skip searching legislation text? |
CurrentStatus | boolean or null Search by only the current bill status? |
Array of objects or null (KeyWord) List of KeyWord search objects | |
ExcludeFailed | boolean or null |
ChapterNumber | string or null <= 10 characters Chapter Number |
Array of objects or null (LegislationNumberResponse) List of Legislative Numbers | |
Array of objects or null (LegislationID) List of Legislation IDs |
Responses
Request samples
- Payload
{- "EventControlID": 0,
- "StartDate": "2019-08-24T14:15:22Z",
- "EndDate": "2019-08-24T14:15:22Z",
- "EventStartDate": "2019-08-24T14:15:22Z",
- "EventEndDate": "2019-08-24T14:15:22Z",
- "IntroductionDate": "2019-08-24T14:15:22Z",
- "LegislationTitle": "string",
- "Description": "string",
- "Chambercode": "string",
- "LegislationStatusID": 0,
- "LegislationCategoryID": 0,
- "CommitteeID": 0,
- "SessionID": 0,
- "SessionCode": 0,
- "LegislationEventTypeID": 0,
- "SummaryLength": 0,
- "PatronTypes": [
- 0
], - "MemberID": 0,
- "SubjectIndexID": 0,
- "MostFrequent": true,
- "IsPending": true,
- "KeywordExpression": "string",
- "KeywordLocation": "string",
- "KeywordSummaryVersionID": 0,
- "KeywordLegislationVersionID": 0,
- "KeywordUseGlobalSessionSearch": true,
- "SkipLegislationTextCalls": true,
- "CurrentStatus": true,
- "Keywords": [
- {
- "Keyword": "string",
- "Operator": "string",
- "Keywords": [
- { }
]
}
], - "ExcludeFailed": true,
- "ChapterNumber": "string",
- "LegislationNumbers": [
- {
- "LegislationNumber": "string"
}
], - "LegislationIDs": [
- {
- "LegislationId": 0
}
]
}
Response samples
- 200
- 400
{- "Success": true,
- "FailureMessage": "string",
- "CacheKeyName": "string",
- "ListItems": [
- {
- "SessionID": 0,
- "SessionCode": "string",
- "LegislationClassID": 0,
- "LegislationNumber": "string",
- "Description": "string",
- "LegislationTitle": "string",
- "OfferedDate": "2019-08-24T14:15:22Z",
- "IntroductionDate": "2019-08-24T14:15:22Z",
- "ChamberCode": "string",
- "LegislationTypeCode": "string",
- "FullNumber": "string",
- "LegislationStatusID": 0,
- "LegislationID": 0,
- "LegislationKey": 0,
- "LegislationStatus": "string",
- "CandidateDate": "string",
- "LegislationSummary": "string",
- "LegislationTextID": 0,
- "EffectiveType": "string",
- "EffectiveTypeID": 0,
- "PendingChange": true,
- "SummaryVersion": "string",
- "SessionName": "string",
- "CommitteeName": "string",
- "CommitteeID": 0,
- "ParentCommitteeName": "string",
- "ChapterNumber": "string",
- "CommitteeNumber": "string",
- "VersionDate": "string",
- "DocumentCode": "string",
- "Patrons": [
- {
- "LegislationID": 0,
- "LegislationTextID": 0,
- "ChamberCode": "s",
- "MemberID": 0,
- "MemberNumber": "string",
- "PatronTypeID": 0,
- "Name": "string",
- "DisplayName": "string",
- "MemberDisplayName": "string",
- "PatronDisplayName": "string",
- "LegislationNumber": "string",
- "Sequence": 0,
- "IsIntroducing": true,
- "ByRequest": true
}
], - "HousePassageDate": "string",
- "SenatePassageDate": "string",
- "IsComplete": true,
- "Sessions": [
- {
- "SessionID": 0,
- "SessionCode": "string",
- "IsPrefile": true
}
], - "SearchText": [
- {
- "LegislationTextID": 0,
- "Description": "string",
- "DocumentCode": "string",
- "countMatches": 0
}
]
}
], - "SearchCriteria": "string"
}
Gets a list of Public Legislation using unique identifier
Authorizations:
path Parameters
legislationID required | integer <int32> Unique identifier for Legislation |
header Parameters
WebAPIKey | string Partner WebAPIKey |
Responses
Response samples
- 200
- 400
{- "Success": true,
- "FailureMessage": "string",
- "CacheKeyName": "string",
- "ListItems": [
- {
- "SessionID": 0,
- "SessionCode": "string",
- "LegislationClassID": 0,
- "LegislationNumber": "string",
- "Description": "string",
- "LegislationTitle": "string",
- "OfferedDate": "2019-08-24T14:15:22Z",
- "IntroductionDate": "2019-08-24T14:15:22Z",
- "ChamberCode": "string",
- "LegislationTypeCode": "string",
- "FullNumber": "string",
- "LegislationStatusID": 0,
- "LegislationID": 0,
- "LegislationKey": 0,
- "LegislationStatus": "string",
- "CandidateDate": "string",
- "LegislationSummary": "string",
- "LegislationTextID": 0,
- "EffectiveType": "string",
- "EffectiveTypeID": 0,
- "PendingChange": true,
- "SummaryVersion": "string",
- "SessionName": "string",
- "CommitteeName": "string",
- "CommitteeID": 0,
- "ParentCommitteeName": "string",
- "ChapterNumber": "string",
- "CommitteeNumber": "string",
- "VersionDate": "string",
- "DocumentCode": "string",
- "Patrons": [
- {
- "LegislationID": 0,
- "LegislationTextID": 0,
- "ChamberCode": "s",
- "MemberID": 0,
- "MemberNumber": "string",
- "PatronTypeID": 0,
- "Name": "string",
- "DisplayName": "string",
- "MemberDisplayName": "string",
- "PatronDisplayName": "string",
- "LegislationNumber": "string",
- "Sequence": 0,
- "IsIntroducing": true,
- "ByRequest": true
}
], - "HousePassageDate": "string",
- "SenatePassageDate": "string",
- "IsComplete": true,
- "Sessions": [
- {
- "SessionID": 0,
- "SessionCode": "string",
- "IsPrefile": true
}
], - "SearchText": [
- {
- "LegislationTextID": 0,
- "Description": "string",
- "DocumentCode": "string",
- "countMatches": 0
}
]
}
], - "SearchCriteria": "string"
}
Gets a list of Legislation Statuses
Authorizations:
header Parameters
WebAPIKey | string Partner WebAPIKey |
Responses
Response samples
- 200
- 400
{- "Success": true,
- "FailureMessage": "string",
- "CacheKeyName": "string",
- "ListItems": [
- {
- "LegislationStatusID": 0,
- "Name": "string",
- "DisplayName": "string",
- "LegislationVersionID": 0
}
]
}
Gets a list of Public Legislation by Session
Authorizations:
query Parameters
sessionID | integer <int32> Unique identifier for Session |
sessionCode | integer <int32> Session code (eg. 20181) |
header Parameters
WebAPIKey | string Partner WebAPIKey |
Responses
Response samples
- 200
- 400
{- "Success": true,
- "FailureMessage": "string",
- "CacheKeyName": "string",
- "ListItems": [
- {
- "LegislationID": 0,
- "LegislationNumber": "string",
- "Description": "string",
- "ChamberCode": "s",
- "LegislationTypeCode": "s",
- "LegislationKey": 0,
- "LegislationStatus": "string",
- "Patrons": [
- {
- "LegislationID": 0,
- "LegislationTextID": 0,
- "ChamberCode": "s",
- "MemberID": 0,
- "MemberNumber": "string",
- "PatronTypeID": 0,
- "Name": "string",
- "DisplayName": "string",
- "MemberDisplayName": "string",
- "PatronDisplayName": "string",
- "LegislationNumber": "string",
- "Sequence": 0,
- "IsIntroducing": true,
- "ByRequest": true
}
]
}
]
}
Gets a list of Public Legislation with Amendments by Session
Authorizations:
query Parameters
sessionID | integer <int32> Unique identifier for Session |
sessionCode | integer <int32> Session code (eg. 20181) |
chamberCode | string Chamber Code (e.g. H/S) |
header Parameters
WebAPIKey | string Partner WebAPIKey |
Responses
Response samples
- 200
- 400
{- "Success": true,
- "FailureMessage": "string",
- "CacheKeyName": "string",
- "ListItems": [
- {
- "SessionID": 0,
- "SessionCode": "string",
- "LegislationClassID": 0,
- "LegislationNumber": "string",
- "Description": "string",
- "LegislationTitle": "string",
- "OfferedDate": "2019-08-24T14:15:22Z",
- "IntroductionDate": "2019-08-24T14:15:22Z",
- "ChamberCode": "string",
- "LegislationTypeCode": "string",
- "FullNumber": "string",
- "LegislationStatusID": 0,
- "LegislationID": 0,
- "LegislationKey": 0,
- "LegislationStatus": "string",
- "LegislationSummary": "string",
- "LegislationTextID": 0,
- "EffectiveType": "string",
- "EffectiveTypeID": 0,
- "PendingChange": true,
- "SummaryVersion": "string",
- "SessionName": "string",
- "CommitteeName": "string",
- "CommitteeID": 0,
- "ParentCommitteeName": "string",
- "CommitteeNumber": "string",
- "Amendments": [
- {
- "LegislationID": 0,
- "LegislationTextID": 0,
- "LegislationVersionID": 0,
- "LegislationVersion": "string",
- "TextDispositionID": 0,
- "TextDisposition": "string",
- "IsActive": true,
- "IsPublic": true,
- "DocumentCode": "string",
- "ChamberCode": "string",
- "Description": "string",
- "LDNumber": "string",
- "VersionDate": "string"
}
], - "Patrons": [
- {
- "LegislationID": 0,
- "LegislationTextID": 0,
- "ChamberCode": "s",
- "MemberID": 0,
- "MemberNumber": "string",
- "PatronTypeID": 0,
- "Name": "string",
- "DisplayName": "string",
- "MemberDisplayName": "string",
- "PatronDisplayName": "string",
- "Sequence": 0,
- "ByRequest": true
}
]
}
]
}
Gets a list of Legislation IDs
Authorizations:
header Parameters
WebAPIKey | string Partner WebAPIKey |
Request Body schema: application/json-patch+jsonapplication/json-patch+jsonapplication/jsontext/jsonapplication/*+json
AdvancedSearch
EventControlID | integer or null <int32> Unique identifier for Event Control |
StartDate | string or null <date-time> Start Date associated with status dropdown |
EndDate | string or null <date-time> End Date associated with status dropdown |
EventStartDate | string or null <date-time> End Event Date, associated with Event Control dropdown |
EventEndDate | string or null <date-time> Start Event Date, associated with Event Control dropdown |
IntroductionDate | string or null <date-time> |
LegislationTitle | string or null |
Description | string or null Bill description |
Chambercode | string or null Chamber code (H/S) |
LegislationStatusID | integer or null <int32> Unique identifier for Legislation Status |
LegislationCategoryID | integer or null <int32> Unique identifier for Legislation Category |
CommitteeID | integer or null <int32> Unique identifier for Committee |
SessionID | integer or null <int32> Unique identifier for Session |
SessionCode | integer or null <int32> Session code (e.g. 20181) |
LegislationEventTypeID | integer or null <int32> Unique identifier for Legislation Event Type |
SummaryLength | integer or null <int32> Limitation on summary length |
PatronTypes | Array of integers or null <int32> List of Patron Types |
MemberID | integer or null <int32> Unique identifier for Member |
SubjectIndexID | integer or null <int32> Unique identifier for Subject Index |
MostFrequent | boolean Return most frequently accessed bills? |
IsPending | boolean Return pending bills? |
KeywordExpression | string or null Keyword search - supports operators and parentheses |
KeywordLocation | string or null Where to perform the Keyword search (Summary/Bill Text) |
KeywordSummaryVersionID | integer or null <int32> Unique identifier of Keyword Summary Version |
KeywordLegislationVersionID | integer or null <int32> Unique identifier of Keyword Legislation Version |
KeywordUseGlobalSessionSearch | boolean Should the keyword search search across all sessions? |
SkipLegislationTextCalls | boolean or null Skip searching legislation text? |
CurrentStatus | boolean or null Search by only the current bill status? |
Array of objects or null (KeyWord) List of KeyWord search objects | |
ExcludeFailed | boolean or null |
ChapterNumber | string or null <= 10 characters Chapter Number |
Array of objects or null (LegislationNumberResponse) List of Legislative Numbers | |
Array of objects or null (LegislationID) List of Legislation IDs |
Responses
Request samples
- Payload
{- "EventControlID": 0,
- "StartDate": "2019-08-24T14:15:22Z",
- "EndDate": "2019-08-24T14:15:22Z",
- "EventStartDate": "2019-08-24T14:15:22Z",
- "EventEndDate": "2019-08-24T14:15:22Z",
- "IntroductionDate": "2019-08-24T14:15:22Z",
- "LegislationTitle": "string",
- "Description": "string",
- "Chambercode": "string",
- "LegislationStatusID": 0,
- "LegislationCategoryID": 0,
- "CommitteeID": 0,
- "SessionID": 0,
- "SessionCode": 0,
- "LegislationEventTypeID": 0,
- "SummaryLength": 0,
- "PatronTypes": [
- 0
], - "MemberID": 0,
- "SubjectIndexID": 0,
- "MostFrequent": true,
- "IsPending": true,
- "KeywordExpression": "string",
- "KeywordLocation": "string",
- "KeywordSummaryVersionID": 0,
- "KeywordLegislationVersionID": 0,
- "KeywordUseGlobalSessionSearch": true,
- "SkipLegislationTextCalls": true,
- "CurrentStatus": true,
- "Keywords": [
- {
- "Keyword": "string",
- "Operator": "string",
- "Keywords": [
- { }
]
}
], - "ExcludeFailed": true,
- "ChapterNumber": "string",
- "LegislationNumbers": [
- {
- "LegislationNumber": "string"
}
], - "LegislationIDs": [
- {
- "LegislationId": 0
}
]
}
Response samples
- 200
- 400
{- "Success": true,
- "FailureMessage": "string",
- "CacheKeyName": "string",
- "SortBy": "string",
- "DeleteAllLegislationCache": true,
- "LegislationIds": [
- {
- "LegislationID": 0,
- "LegislationStatusID": 0,
- "LegislationNumber": "string",
- "SessionID": 0,
- "SessionCode": 0,
- "SearchText": [
- {
- "LegislationTextID": 0,
- "Description": "string",
- "DocumentCode": "string",
- "countMatches": 0
}
]
}
]
}
Gets a list of Conference Legislation
Authorizations:
query Parameters
sessionID | integer <int32> Unique identifier for Session |
chamberCode | string Chamber Code (e.g. H/S) |
memberID | integer <int32> Unique identifier for Member |
header Parameters
WebAPIKey | string Partner WebAPIKey |
Responses
Response samples
- 200
- 400
{- "Success": true,
- "FailureMessage": "string",
- "CacheKeyName": "string",
- "ListItems": [
- {
- "LegislationID": 0,
- "LegislationNumber": "string",
- "FullNumber": "string",
- "Description": "string",
- "IntroductionDate": "2019-08-24T14:15:22Z",
- "OfferedDate": "2019-08-24T14:15:22Z",
- "ChamberCode": "string",
- "LegislationTypeCode": "string",
- "LegislationClassID": 0,
- "LegislationClass": "string",
- "LegislationKey": 0,
- "LegislationStatus": "string",
- "EffectiveType": "string",
- "SessionID": 0,
- "SessionName": "string",
- "IsPrefile": true
}
]
}
Gets a list of Legislation based on set of Legislation IDs
Authorizations:
header Parameters
WebAPIKey | string Partner WebAPIKey |
Request Body schema: application/json-patch+jsonapplication/json-patch+jsonapplication/jsontext/jsonapplication/*+json
LegislationIdsListResponse
Success | boolean Is this a successful response? |
FailureMessage | string or null Details if this response failed |
CacheKeyName | string or null CacheKey name |
SortBy | string or null Which column to sort legislation by |
DeleteAllLegislationCache | boolean or null Should delete from cache all legislation? |
Array of objects or null (LegislationIdListResponse) List of Legislation IDs |
Responses
Request samples
- Payload
{- "Success": true,
- "FailureMessage": "string",
- "CacheKeyName": "string",
- "SortBy": "string",
- "DeleteAllLegislationCache": true,
- "LegislationIds": [
- {
- "LegislationID": 0,
- "LegislationStatusID": 0,
- "LegislationNumber": "string",
- "SessionID": 0,
- "SessionCode": 0,
- "SearchText": [
- {
- "LegislationTextID": 0,
- "Description": "string",
- "DocumentCode": "string",
- "countMatches": 0
}
]
}
]
}
Response samples
- 200
- 400
{- "Success": true,
- "FailureMessage": "string",
- "CacheKeyName": "string",
- "ListItems": [
- {
- "SessionID": 0,
- "SessionCode": "string",
- "LegislationClassID": 0,
- "LegislationNumber": "string",
- "Description": "string",
- "LegislationTitle": "string",
- "OfferedDate": "2019-08-24T14:15:22Z",
- "IntroductionDate": "2019-08-24T14:15:22Z",
- "ChamberCode": "string",
- "LegislationTypeCode": "string",
- "FullNumber": "string",
- "LegislationStatusID": 0,
- "LegislationID": 0,
- "LegislationKey": 0,
- "LegislationStatus": "string",
- "CandidateDate": "string",
- "LegislationSummary": "string",
- "LegislationTextID": 0,
- "EffectiveType": "string",
- "EffectiveTypeID": 0,
- "PendingChange": true,
- "SummaryVersion": "string",
- "SessionName": "string",
- "CommitteeName": "string",
- "CommitteeID": 0,
- "ParentCommitteeName": "string",
- "ChapterNumber": "string",
- "CommitteeNumber": "string",
- "VersionDate": "string",
- "DocumentCode": "string",
- "Patrons": [
- {
- "LegislationID": 0,
- "LegislationTextID": 0,
- "ChamberCode": "s",
- "MemberID": 0,
- "MemberNumber": "string",
- "PatronTypeID": 0,
- "Name": "string",
- "DisplayName": "string",
- "MemberDisplayName": "string",
- "PatronDisplayName": "string",
- "LegislationNumber": "string",
- "Sequence": 0,
- "IsIntroducing": true,
- "ByRequest": true
}
], - "HousePassageDate": "string",
- "SenatePassageDate": "string",
- "IsComplete": true,
- "Sessions": [
- {
- "SessionID": 0,
- "SessionCode": "string",
- "IsPrefile": true
}
], - "SearchText": [
- {
- "LegislationTextID": 0,
- "Description": "string",
- "DocumentCode": "string",
- "countMatches": 0
}
]
}
], - "SearchCriteria": "string"
}
Gets telemetry on service health
Authorizations:
header Parameters
WebAPIKey | string Partner WebAPIKey |
Responses
Response samples
- 200
- 400
{- "User": "string",
- "DateTime": "string",
- "Environment": "string",
- "ActionName": "string",
- "Service": "string",
- "Success": true,
- "FailureMessage": "string"
}