API Methods
Methods for the API(back end). This is the planning stage, not actual documentation.
For actual current documentation, please see CategoryAPIDocs.
| Action Name | DAO Used | Data Object Retrieved | Criteria | Priority |
| CandidateAction.getBio | CandidateBioData | CandidateBio | can_id | Medium |
| CandidateAction.getAddtlBio | CandidateAddtlBioData | CandidateAddtlBio | can_id | Medium |
| CandidateAction.getElection | ElectionCandidateData | ElectionCandidate | can_id | Medium |
| CandidateAction.getOffice | OfficeCandidateData | OfficeCandidate | can_id | Medium |
| CandidateAction.getListByOffice | CandidateListData | CandidateBio | office_id | Medium |
| CandidateAction.getListByState | CandidateListData | CandidateBio | state_id | Medium |
| CandidateAction.getListByOfficeState | CandidateListData | CandidateBio | officetype_id, state_id | Medium |
| CandidateAction.getListByLastname | CandidateListData | CandidateBio | Lastname | Medium |
| CandidateAction.getListByLevenstein | CandidateListData | CandidateBio | levenstein(lastname) | Medium |
| CandidateAction.getListByElection | CandidateListData | CandidateBio | election_id | Medium |
| CandidateAction.getSpeechesByCandidate | SpeechListData | Speech | can_id | Medium |
| CandidateAction.getSpeech | SpeechData | Speech | sc_id | Medium |
| AddressAction.getCampaignAddress | AddressData | Address | candidate_id | High |
| AddressAction.getOfficeAddress | AddressData | Address | candidate_id | High |
| OfficeAction.getOfficeTypes | OfficeTypeData | OfficeType | <none> | |
| OfficeAction.getOfficesByType | OfficeListData | Office | officetype_id | |
| OfficeAction.getOfficesByLevel | OfficeListData | Office | officelevel_id | |
| OfficeAction.getOfficesByTypeLevel | OfficeListData | Office | officetype_id, officelevel_id | |
| OfficeAction.getOfficesByBranch | OfficeListData | Office | Officebranch_id | |
| VoteAction.getVotes | BillVotesData | BillVotes | bill_id(cs_id) | High |
| VoteAction.getVote | VoteData | Vote | bill_id(cs_id), can_id | High |
| VoteAction.getBills | BillListData | Bill | bill_number | High |
| VoteAction.getBills | BillListData | Bill | category_id | High |
| VoteAction.getBills | BillListData | Bill | category_id, year | High |
| VoteAction.getBills | BillListData | Bill | Year | High |
| VoteAction.getBills | BillListData | Bill | candidate_id | High |
| VoteAction.getBills | BillListData | Bill | candidate_id, year | High |
| VoteAction.getBills | BillListData | Bill | candidate_id, category_id | High |
| VoteAction.getRecentBills | BillListData | Bill | ammount(limit 100) | High |
| VoteAction.getCategories | CategoriesData | Category | state_id, year | High |
| CommitteeAction.getCommittees | CommitteesData | Committee | state_id | |
| CommitteeAction.getCommittees | CommitteesData | Committee | Level, state_id | |
| Committee.getCommitteeTypes | CommitteeTypesData | CommitteeTypes | <none> | |
| LocalAction.getCounties | LocalListData | Local | state_id | |
| LocalAction.getCitiesAndTowns | LocalListData | Local | state_id | |
| LocalAction.getCities | LocalListData | Local | state_id | |
| DistrictAction.getDistricts | DistrictListData | District | state_id | |
| DistrictAction.getDistrictName | DistrictNameData | District | district_id | |
| ElectionAction.getElection | ElectionData | Election | election_id | Medium |
| ElectionAction.getElections | ElectionListData | Election | Year, state_id | Medium |
| LeadershipAction.getCandidates | CandidateListData | CandidateBio | leadership_id, state | |
| LeadershipAction.getPositions | LeadershipListData | Leadership | <none> | |
| NPATAction.getNpat | NPATData | NPAT | can_id | |
| NPATAction.getNpat | NPATData | NPAT | election_candidate_id | |
| NPATAction.getNpat | NPATData | NPAT | can_id, election_id | |
| PartyAction.getParties | PartyListData | Party | <none> | |
| RatingAction.getCandidateRating | CandidateRatingData | Rating, CandidateBio(partial) | rating_id, can_id | Medium |
| RatingAction.getCandidateRating | CandidateRatingData | Rating, CandidateBio(partial) | rating_candidate_id | Medium |
| RatingAction.getCategories | CategoriesData | Category | state_id, year | Medium |
| RatingAction.getSIG | SIGData | SIG, RatingList | sig_id | Medium |
| RatingAction.getSIGList | SIGListData | SIG | state_id | Medium |
| RatingAction.getSIGList | SIGListData | SIG | category_id, state_id | Medium |
| RatingAction.getSIGList | SIGListData | SIG | category_id | Medium |
CategoryAPIPlanning
