Class RepresentativesResource.RepresentativeInfoByDivisionRequest
Looks up representative information for a single geographic division.
Inheritance
Inherited Members
Namespace: Google.Apis.CivicInfo.v2
Assembly: Google.Apis.CivicInfo.v2.dll
Syntax
public class RepresentativesResource.RepresentativeInfoByDivisionRequest : CivicInfoBaseServiceRequest<RepresentativeInfoData>, IClientServiceRequest<RepresentativeInfoData>, IClientServiceRequest
Constructors
RepresentativeInfoByDivisionRequest(IClientService, string)
Constructs a new RepresentativeInfoByDivision request.
Declaration
public RepresentativeInfoByDivisionRequest(IClientService service, string ocdId)
Parameters
Type | Name | Description |
---|---|---|
IClientService | service | |
string | ocdId |
Properties
HttpMethod
Gets the HTTP method.
Declaration
public override string HttpMethod { get; }
Property Value
Type | Description |
---|---|
string |
Overrides
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.
Declaration
[RequestParameter("levels", RequestParameterType.Query)]
public virtual RepresentativesResource.RepresentativeInfoByDivisionRequest.LevelsEnum? Levels { get; set; }
Property Value
Type | Description |
---|---|
RepresentativesResource.RepresentativeInfoByDivisionRequest.LevelsEnum? |
Remarks
Use this property to set a single value for the parameter, or LevelsList to set multiple values. Do not set both properties.
LevelsList
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.
Declaration
[RequestParameter("levels", RequestParameterType.Query)]
public virtual Repeatable<RepresentativesResource.RepresentativeInfoByDivisionRequest.LevelsEnum> LevelsList { get; set; }
Property Value
Type | Description |
---|---|
Repeatable<RepresentativesResource.RepresentativeInfoByDivisionRequest.LevelsEnum> |
Remarks
Use this property to set one or more values for the parameter. Do not set both this property and Levels.
MethodName
Gets the method name.
Declaration
public override string MethodName { get; }
Property Value
Type | Description |
---|---|
string |
Overrides
OcdId
The Open Civic Data division identifier of the division to look up.
Declaration
[RequestParameter("ocdId", RequestParameterType.Path)]
public virtual string OcdId { get; }
Property Value
Type | Description |
---|---|
string |
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.
Declaration
[RequestParameter("recursive", RequestParameterType.Query)]
public virtual bool? Recursive { get; set; }
Property Value
Type | Description |
---|---|
bool? |
RestPath
Gets the REST path.
Declaration
public override string RestPath { get; }
Property Value
Type | Description |
---|---|
string |
Overrides
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.
Declaration
[RequestParameter("roles", RequestParameterType.Query)]
public virtual RepresentativesResource.RepresentativeInfoByDivisionRequest.RolesEnum? Roles { get; set; }
Property Value
Type | Description |
---|---|
RepresentativesResource.RepresentativeInfoByDivisionRequest.RolesEnum? |
Remarks
Use this property to set a single value for the parameter, or RolesList to set multiple values. Do not set both properties.
RolesList
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.
Declaration
[RequestParameter("roles", RequestParameterType.Query)]
public virtual Repeatable<RepresentativesResource.RepresentativeInfoByDivisionRequest.RolesEnum> RolesList { get; set; }
Property Value
Type | Description |
---|---|
Repeatable<RepresentativesResource.RepresentativeInfoByDivisionRequest.RolesEnum> |
Remarks
Use this property to set one or more values for the parameter. Do not set both this property and Roles.
Methods
InitParameters()
Initializes RepresentativeInfoByDivision parameter list.
Declaration
protected override void InitParameters()