Moodle PHP Documentation 4.4
Moodle 4.4.1 (Build: 20240610) (db07c09afc5)
Google_Service_CivicInfo_Representatives_Resource Class Reference

The "representatives" collection of methods. More...

Inheritance diagram for Google_Service_CivicInfo_Representatives_Resource:
Google_Service_Resource

Public Member Functions

 call ($name, $arguments, $expected_class=null)
 TODO: This function needs simplifying.
 
 representativeInfoByAddress ($optParams=array())
 Looks up political geography and representative information for a single address.
 
 representativeInfoByDivision ($ocdId, $optParams=array())
 Looks up representative information for a single geographic division.
 

Protected Member Functions

 convertToArrayAndStripNulls ($o)
 

Detailed Description

The "representatives" collection of methods.

Typical usage is: $civicinfoService = new Google_Service_CivicInfo(...); $representatives = $civicinfoService->representatives;

Member Function Documentation

◆ call()

Google_Service_Resource::call ( $name,
$arguments,
$expected_class = null )
inherited

TODO: This function needs simplifying.

Parameters
$name
$arguments
$expected_class- optional, the expected class name
Return values
Google_Http_Request|expected_class
Exceptions
Google_Exception

◆ representativeInfoByAddress()

Google_Service_CivicInfo_Representatives_Resource::representativeInfoByAddress ( $optParams = array())

Looks up political geography and representative information for a single address.

(representatives.representativeInfoByAddress)

Parameters
array$optParamsOptional parameters.

@opt_param bool includeOffices Whether to return information about offices and officials. If false, only the top-level district information will be returned. @opt_param string levels 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. @opt_param string roles 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. @opt_param string address The address to look up. May only be specified if the field ocdId is not given in the URL.

Return values
Google_Service_CivicInfo_RepresentativeInfoResponse

◆ representativeInfoByDivision()

Google_Service_CivicInfo_Representatives_Resource::representativeInfoByDivision ( $ocdId,
$optParams = array() )

Looks up representative information for a single geographic division.

(representatives.representativeInfoByDivision)

Parameters
string$ocdIdThe Open Civic Data division identifier of the division to look up.
array$optParamsOptional parameters.

@opt_param string levels 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. @opt_param bool recursive If true, information about all divisions contained in the division requested will be included as well. For example, if querying ocd-division/country:us/district:dc, this would also return all DC's wards and ANCs. @opt_param string roles 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.

Return values
Google_Service_CivicInfo_RepresentativeInfoData

The documentation for this class was generated from the following file: