FareRequestGroup groupStopFareRequestStructureStaticFareRequestStructureTripFareRequestStructureMultiTripFareRequestStructureFareResponseGroup groupFareResultStructureStopFareResultStructureStaticFareResultStructureTripFareProductReferenceStructureMultiTripFareResultStructureFareAuthorityRefStructureFareAuthorityRefFareAuthorityGroup groupTariffZoneRefStructureTariffZoneRefTariffZoneStructureTariffZoneListInAreaStructureTariffZoneRefListStructureBookingArrangementStructureBookingArrangementsContainerStructureFareProductRefStructureFareProductRefEntitlementProductListStructureEntitlementProductStructureFareProductStructureFareProductPriceGroup groupFareProductValidityGroup groupFareProductBookingGroup groupTripLegRangeGroup groupTripFareResultStructureFarePassengerStructureFareDataFilterGroup groupFareParamStructureFareProblemStructurePlaceInformationRequestGroup groupPlaceInformationResponseGroup groupInitialPlaceInputStructurePlaceParamStructureGeoRestrictionsStructureGeoCircleStructureGeoRectangleStructureGeoAreaStructurePlaceResultStructurePlacePolicyGroup groupPlaceDataFilterGroup groupExchangePointsRequestGroup groupExchangePointsParamStructureExchangePointsDataFilterGroup groupExchangePointsPolicyGroup groupExchangePointsResponseGroup groupExchangePointsResultStructurePlaceInformationRequestGroup groupPlaceInformationResponseGroup groupInitialPlaceInputStructurePlaceParamStructureGeoRestrictionsStructureGeoCircleStructureGeoRectangleStructureGeoAreaStructurePlaceResultStructurePlacePolicyGroup groupPlaceDataFilterGroup groupPlaceSortingGroup groupExchangePointsRequestGroup groupExchangePointsParamStructureExchangePointsDataFilterGroup groupExchangePointsPolicyGroup groupExchangePointsResponseGroup groupExchangePointsResultStructureStopPointGroup groupStopPointStructureStopPlaceRefStructureStopPlaceRefStopPlaceGroup groupStopPlaceStructureStopAttributesGroup groupTopographicPlaceRefStructureTopographicPlaceRefTopographicPlaceStructurePointOfInterestRefStructurePointOfInterestRefPointOfInterestStructurePointOfInterestCategoryStructureOsmTagStructurePointOfInterestFilterStructureAddressRefStructureAddressRefAddressDetailGroup groupAddressStructurePlaceStructurePlaceRefStructureLocationProblemStructureExchangePointProblemStructureStopEventRequestGroup groupStopEventParamStructureStopEventDataFilterGroup groupStopEventPolicyGroup groupStopEventContentFilterGroup groupStopEventResponseGroup groupStopEventResultStructureStopEventStructureCallAtNearStopStructureStopEventProblemStructureTripInfoRequestGroup groupTripInfoParamStructureTripInfoPolicyGroup groupTripInfoContentFilterGroup groupTripInfoResponseGroup groupTripInfoResultStructureTripInfoProblemStructureNumberOfResults
0:1
xs:positiveInteger
Maximum number of results to be returned. The service is allowed to return fewer objects if reasonable or otherwise appropriate. If the number of matching objects is expected to be large (e.g.: in the case that all objects should be delivered) this parameter can be used to partition the response delivery into smaller chunks. The place information service is expected to support a response volume of at least 500 objects within one single response.
ContinueAt
0:1
xs:nonNegativeInteger
Tells the server to skip the mentioned number of results in its response. Can be used in a follow-up request to get further results. The value is usually taken from the previous response.
IncludePtModes
0:1
xs:boolean
Tells the service to include the available public transport modes at returned stops.
GeoRestrictionsStructure
| |||||
The element contains one of the following elements: | |||||
a |
| -1:1 | Area is defined by a polyline | ||
b |
| -1:1 | |||
c |
| -1:1 | |||
GeoCircleStructure
| |||||
The element contains a sequence of the following elements: | |||||
| 1:1 | siri:LocationStructure | |||
| 1:1 | siri:DistanceType | Radius in metres. | ||
GeoRectangleStructure
| |||||
The element contains a sequence of the following elements: | |||||
| 1:1 | siri:LocationStructure | |||
| 1:1 | siri:LocationStructure | |||
GeoAreaStructure
| [specialisation of ZONE in TMv6] a LINK SEQUENCE (one-dimensional) forming the boundary of a ZONE + + | ||||
| PlaceSorting |
| 0:1 | xs:string | If there are multiple sorting methods supported by the system, the client can choose one of the existing. Which methods are available needs to be known to the client and may differ from system to system. Therefore use with care. | |
| 0:1 | siri:LocationStructure | WGS84 coordinates position. Locations closer to this GeoPosition are preferred. | ||
| 0:1 | xs:float | Ignore locations with a lower probability. | ||
GeoRestrictionsStructure
| |||||
The element contains one of the following elements: | |||||
a |
| -1:1 | Area is defined by a polyline | ||
b |
| -1:1 | |||
c |
| -1:1 | |||
GeoCircleStructure
| |||||
The element contains a sequence of the following elements: | |||||
| 1:1 | siri:LocationStructure | |||
| 1:1 | siri:DistanceType | Radius in metres. | ||
GeoRectangleStructure
| |||||
The element contains a sequence of the following elements: | |||||
| 1:1 | siri:LocationStructure | |||
| 1:1 | siri:LocationStructure | |||
GeoAreaStructure
| [specialisation of ZONE in TMv6] a LINK SEQUENCE (one-dimensional) forming the boundary of a ZONE | ||||
The element contains only one element: | |||||
| 3:* | siri:LocationStructure | |||
PlaceResultStructure
| |||||
The element contains a sequence of the following elements: | |||||
| 0:* | Problems related to this LOCATION result. | |||
| 1:1 | ||||
| 1:1 | xs:boolean | States whether the included place is complete or needs further refinement. Only complete places are fully resolved and can be used in e.g. trip requests. Incomplete places have to be refined entering them once again into a PlaceInformationRequest. | ||
| 0:1 | Probability, that this result is the one meant by the user's input. Value should be between 0 and 1. | |||
| 0:1 | Filter for places that are operated by certain organisations. | |||
| 0:* | If at least one is set, only place objects within the given localities are allowed. | |||
| 0:1 | Filter to narrow down POI searches. | |||
ExchangePointsRequestGroup group
| |||||
PlaceSortingGroup group
| |||||
| PlaceSorting |
| 0:1 | xs:string | If there are multiple sorting methods supported by the system, the client can choose one of the existing. Which methods are available needs to be known to the client and may differ from system to system. Therefore use with care. | |
| 0:1 | siri:LocationStructure | WGS84 coordinates position. Locations closer to this GeoPosition are preferred. | ||
| 0:1 | xs:float | Ignore locations with a lower probability. | ||
ExchangePointsRequestGroup group
| |||||
| ExchangePointsRequest |
| 0:1 | Place for which exchange points to other "neighbour" systems are to be searched. This place is usually the origin/destination of a passenger journey. May be omitted if all exchange points shall be returned. | ||
| 0:1 | E.g. place types (stops, addresses, POIs) or specific place attributes | |||
ExchangePointsParamStructure
| |||||
The element contains a sequence of the following elements: | |||||
ExchangePointsParamStructure
| |||||
The element contains a sequence of the following elements: | |||||
| ExchangePointsDataFilter |
| 0:* | Allowed place object types. If none is given, all types are allowed. | ||
| 0:1 | Defines, whether the place object of this request acts as origin, via or destination point of the passenger journey. | |||
| 0:1 | Allowed public transport modes. Defines, which public transport modes must be available at the returned place objects. Applies only to stops. | |||
| ExchangePointsPolicy |
| 0:* | xs:language | Preferred language in which to return text values. | |
| 0:1 | xs:positiveInteger | |||
| 0:1 | xs:nonNegativeInteger | Tells the server to skip the mentioned number of results in its response. Can be used in a follow-up request to get further results. The value is usually taken from the previous response. | ||
ExchangePointsDataFilterGroup group
| |||||
ExchangePointsDataFilterGroup group
| |||||
| ExchangePointsDataFilter |
| 0:* | Allowed place object types. If none is given, all types are allowed. | ||
| 0:1 | Defines, whether the place object of this request acts as origin, via or destination point of the passenger journey. | |||
| 0:1 | Allowed public transport modes. Defines, which public transport modes must be available at the returned place objects. Applies only to stops. | |||
| 0:* | If at least one is set, only place objects within the given localities are allowed. | |||
| 0:1 | siri:ParticipantRefStructure | Reference to system in which the destination (or origin) of the passenger is located. | ||
| 0:* | siri:ParticipantRefStructure | One or more adjacent systems to which the exchange points should be retrieved. | ||
ExchangePointsPolicyGroup group
| |||||
ExchangePointsPolicyGroup group
| |||||
| ExchangePointsPolicy |
| 0:* | xs:language | Preferred language in which to return text values. | |
| 0:1 | xs:positiveInteger | |||
| 0:1 | xs:nonNegativeInteger | Tells the server to skip the mentioned number of results in its response. Can be used in a follow-up request to get further results. The value is usually taken from the previous response. | ||
ExchangePointsResponseGroup group
| |||||
ExchangePointsResponseGroup group
| |||||
| ExchangePointsResponse |
| 0:1 | Context to hold trip response objects that occur frequently. | ||
| 0:1 | xs:nonNegativeInteger | If the response returns less results than expected, the value of skip can be used in a follow-up request to get further results. It tells the server to skip the given number of results in its response. | ||
| 0:* | ||||
ExchangePointsResultStructure
| |||||
The element contains a sequence of the following elements: | |||||
| 0:* | Problems related to this EXCHANGE POINTS result. | |||
| 1:1 | Place object that describes this exchange point. | |||
| 0:1 | xs:duration | Rough estimate of the travel duration from the specified reference place to this exchange point. | ||
| 0:1 | xs:duration | Duration needed at this exchange point to change from one service to another. If a journey planning orchestrator puts together a trip at this exchange point, it has to take care, that feeding arrival and fetching departure are at least this duration apart. | ||
| 0:1 | xs:boolean | Flag if this exchange point is an administrative border point where timetables are cut off while services still may run through and connect the regions. At this kind of points passengers may continue their journey within the same service. Default is FALSE. | ||
| 0:* | +Mode | List of transport modes that call at this place object. This list should only be filled in case of stop points or stop places – and only when explicitly requested. | ||
| xs:normalizedString | Identifier of an Address |
| EXCHANGEPOINTS_NORESULTS | EXCHANGEPOINTS_UNKNOWNDESTINATIONSYSTEM | EXCHANGEPOINTS_UNKNOWNADJACENTSYSTEM | EXCHANGEPOINTS_OTHER | Types of problems that may be returned in responses to EXCHANGE POINTS requests |
| LOCATION_NORESULTS | LOCATION_UNSUPPORTEDTYPE | LOCATION_UNSUPPORTEDCOMBINATION | LOCATION_NOREFINEMENT | LOCATION_USAGEIGNORED | LOCATION_UNSUPPORTEDPTMODES | LOCATION_UNSUPPORTEDLOCALITY | LOCATION_OTHER | Types of problems that may be returned in responses to LOCATION requests. |
| xs:normalizedString | Identifier of a Point of Interest |
| xs:normalizedString | Identifier of a Stop Place |
| xs:normalizedString | Identifier of a TopographicPlace |
StopPointGroup group
| A stop point with id and name | ||||
ExchangePointsResultStructure
| |||||
The element contains a sequence of the following elements: | |||||
| 0:* | Problems related to this EXCHANGE POINTS result. | |||
| 1:1 | Place object that describes this exchange point. | |||
| 0:1 | xs:duration | Rough estimate of the travel duration from the specified reference place to this exchange point. | ||
| 0:1 | xs:duration | Duration needed at this exchange point to change from one service to another. If a journey planning orchestrator puts together a trip at this exchange point, it has to take care, that feeding arrival and fetching departure are at least this duration apart. | ||
| 0:1 | xs:boolean | Flag if this exchange point is an administrative border point where timetables are cut off while services still may run through and connect the regions. At this kind of points passengers may continue their journey within the same service. Default is FALSE. | ||
| 0:* | +Mode | List of transport modes that call at this place object. This list should only be filled in case of stop points or stop places – and only when explicitly requested. | ||
| xs:normalizedString | Identifier of an Address |
| EXCHANGEPOINTS_NORESULTS | EXCHANGEPOINTS_UNKNOWNDESTINATIONSYSTEM | EXCHANGEPOINTS_UNKNOWNADJACENTSYSTEM | EXCHANGEPOINTS_OTHER | Types of problems that may be returned in responses to EXCHANGE POINTS requests |
| LOCATION_NORESULTS | LOCATION_UNSUPPORTEDTYPE | LOCATION_UNSUPPORTEDCOMBINATION | LOCATION_NOREFINEMENT | LOCATION_USAGEIGNORED | LOCATION_UNSUPPORTEDPTMODES | LOCATION_UNSUPPORTEDLOCALITY | LOCATION_UNSUPPORTEDSORTINGMETHOD | LOCATION_OTHER | Types of problems that may be returned in responses to LOCATION requests. |
| xs:normalizedString | Identifier of a Point of Interest |
| xs:normalizedString | Identifier of a Stop Place |
| xs:normalizedString | Identifier of a TopographicPlace |
StopPointGroup group
| A stop point with id and name | ||||
| StopPoint |
| 1:1 | →siri:StopPointRef | ||
| 1:1 | Name or description of stop point for use in passenger information. | |||
| 0:1 | Additional description of the stop point that may be appended to the name if enough space is available. F.e. "opposite main entrance". | |||