POST {version}/GetTransactionPeriods

Get Election Periods

Request Information

URI Parameters

NameDescriptionTypeAdditional information
version

string

None.

Body Parameters

Query
NameDescriptionTypeAdditional information
ActiveOnly

boolean

None.

Ids

Collection of globally unique identifier

None.

Request Formats

application/json, text/json

Sample:
{
  "ActiveOnly": true,
  "Ids": [
    "788a9eaa-9e78-4361-9f8e-54bf16e19424",
    "99d004d7-c26a-4aff-85a9-ee52533515e6"
  ]
}

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>788a9eaa-9e78-4361-9f8e-54bf16e19424</d2p1:guid>
    <d2p1:guid>99d004d7-c26a-4aff-85a9-ee52533515e6</d2p1:guid>
  </Ids>
</Query>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

List of Election Periods

Collection of ElectionPeriod
NameDescriptionTypeAdditional 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": "664bb473-b65c-446e-96c5-b72dd2757279",
    "Text": "sample string 2",
    "Description": "sample string 3",
    "Year": 4,
    "ElectionDate": "10/16/2024",
    "ElectionDateLS": "10/16/2024",
    "Active": true,
    "Default": true,
    "id": "664bb473-b65c-446e-96c5-b72dd2757279",
    "itemName": "sample string 2 - 4",
    "itemName1": "4 - sample string 2 (sample string 3)"
  },
  {
    "GUID": "664bb473-b65c-446e-96c5-b72dd2757279",
    "Text": "sample string 2",
    "Description": "sample string 3",
    "Year": 4,
    "ElectionDate": "10/16/2024",
    "ElectionDateLS": "10/16/2024",
    "Active": true,
    "Default": true,
    "id": "664bb473-b65c-446e-96c5-b72dd2757279",
    "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>2024-10-16T12:27:09.1322019-04:00</ElectionDate>
    <GUID>664bb473-b65c-446e-96c5-b72dd2757279</GUID>
    <Text>sample string 2</Text>
    <Year>4</Year>
  </ElectionPeriod>
  <ElectionPeriod>
    <Active>true</Active>
    <Default>true</Default>
    <Description>sample string 3</Description>
    <ElectionDate>2024-10-16T12:27:09.1322019-04:00</ElectionDate>
    <GUID>664bb473-b65c-446e-96c5-b72dd2757279</GUID>
    <Text>sample string 2</Text>
    <Year>4</Year>
  </ElectionPeriod>
</ArrayOfElectionPeriod>