POST {version}/GetTransactionPeriods
Get Election Periods
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
version | string |
None. |
Body Parameters
QueryName | Description | Type | Additional information |
---|---|---|---|
ActiveOnly | boolean |
None. |
|
Ids | Collection of globally unique identifier |
None. |
Request Formats
application/json, text/json
Sample:
{ "ActiveOnly": true, "Ids": [ "0099e1cb-ff93-410f-af4f-eae5e8e221f5", "c46fdc02-6356-4782-9a86-7f7a92c96eeb" ] }
application/xml, text/xml
Sample:
<Query xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aristotle.CM.Model"> <ActiveOnly>true</ActiveOnly> <Ids xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:guid>0099e1cb-ff93-410f-af4f-eae5e8e221f5</d2p1:guid> <d2p1:guid>c46fdc02-6356-4782-9a86-7f7a92c96eeb</d2p1:guid> </Ids> </Query>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
List of Election Periods
Collection of ElectionPeriodName | Description | Type | Additional information |
---|---|---|---|
GUID | globally unique identifier |
None. |
|
Text | string |
None. |
|
Description | string |
None. |
|
Year | integer |
None. |
|
ElectionDate | date |
None. |
|
ElectionDateLS | string |
None. |
|
Active | boolean |
None. |
|
Default | boolean |
None. |
|
id | string |
None. |
|
itemName | string |
None. |
|
itemName1 | string |
None. |
Response Formats
application/json, text/json
Sample:
[ { "GUID": "596d19bf-d19a-4da4-be1e-5cfdcb3e11c1", "Text": "sample string 2", "Description": "sample string 3", "Year": 4, "ElectionDate": "04/03/2025", "ElectionDateLS": "4/3/2025", "Active": true, "Default": true, "id": "596d19bf-d19a-4da4-be1e-5cfdcb3e11c1", "itemName": "sample string 2 - 4", "itemName1": "4 - sample string 2 (sample string 3)" }, { "GUID": "596d19bf-d19a-4da4-be1e-5cfdcb3e11c1", "Text": "sample string 2", "Description": "sample string 3", "Year": 4, "ElectionDate": "04/03/2025", "ElectionDateLS": "4/3/2025", "Active": true, "Default": true, "id": "596d19bf-d19a-4da4-be1e-5cfdcb3e11c1", "itemName": "sample string 2 - 4", "itemName1": "4 - sample string 2 (sample string 3)" } ]
application/xml, text/xml
Sample:
<ArrayOfElectionPeriod xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aristotle.CM.Model"> <ElectionPeriod> <Active>true</Active> <Default>true</Default> <Description>sample string 3</Description> <ElectionDate>2025-04-03T05:10:52.1108952-04:00</ElectionDate> <GUID>596d19bf-d19a-4da4-be1e-5cfdcb3e11c1</GUID> <Text>sample string 2</Text> <Year>4</Year> </ElectionPeriod> <ElectionPeriod> <Active>true</Active> <Default>true</Default> <Description>sample string 3</Description> <ElectionDate>2025-04-03T05:10:52.1108952-04:00</ElectionDate> <GUID>596d19bf-d19a-4da4-be1e-5cfdcb3e11c1</GUID> <Text>sample string 2</Text> <Year>4</Year> </ElectionPeriod> </ArrayOfElectionPeriod>