ContestingParties

Returns contesting parties

APIDescription
GET api/v1/ContestingParties?ElectoralEventID={ElectoralEventID}

Return a list of Contesting Parties for specific Electoral Event

GET api/ContestingParties/ElectoralEventID/{ElectoralEventID}

Return a list of Contesting Parties for specific Electoral Event

GET api/v1/ContestingParties?ElectoralEventID={ElectoralEventID}&ProvinceID={ProvinceID}

Return a list of Contesting Parties for specific Electoral Event and Province

GET api/ContestingParties/ElectoralEventID/{ElectoralEventID}/ProvinceID/{ProvinceID}

Return a list of Contesting Parties for specific Electoral Event and Province

GET api/v1/ContestingParties?ElectoralEventID={ElectoralEventID}&ProvinceID={ProvinceID}&MunicipalityID={MunicipalityID}

Return a list of Contesting Parties for specific Electoral Event and Province and Municipality

GET api/ContestingParties/ElectoralEventID/{ElectoralEventID}/ProvinceID/{ProvinceID}/MunicipalityID/{MunicipalityID}

Return a list of Contesting Parties for specific Electoral Event and Province and Municipality

Voters

Returns voter information

APIDescription
GET api/Voters/IDNumber/{ID}

Returns the registration details for a voter using ID Number

GET api/Voters/VoterId/{VoterId}

Returns the registration details for a voter using voter id

GET api/v1/Voters/GetVoterAllDetails?ID={ID}

Returns the registration details for a voter including all associated data

GET api/Voters/VoterAllDetails/IDNumber/{ID}

Returns the registration details for a voter including all associated data

GET api/Voters/VoterAllDetails/VoterId/{VoterId}

Returns voter details by voter id

GET api/v1/Voters/GetVoterExt?ID={ID}

Returns extended registration details for a voter by ID Number

GET api/Voters/VoterExt/IDNumber/{ID}

Returns extended registration details for a voter by ID Number

GET api/Voters/VoterExt/VoterId/{VoterId}

Returns extended voter details by voter id

GET api/v1/Voters/GetVoterAllDetailsExt?ID={ID}

Returns extended registration details for a voter including all associated data

GET api/Voters/VoterAllDetailsExt/IDNumber/{ID}

Returns extended registration details for a voter including all associated data

GET api/Voters/VoterAllDetailsExt/VoterId/{VoterId}

Return voter details by voter id

GET api/v1/VoterStatus?ID={ID}

Returns voter registration status

GET api/Voters/VoterStatus/IDNumber/{ID}

Returns voter registration status

GET api/v1/Voters/{ID}

Observer

APIDescription
GET api/ORS/GetActiveEvent

Return active Event

GET api/ORS/IsAdministrator/{eventId}/{email}

Return whether the email passed in is an IEC administrator

GET api/ORS/GetList/id/{requestorIdNumber}

Return a list of all Approved Observer Applications

GET api/ORS/GetList/id/{requestorIdNumber}/observerid/{observerId}

Get the detail of an Observer linked to an Application

GET api/ORS/GetList/observerid/{observerId}

Verify if a person with a specifc ID/Passport has been registered already

LGESeatCalculationResults

LGE Seat calculation

APIDescription
GET api/v1/LGESeatCalculationResults?ElectoralEventID={ElectoralEventID}&MunicipalityID={MunicipalityID}

Get LGE Ballot results for an electoral event and municipality

GET api/LGESeatCalculationResults/ElectoralEventID/{ElectoralEventID}/MunicipalityID/{MunicipalityID}

Get LGE Ballot results for an electoral event and municipality

Delimitation

Returns regions

APIDescription
GET api/v1/Delimitation?ElectoralEventID={ElectoralEventID}

Returns list of all Provinces for the specified Electoral Event ID

GET api/Delimitation/ElectoralEventID/{ElectoralEventID}

Returns list of all Provinces for the specified Electoral Event ID

GET api/v1/Delimitation?ElectoralEventID={ElectoralEventID}&ProvinceID={ProvinceID}

Returns all the municipalities for the specified province

GET api/Delimitation/ElectoralEventID/{ElectoralEventID}/ProvinceID/{ProvinceID}

Returns all the municipalities for the specified province

GET api/v1/Delimitation?ElectoralEventID={ElectoralEventID}&ProvinceID={ProvinceID}&MunicipalityID={MunicipalityID}

Returns all the wards for the specified province and municipality

GET api/Delimitation/ElectoralEventID/{ElectoralEventID}/ProvinceID/{ProvinceID}/MunicipalityID/{MunicipalityID}

Returns all the wards for the specified province and municipality

GET api/v1/Delimitation?ElectoralEventID={ElectoralEventID}&ProvinceID={ProvinceID}&MunicipalityID={MunicipalityID}&WardID={WardID}

Returns a list of voting districts for the specified province, municipality and ward

GET api/Delimitation/ElectoralEventID/{ElectoralEventID}/ProvinceID/{ProvinceID}/MunicipalityID/{MunicipalityID}/WardID/{WardID}

Returns a list of voting districts for the specified province, municipality and ward

GET api/v1/Delimitation?Latitude={Latitude}&Longitude={Longitude}

Returns the delimitation based on Geographic Coordinates

GET api/Delimitation/Latitude/{Latitude}/Longitude/{Longitude}

Returns the delimitation based on Geographic Coordinates

NPESeatCalculationResults

NPE Seat calculation

APIDescription
GET api/v1/NPESeatCalculationResults?ElectoralEventID={ElectoralEventID}

Get Seat Calculation Results on National Level

GET api/NPESeatCalculationResults/ElectoralEventID/{ElectoralEventID}

Get Seat Calculation Results on National Level

GET api/v1/NPESeatCalculationResults?ElectoralEventID={ElectoralEventID}&ProvinceID={ProvinceID}

Get Seat Calculation Results on Provincial Level

GET api/NPESeatCalculationResults/ElectoralEventID/{ElectoralEventID}/ProvinceID/{ProvinceID}

Get Seat Calculation Results on Provincial Level

LGECandidates

LGE Candidates

APIDescription
GET api/v1/LGECandidates?ElectoralEventID={ElectoralEventID}&WardID={WardID}

Get LGE ward candidates for an electoral event and ward

GET api/LGECandidates/ElectoralEventID/{ElectoralEventID}/WardID/{WardID}

Get LGE ward candidates for an electoral event and ward

GET api/v1/LGECandidates?ElectoralEventID={ElectoralEventID}&MunicipalityID={MunicipalityID}

Get LGE ward candidates for an electoral event and municipality

GET api/LGECandidates/ElectoralEventID/{ElectoralEventID}/MunicipalityID/{MunicipalityID}

Get LGE ward candidates for an electoral event and municipality

NPECandidates

NPE Candidates

APIDescription
GET api/v1/NPECandidates?ElectoralEventID={ElectoralEventID}&PartyID={PartyID}

Get National Candidates for a specific party and electoral event

GET api/NPECandidates/ElectoralEventID/{ElectoralEventID}/PartyID/{PartyID}

Get National Candidates for a specific party and electoral event

GET api/v1/NPECandidates?ElectoralEventID={ElectoralEventID}&ProvinceID={ProvinceID}&PartyID={PartyID}

Get Provincial Candidates for a specific party and electoral event

GET api/NPECandidates/ElectoralEventID/{ElectoralEventID}/ProvinceID/{ProvinceID}/PartyID/{PartyID}

Get Provincial Candidates for a specific party and electoral event

LGEWardCouncilor

LGE Ward Council

APIDescription
GET api/LGEWardCouncilor/WardID/{WardID}

Returns the ward Councilor for the specified ward

GET api/LGEWardCouncilor/IDNumber/{ID}

Returns the ward Councilor for the specified voter

GET api/LGEWardCouncilor/VoterId/{VoterId}

Returns the ward Councilor for the specified voter by voter id

GET api/LGEWardCouncilor/Latitude/{Latitude}/Longitude/{Longitude}

Returns the ward Councilor for the specified GPS coordinates

GET api/v1/CouncilorsByEvent?ElectoralEventID={ElectoralEventID}

Returns the ward Councilors for the specified Event

GET api/v1/LGEWardCouncilor?WardID={WardID}

Returns the ward Councilor for the specified ward

GET api/v1/LGEWardCouncilor/{ID}

Returns the ward Councilor for the specified voter

GET api/v1/LGEWardCouncilor?Latitude={Latitude}&Longitude={Longitude}

Returns the ward Councilor for the specified GPS coordinates

ElectoralEvent

Return electoral event

APIDescription
GET api/v1/ElectoralEvent

Returns a list of Electoral Event types and their IDs

GET api/ElectoralEvent

Returns a list of Electoral Event types and their IDs

GET api/v1/ElectoralEvent?ElectoralEventTypeID={ElectoralEventTypeID}&ParentEventID={ParentEventID}

Returns list of all Electoral Event Types for the specified Electoral Event Type

GET api/ElectoralEvent/ElectoralEventTypeID/{ElectoralEventTypeID}?ParentEventID={ParentEventID}

Returns list of all Electoral Event Types for the specified Electoral Event Type

GET api/ElectoralEvent/ElectoralEventTypeID/{ElectoralEventTypeID}/ParentEventID/{ParentEventID}

Returns list of all Electoral Event Types for the specified Electoral Event Type

ByElectionCandidates

APIDescription
GET api/v1/ByElectionCandidates?ElectoralEventID={ElectoralEventID}&MunicipalityID={MunicipalityID}&PartyID={PartyID}

Get By-Election PR List Candidates

GET api/ByElectionCandidates/ElectoralEventID/{ElectoralEventID}/MunicipalityID/{MunicipalityID}/PartyID/{PartyID}

Get By-Election PR List Candidates

GET api/v1/ByElectionCandidates?ElectoralEventID={ElectoralEventID}&MunicipalityID={MunicipalityID}&WardID={WardID}

Get By-Election Ward Contestants

GET api/ByElectionCandidates/ElectoralEventID/{ElectoralEventID}/MunicipalityID/{MunicipalityID}?WardID={WardID}

Get By-Election Ward Contestants

GET api/ByElectionCandidates/ElectoralEventID/{ElectoralEventID}/MunicipalityID/{MunicipalityID}/WardID/{WardID}

Get By-Election Ward Contestants

GET api/ByElectionMunicWard/ElectoralEventID/{ElectoralEventID}/MunicipalityID/{MunicipalityID}?WardID={WardID}

Get By-Election Municipality and Ward Details

GET api/ByElectionMunicWard/ElectoralEventID/{ElectoralEventID}/MunicipalityID/{MunicipalityID}/WardID/{WardID}

Get By-Election Municipality and Ward Details

GET api/v1/ByElectionCandidatesByEvent?ElectoralEventID={ElectoralEventID}

Get By-Election List Candidates

GET api/ByElectionCandidates/ElectoralEventID/{ElectoralEventID}

Get By-Election List Candidates

NPESeatAllocationResults

NPE Seat Allocation Results

APIDescription
GET api/v1/NPESeatAllocationResults?ElectoralEventID={ElectoralEventID}&PartyID={PartyID}

Get Party Seat Allocation on National level

GET api/NPESeatAllocationResults/ElectoralEventID/{ElectoralEventID}/PartyID/{PartyID}

Get Party Seat Allocation on National level

GET api/v1/NPESeatAllocationResults?ElectoralEventID={ElectoralEventID}&ProvinceID={ProvinceID}&PartyID={PartyID}

Get Party Seat Allocation on Provincial level

GET api/NPESeatAllocationResults/ElectoralEventID/{ElectoralEventID}/ProvinceID/{ProvinceID}/PartyID/{PartyID}

Get Party Seat Allocation on Provincial level

VotingStationDetails

Returns voting station details

APIDescription
GET api/v1/VotingStationDetails?Latitude={Latitude}&Longitude={Longitude}

Details for a voting station based on a GPS coordinate location

GET api/VotingStationDetails/GetVotingStationDetailsByLocation?Latitude={Latitude}&Longitude={Longitude}

Details for a voting station based on a GPS coordinate location

GET api/v1/VotingStationDetails?VDNumber={VDNumber}

Details for a voting station based on the voting district

GET api/VotingStationDetails/GetVotingStationDetailsByVD?VDNumber={VDNumber}

Details for a voting station based on the voting district

GET api/v1/VotingStations?ElectoralEventID={ElectoralEventID}

Details for a voting station list base on event

GET api/VotingStations/GetVotingStationsByEvent?ElectoralEventID={ElectoralEventID}

Details for a voting station list base on event

FAQ

Returns Frequently Asked Questions

APIDescription
GET api/v1/FAQ

List of all FAQs. Category Voters

GET api/FAQ

List of all FAQs. Category Voters

GET api/v1/FAQ?CategoryID={CategoryID}

List of all FAQs by Category specified.

GET api/FAQ/CategoryID/{CategoryID}

List of all FAQs by Category specified.

GET api/v1/FAQ/GetFAQCategories

List of FAQ Categories

GET api/FAQ/Categories

List of FAQ Categories

ResultsProgress

Returns Seat Calculation Completed, Voting District Results In and Voting District Total

APIDescription
GET api/v1/ResultsProgress?ElectoralEventID={ElectoralEventID}

Returns Seat Calculation Completed, Voting District Results In and Voting District Total for specified Electoral Event ID

GET api/ResultsProgress/ElectoralEventID/{ElectoralEventID}

Returns Seat Calculation Completed, Voting District Results In and Voting District Total for specified Electoral Event ID

GET api/v1/ResultsProgress?ElectoralEventID={ElectoralEventID}&ProvinceID={ProvinceID}

Returns Seat Calculation Completed, Voting District Results In and Voting District Total for specified Electoral Event ID and Province ID

GET api/ResultsProgress/ElectoralEventID/{ElectoralEventID}/ProvinceID/{ProvinceID}

Returns Seat Calculation Completed, Voting District Results In and Voting District Total for specified Electoral Event ID and Province ID

GET api/v1/ResultsProgress?ElectoralEventID={ElectoralEventID}&ProvinceID={ProvinceID}&MunicipalityID={MunicipalityID}

Returns Seat Calculation Completed, Voting District Results In and Voting District Total for specified Electoral Event ID, Province ID and Municipality ID

GET api/ResultsProgress/ElectoralEventID/{ElectoralEventID}/ProvinceID/{ProvinceID}/MunicipalityID/{MunicipalityID}

Returns Seat Calculation Completed, Voting District Results In and Voting District Total for specified Electoral Event ID, Province ID and Municipality ID

GET api/v1/ResultsProgress?ElectoralEventID={ElectoralEventID}&ProvinceID={ProvinceID}&MunicipalityID={MunicipalityID}&WardID={WardID}

Returns Seat Calculation Completed, Voting District Results In and Voting District Total for specified Electoral Event ID, Province ID, Municipality ID and Ward ID

GET api/ResultsProgress/ElectoralEventID/{ElectoralEventID}/ProvinceID/{ProvinceID}/MunicipalityID/{MunicipalityID}/WardID/{WardID}

Returns Seat Calculation Completed, Voting District Results In and Voting District Total for specified Electoral Event ID, Province ID, Municipality ID and Ward ID

NPEBallotResults

NPE Ballot resuls

APIDescription
GET api/v1/NPEBallotResults?ElectoralEventID={ElectoralEventID}

Returns rolled up results for the National Election

GET api/NPEBallotResults/ElectoralEventID/{ElectoralEventID}

Returns rolled up results for the National Election

GET api/v1/NPEBallotResults?ElectoralEventID={ElectoralEventID}&ProvinceID={ProvinceID}

Returns rolled up results for the National Election for specified Province

GET api/NPEBallotResults/ElectoralEventID/{ElectoralEventID}/ProvinceID/{ProvinceID}

Returns rolled up results for the National Election for specified Province

GET api/v1/NPEBallotResults?ElectoralEventID={ElectoralEventID}&ProvinceID={ProvinceID}&MunicipalityID={MunicipalityID}

Returns rolled up results for the National Election for Province and Municipality

GET api/NPEBallotResults/ElectoralEventID/{ElectoralEventID}/ProvinceID/{ProvinceID}/MunicipalityID/{MunicipalityID}

Returns rolled up results for the National Election for Province and Municipality

GET api/v1/NPEBallotResults?ElectoralEventID={ElectoralEventID}&ProvinceID={ProvinceID}&MunicipalityID={MunicipalityID}&VDNumber={VDNumber}

Returns rolled up results for the National Election for Specified Province, Municipality and Voting District

GET api/NPEBallotResults/ElectoralEventID/{ElectoralEventID}/ProvinceID/{ProvinceID}/MunicipalityID/{MunicipalityID}/VDNumber/{VDNumber}

Returns rolled up results for the National Election for Specified Province, Municipality and Voting District

SpecialVotes

SpecialVotes Endpoints

APIDescription
GET api/SpecialVotes/UpComingSpecialVotes

Returns a list of UpComing Special Votes.

GET api/SpecialVotes/ApplicationStatus/IDNumber/{sIDNumber}/ElectoralEventID/{lEEID}

Returns the application status for a voter per event.

GET api/SpecialVotes/ApplicationReasons/EETypeID/{lEETypeID}

Returns the application reasons.

GET api/SpecialVotes/IsSpecialVotePWCaptureOpen/lEEID/{lEEID}

Check if special vote is open for capture on public website.

POST api/SpecialVotes/Apply

No documentation available.

LatestResultsIn

Latest results in

APIDescription
GET api/v1/LatestResultsIn?ElectoralEventID={ElectoralEventID}&NumberOfVDs={NumberOfVDs}

Returns latest results received in each Voting District

GET api/LatestResultsIn/ElectoralEventID/{ElectoralEventID}/NumberOfVDs/{NumberOfVDs}

Returns latest results received in each Voting District

Error

APIDescription
GET api/error

No documentation available.

GET api/error/400

No documentation available.

GET api/error/404

No documentation available.

GET api/error/500

No documentation available.

LGEBallotResults

APIDescription
GET api/v1/LGEBallotResults?ElectoralEventID={ElectoralEventID}

Get LGE Ballot Results for a specific electoral event

GET api/v1/LGEBallotResults?ElectoralEventID={ElectoralEventID}&ProvinceID={ProvinceID}

Get LGE Ballot Results for a specific electoral event and province

GET api/v1/LGEBallotResults?ElectoralEventID={ElectoralEventID}&ProvinceID={ProvinceID}&MunicipalityID={MunicipalityID}

Get LGE Ballot Results for a specific electoral event, province and municipality

GET api/v1/LGEBallotResults?ElectoralEventID={ElectoralEventID}&ProvinceID={ProvinceID}&MunicipalityID={MunicipalityID}&WardID={WardID}

Get LGE Ballot Results for a specific electoral event, province, municipality and ward. Note that this call is also applicable to By-Election results.

GET api/v1/LGEBallotResults?ElectoralEventID={ElectoralEventID}&ProvinceID={ProvinceID}&MunicipalityID={MunicipalityID}&VDNumber={VDNumber}

Get LGE Ballot Results for a specific electoral event, province, municipality, ward and voting district. Note that this call is also applicable to By-Election results.