Service Area

Service Area#

Note

Viewing documentation for the current version v1beta2.

The required Protobuf definitions can be downloaded here:

ServiceAreaService#

This ServiceAreaService provides methods to query service areas.

GetServiceArea#

rpc GetServiceArea(GetServiceAreaRequest) GetServiceAreaResponse

Get service area by ID.

Fails with NOT_FOUND with the reason SERVICE_AREA_NOT_FOUND if the service area does not exist.

ListServiceAreas#

rpc ListServiceAreas(ListServiceAreasRequest) ListServiceAreasResponse

List service areas, paginated. Returns an empty list if none are found.

Fails with INVALID_ARGUMENT with the following reasons:

INVALID_PAGE_SIZE if the page_size is less than zero.
INVALID_PAGE_TOKEN if the page_token does not match previous requests.

ListServiceHours#

rpc ListServiceHours(ListServiceHoursRequest) ListServiceHoursResponse

List service hours for a service area.

Fails with INVALID_ARGUMENT with the following reasons:

INVALID_PAGE_SIZE if the page_size is less than zero.
INVALID_PAGE_TOKEN if the page_token does not match previous requests.

Messages#

GetServiceAreaRequest#

The request to get a service area by ID.

Field	Type	Description
id	string	The ID of the service area.

GetServiceAreaResponse#

The response containing the requested service area.

Field	Type	Description
service_area	ServiceArea	The service area with the given ID.

ListServiceAreasRequest#

The request to list service areas.

Field	Type	Description
page_size (optional)	int32	The maximum number of service areas to return. The service may return fewer than this value. If unspecified or set to zero, at most 5 service areas will be returned. The maximum value is 100; values above 100 will be coerced to 100. Negative values won’t be accepted.
page_token (optional)	string	A page token, received from a previous `ListServiceAreasRequest` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListServiceAreasRequest` must match the call that provided the page token.

ListServiceAreasResponse#

The response containing service areas.

Field	Type	Description
service_areas	repeated ServiceArea	List of service areas.
next_page_token (optional)	string	A token, which can be sent as `page_token` in the next request to retrieve the next page. If this field is omitted, there are no subsequent pages.

ListServiceHoursRequest#

The request to list a service area’s service hours.

Field	Type	Description
service_area_id	string	The ID of the service area.
page_size (optional)	int32	The maximum number of service hours to return. The service may return fewer than this value. If unspecified or set to zero, at most 25 service hours will be returned. The maximum value is 100; values above 100 will be coerced to 100. Negative values won’t be accepted.
page_token (optional)	string	A page token, received from a previous `ListServiceHoursResponse`. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListServiceHoursRequest` must match the call that provided the page token.

ListServiceHoursResponse#

The list of a service area’s service hours.

Field	Type	Description
service_hour_intervals	repeated moia.type.v1.TimeInterval	The time intervals in which ridepooling in this service area is in service. The time intervals are ordered chronologically from the current time to the future.
service_area_id	string	The ID of the service area.
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.

ServiceArea#

A service area is an area in the physical world where a ridepooling service is in operation.

Field	Type	Description
name	string	Unique name of the service area.
id	string	ID of the service area.
polygon	repeated moia.type.v1.LatLon	Polygon with a list of locations delineating the exact boundaries of the service area.
time_zone	string	Time zone ID in IANA Time Zone codes e.g. Europe/Berlin.
country	string	ISO 3166-1 alpha-2 country code of the country this service area is located in.
create_time	google.protobuf.Timestamp	Service area creation date.
modify_time	google.protobuf.Timestamp	Service area last modified date.