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

Get National Candidates for a specific party and electoral event

Request Information

Parameters

NameDescriptionAdditional information
ElectoralEventID
Valid Province IDs can be obtained by invoking the Delimitation Controller's Get Action and passing an ElectoralEventID: api/v1/Delimitation?ElectoralEventID={ElectoralEventID}

Define this parameter in the request URI.

PartyID
Valid Party IDs can be obtained by invoking the ContestingParties Controller's Get Action and passing an ElectoralEventID: api/v1/ContestingParties?ElectoralEventID={ElectoralEventID}

Define this parameter in the request URI.

Response Information

Response body formats

application/json, text/json

Sample:
[
  {
    "Rank": 1,
    "ID": 2,
    "Firstname": "sample string 3",
    "Surname": "sample string 4",
    "ListType": "sample string 5",
    "ProvinceID": 6,
    "Province": "sample string 7",
    "PartyAbbr": "sample string 8"
  },
  {
    "Rank": 1,
    "ID": 2,
    "Firstname": "sample string 3",
    "Surname": "sample string 4",
    "ListType": "sample string 5",
    "ProvinceID": 6,
    "Province": "sample string 7",
    "PartyAbbr": "sample string 8"
  },
  {
    "Rank": 1,
    "ID": 2,
    "Firstname": "sample string 3",
    "Surname": "sample string 4",
    "ListType": "sample string 5",
    "ProvinceID": 6,
    "Province": "sample string 7",
    "PartyAbbr": "sample string 8"
  }
]

application/xml, text/xml

Sample:
<ArrayOfNPENationalCandidate xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IECService.Models">
  <NPENationalCandidate>
    <Firstname>sample string 3</Firstname>
    <ID>2</ID>
    <ListType>sample string 5</ListType>
    <PartyAbbr>sample string 8</PartyAbbr>
    <Province>sample string 7</Province>
    <ProvinceID>6</ProvinceID>
    <Rank>1</Rank>
    <Surname>sample string 4</Surname>
  </NPENationalCandidate>
  <NPENationalCandidate>
    <Firstname>sample string 3</Firstname>
    <ID>2</ID>
    <ListType>sample string 5</ListType>
    <PartyAbbr>sample string 8</PartyAbbr>
    <Province>sample string 7</Province>
    <ProvinceID>6</ProvinceID>
    <Rank>1</Rank>
    <Surname>sample string 4</Surname>
  </NPENationalCandidate>
  <NPENationalCandidate>
    <Firstname>sample string 3</Firstname>
    <ID>2</ID>
    <ListType>sample string 5</ListType>
    <PartyAbbr>sample string 8</PartyAbbr>
    <Province>sample string 7</Province>
    <ProvinceID>6</ProvinceID>
    <Rank>1</Rank>
    <Surname>sample string 4</Surname>
  </NPENationalCandidate>
</ArrayOfNPENationalCandidate>