RepresentativesRepresentativeInfoByAddressOptions
import type { RepresentativesRepresentativeInfoByAddressOptions } from "https://googleapis.deno.dev/v1/civicinfo:v2.ts";Additional options for Civicinfo#representativesRepresentativeInfoByAddress.
interface RepresentativesRepresentativeInfoByAddressOptions {
address?: string;
includeOffices?: boolean;
levels?:
| "international"
| "country"
| "administrativeArea1"
| "regional"
| "administrativeArea2"
| "locality"
| "subLocality1"
| "subLocality2"
| "special";
roles?:
} | "headOfState"
| "headOfGovernment"
| "deputyHeadOfGovernment"
| "governmentOfficer"
| "executiveCouncil"
| "legislatorUpperBody"
| "legislatorLowerBody"
| "highestCourtJudge"
| "judge"
| "schoolBoard"
| "specialPurposeOfficer"
| "otherRole";
§Properties
§
address?: string
[src]The address to look up. May only be specified if the field ocdId is not given in the URL
§
includeOffices?: boolean
[src]Whether to return information about offices and officials. If false, only the top-level district information will be returned.
§
levels?: "international" | "country" | "administrativeArea1" | "regional" | "administrativeArea2" | "locality" | "subLocality1" | "subLocality2" | "special"
[src]A list of office levels to filter by. Only offices that serve at least one of these levels will be returned. Divisions that don't contain a matching office will not be returned.
§
roles?: "headOfState" | "headOfGovernment" | "deputyHeadOfGovernment" | "governmentOfficer" | "executiveCouncil" | "legislatorUpperBody" | "legislatorLowerBody" | "highestCourtJudge" | "judge" | "schoolBoard" | "specialPurposeOfficer" | "otherRole"
[src]A list of office roles to filter by. Only offices fulfilling one of these roles will be returned. Divisions that don't contain a matching office will not be returned.