Election Management API (1.0.0)

Download OpenAPI specification:Download

This API provides the endpoints for getting candidates and their parties.

Public Endpoints

Endpoints accessible without authentication.

Each endpoint has to be prefixed with rckt.be/api.

Get all of the parties

Fetches details of all parties, including their total vote count. And a link to the endpoint containing more detailed information like a list of all of the candidates that belong to the party.

Sequence Diagram

Responses

Response samples

200
500

Content type

application/json

{"parties": [{"id": 1,
"name": "Party A",
"list_number": 1,
"seats": 20,
"votes": 1500000,
"_links": {"self": {"href": "/public/v1/electionresult/party/1"
}
}
},
{"id": 2,
"name": "Party B",
"list_number": 2,
"seats": 5,
"votes": 500000,
"_links": {"self": {"href": "/public/v1/electionresult/party/2"
}
}
}
],
"_links": {"self": {"href": "/public/v1/electionresult/party"
}
}
}

Get details of a specific party

Fetches details of a specific party by its ID, including their total vote count.

Sequence Diagram

path Parameters

partyId

required

integer

The ID of the party to retrieve.

Responses

Response samples

200
404
500

Content type

application/json

{"party": {"id": 1,
"name": "Party A",
"list_number": 1,
"seats": 20,
"votes": 1500000,
"candidates": [{"candidate_number": 1,
"party_id": 1,
"city": "Amsterdam",
"name": "John",
"middle_name": "Johhny",
"last_name": "Jones",
"gender": "m",
"initials": "J.J",
"votes": 666666,
"_links": {"self": {"href": "/public/v1/electionresult/party/1/1"
}
}
},
{"candidate_number": 4,
"party_id": 1,
"city": "Haarlem",
"name": "Jane",
"middle_name": "Janey",
"last_name": "Janes",
"gender": "f",
"initials": "J.J",
"votes": 777777,
"_links": {"self": {"href": "/public/v1/electionresult/party/1/4"
}
}
}
],
"_links": {"self": {"href": "/public/v1/electionresult/party/1"
}
}
}
}

Get details of a specific candidate

Fetches details of a specific candidate by his/her party and candidate Id

Sequence Diagran

path Parameters

partyId required	integer The ID of the party to retrieve.
candidateId required	integer The candidateId of the candidate to retrieve.

Responses

Response samples

200
404
500

Content type

application/json

{"candidate": {"candidate_number": 1,
"party_id": 1,
"city": "Amsterdam",
"name": "John",
"middle_name": "Johhny",
"last_name": "Jones",
"gender": "m",
"initials": "J.J",
"votes": 666666,
"party": {"id": 1,
"name": "Party A",
"list_number": 1,
"seats": 20,
"votes": 1500000,
"_links": {"self": {"href": "/public/v1/electionresult/party/1"
}
}
},
"_links": {"self": {"href": "/public/v1/electionresult/party/1/1"
}
}
}
}