Representatives: representativeInfoByAddress

Recherche des informations de géographie politique et de représentation pour une seule adresse. Essayer maintenant

Requête

Requête HTTP

GET https://www.googleapis.com/civicinfo/v2/representatives

Paramètres

Nom du paramètre Valeur Description
Paramètres de requête facultatifs
address string Adresse à rechercher. Ne peut être spécifié que si le champ ocdId n'est pas indiqué dans l'URL.
includeOffices boolean Indique s'il faut afficher des informations sur les bureaux et les fonctionnaires. Si la valeur est "false", seules les informations de premier niveau sur le district sont renvoyées. (Par défaut : true)
levels string Liste des niveaux de bureau à utiliser comme critères de filtrage. Seuls les bureaux qui desservent au moins l'un de ces niveaux sont renvoyés. Les divisions qui ne contiennent pas de bureau correspondant ne sont pas renvoyées.

Valeurs acceptées :
  • "administrativeArea1"
  • "administrativeArea2"
  • "country"
  • "international"
  • "locality"
  • "regional"
  • "special"
  • "subLocality1"
  • "subLocality2"
roles string Liste des rôles Office à utiliser comme filtre. Seuls les bureaux remplissant l'un de ces rôles seront renvoyés. Les divisions qui ne contiennent pas de bureau correspondant ne sont pas renvoyées.

Valeurs acceptées :
  • "deputyHeadOfGovernment"
  • "executiveCouncil"
  • "governmentOfficer"
  • "headOfGovernment"
  • "headOfState"
  • "highestCourtJudge"
  • "judge"
  • "legislatorLowerBody"
  • "legislatorUpperBody"
  • "schoolBoard"
  • "specialPurposeOfficer"

Corps de la requête

Ne spécifiez pas de corps de requête pour cette méthode.

Réponse

Si la requête aboutit, cette méthode renvoie un corps de réponse présentant la structure suivante :

{
  "kind": "civicinfo#representativeInfoResponse",
  "normalizedInput": {
    "locationName": string,
    "line1": string,
    "line2": string,
    "line3": string,
    "city": string,
    "state": string,
    "zip": string
  },
  "divisions": {
    (key): {
      "name": string,
      "alsoKnownAs": [
        string
      ],
      "officeIndices": [
        unsigned integer
      ]
    }
  },
  "offices": [
    {
      "name": string,
      "divisionId": string,
      "levels": [
        string
      ],
      "roles": [
        string
      ],
      "sources": [
        {
          "name": string,
          "official": boolean
        }
      ],
      "officialIndices": [
        unsigned integer
      ]
    }
  ],
  "officials": [
    {
      "name": string,
      "address": [
        {
          "locationName": string,
          "line1": string,
          "line2": string,
          "line3": string,
          "city": string,
          "state": string,
          "zip": string
        }
      ],
      "party": string,
      "phones": [
        string
      ],
      "urls": [
        string
      ],
      "photoUrl": string,
      "emails": [
        string
      ],
      "channels": [
        {
          "type": string,
          "id": string
        }
      ]
    }
  ]
}
Nom de propriété Valeur Description Remarques
kind string Identifie le type de ressource. Valeur: chaîne fixe "civicinfo#representativeInfoResponse".
normalizedInput nested object Version normalisée de l'adresse demandée
normalizedInput.locationName string Nom du lieu.
normalizedInput.line1 string Nom de rue et numéro de cette adresse.
normalizedInput.line2 string Utilisez la deuxième ligne pour l'adresse, si nécessaire.
normalizedInput.line3 string Troisième ligne d'adresse, si nécessaire.
normalizedInput.city string Ville de l'adresse.
normalizedInput.state string Abréviation à deux lettres de l'État américain de l'adresse.
normalizedInput.zip string Code postal américain de l'adresse.
divisions object Divisions géographiques politiques contenant l'adresse demandée. Pour en savoir plus, consultez la documentation sur la ressource Représentants.
offices[] list Bureaux élus référencés par les divisions listées ci-dessus. Ne sera présent que si includeOffices a été défini sur "true" dans la requête. Pour en savoir plus, consultez la documentation sur la ressource Représentants.
officials[] list Fonctionnaires occupant les bureaux énumérés ci-dessus. Ne sera présent que si includeOffices a été défini sur "true" dans la requête. Pour en savoir plus, consultez la documentation sur la ressource Représentants.

Essayer