Operatingarea

Operatingarea#

Note

Viewing documentation for the current version v1beta1.

The required Protobuf definitions can be downloaded here:

moia/fleet/operatingarea/v1beta1/operatingarea.proto

OperatingAreaService#

This service provides methods to query the MOIA operating areas.

ListOperatingAreas#

rpc ListOperatingAreas(ListOperatingAreasRequest) returns (ListOperatingAreasResponse)

List all operating areas.

GetOperatingArea#

rpc GetOperatingArea(GetOperatingAreaRequest) returns (GetOperatingAreaResponse)

Get a specific operating area by its ID.

UpdateOperatingArea#

rpc UpdateOperatingArea(UpdateOperatingAreaRequest) returns (UpdateOperatingAreaResponse)

Update an existing operating area.

Messages#

GetOperatingAreaRequest#

Request message for GetOperatingArea.

Field	Type	Description
`id`	string	Unique identifier for the operating area as UUIDv4.

GetOperatingAreaResponse#

Response message for GetOperatingArea.

Field	Type	Description
`operating_area`	OperatingArea	The requested operating area.

ListOperatingAreasRequest#

Request message for ListOperatingAreas.

Field	Type	Description
`page_size`	optional int32	The maximum number of operating areas to return (default 50).
`page_token`	optional string	A page token, received from a previous `ListOperatingAreasRequest` call. Provide this to retrieve the subsequent page.

ListOperatingAreasResponse#

Response message for ListOperatingAreas.

Field	Type	Description
`operating_areas`	repeated OperatingArea	All operating areas.
`next_page_token`	optional string	A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.

OperatingArea#

An operating area defines a geographical area where MOIA vehicles are allowed to operate.

Field	Type	Description
`id`	string	Unique identifier for the operating area as UUIDv4.
`name`	string	Human readable name for display purposes.
`geometry`	string	Geometry as a GeoJSON MultiPolygon object.
`region_id`	string	Region identifier the operating area belongs to.

UpdateOperatingAreaRequest#

Request message for UpdateOperatingArea

Field	Type	Description
`operating_area`	OperatingArea	The operating area with updated information. Only `name` and `geometry` fields may be changed.

UpdateOperatingAreaResponse#

Response message for UpdateOperatingArea

Field	Type	Description
`operating_area`	OperatingArea	The updated operating area.