diff --git a/docs/generated/OJP.html b/docs/generated/OJP.html index 8438bed9..a19abc4d 100644 --- a/docs/generated/OJP.html +++ b/docs/generated/OJP.html @@ -70,7 +70,7 @@
SituationsStructure
SituationFullRef
SituationFullRefStructure
StopEventRequestGroup
groupStopEventParamStructure
StopEventDataFilterGroup
groupStopEventPolicyGroup
groupStopEventContentFilterGroup
groupStopEventResponseGroup
groupStopEventResultStructure
StopEventStructure
CallAtNearStopStructure
TripRequestGroup
groupTripParamStructure
TripDataFilterGroup
groupTripPolicyGroup
groupTripMobilityFilterGroup
groupTripContentFilterGroup
groupNotViaStructure
NoChangeAtStructure
TripResponseGroup
groupTripResultStructure
TripSummaryStructure
TripStructure
LegStructure
TimedLegStructure
TransferLegStructure
ContinuousLegStructure
LegBoardStructure
LegAlightStructure
LegIntermediateStructure
PathGuidanceStructure
PathGuidanceSectionStructure
TransferDurationGroup
groupPathLinkStructure
MultiPointTripRequestGroup
groupMultiPointTripParamStructure
MultiPointTripPolicyGroup
groupMultiPointTripResponseGroup
groupMultiPointTripResultStructure
MultiPointWaitTimeGroup
groupTripStatusGroup
groupTripRequestGroup
groupTripParamStructure
TripDataFilterGroup
groupTripPolicyGroup
groupTripMobilityFilterGroup
groupTripContentFilterGroup
groupNotViaStructure
NoChangeAtStructure
TripResponseGroup
groupTripResultStructure
TripSummaryStructure
TripStructure
LegStructure
TimedLegStructure
TransferLegStructure
ContinuousLegStructure
LegBoardStructure
LegAlightStructure
LegIntermediateStructure
PathGuidanceStructure
PathGuidanceSectionStructure
TransferDurationGroup
groupPathLinkStructure
PathLinkEndStructure
MultiPointTripRequestGroup
groupMultiPointTripParamStructure
MultiPointTripPolicyGroup
groupMultiPointTripResponseGroup
groupMultiPointTripResultStructure
MultiPointWaitTimeGroup
groupTripStatusGroup
groupTripRefineRequestGroup
groupTripRefineParamStructure
TripRefineResponseGroup
groupIncludePlacesContext
0:1
xs:boolean
Whether the place context is needed. If a requestor has that information already, the response can be made slimmer, when set to false. Default is true.
IncludeSituationsContext
0:1
xs:boolean
Wheter the situation context is needed. If a requestor has that information by other means or can't process it, the response can be made slimmer, when set to false. Default is true
IncludeIntermediateStops
0:1
xs:boolean
Whether the result should include intermediate stops (between the passenger's board and alight stops).
IncludeFare
0:1
xs:boolean
Whether the result should include fare information.
IncludeOperatingDays
0:1
xs:boolean
Whether the result should include operating day information - as encoded bit string and in natural language.
TripSummaryOnly
0:1
xs:boolean
If true, then the response will contain only summaries of the found trips. Default is false.
NotViaStructure
| NNot-via restrictions for a TRIP, i.e. SCHEDULED STOP POINTs or STOP PLACEs that the TRIP is not allowed to pass through | ||||
The element contains only one element: | |||||
Then, the element contains one of the following elements: | |||||
a |
| -1:1 | →siri:StopPointRef | ||
b | -1:1 | Reference to a Stop Place |
NoChangeAtStructure
| no-change-at restrictions for a TRIP, i.e. SCHEDULED STOP POINTs or STOP PLACEs at which no TRANSFER is allowed within a TRIP. | ||||
The element contains only one element: | |||||
Then, the element contains one of the following elements: | |||||
a |
| -1:1 | →siri:StopPointRef | ||
b | -1:1 | Reference to a Stop Place |
TripResponseGroup
group
| Trip response structure. | ||||
TripResponse |
| 0:1 | Context to hold trip response objects that occur frequently. | ||
| 0:* | The trip results found by the server. |
TripResultStructure
| Structure for a single trip result and its accompanying error messages. | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | xs:NMTOKEN | Id of this trip result for referencing purposes. Unique within trip response. | ||
| 0:* | Error messages related to this trip result. | |||
Then, the element contains one of the following elements: | |||||
a |
| -1:1 | +Trip | Detailed information on trip. | |
b |
| -1:1 | Summary on trip. Only if requestor set TripSummaryOnly in request. | ||
| 0:* |
TripSummaryStructure
| Structure for trip overview information. | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | xs:NMTOKEN | Id of this trip for referencing purposes. Unique within trip response. | ||
| 0:1 | Describes the origin situation of this trip. | |||
| 0:1 | Describes the arrival situation of this trip. | |||
| 0:1 | xs:duration | Overall duration of the trip. | ||
| 0:1 | xs:dateTime | Departure time at origin. | ||
| 0:1 | xs:dateTime | Arrival time at destination. | ||
| 0:1 | xs:nonNegativeInteger | Number of public transport trip legs. | ||
| 0:1 | siri:DistanceType | Trip distance. | ||
OperatingDays |
| 0:1 | Bit string definition of operating days. | ||
| 0:1 | Textual description of the operation days, e.g. "monday to friday" or "not on holidays". | |||
0:* | Reference to situation message. Message details might be found in response context or through other communication channels. | ||||
| 0:1 | xs:anyType |
TripStructure
| [an extended form of PT TRIP in TM and NeTEx as it also includes the initial and final access legs to and from public transport] whole journey from passenger origin to passenger destination in one or more trip LEGs | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | xs:NMTOKEN | Id of this trip for referencing purposes. Unique within trip response. | ||
| 1:1 | xs:duration | Overall duration of the trip. | ||
| 1:1 | xs:dateTime | Departure time at origin. | ||
| 1:1 | xs:dateTime | Arrival time at destination. | ||
| 1:1 | xs:nonNegativeInteger | Number of interchanges. | ||
| 0:1 | siri:DistanceType | Trip distance. | ||
| 1:* | +Leg | Legs of the trip | ||
OperatingDays |
| 0:1 | Bit string definition of operating days. | ||
| 0:1 | Textual description of the operation days, e.g. "monday to friday" or "not on holidays". | |||
0:* | Reference to situation message. Message details might be found in response context or through other communication channels. | ||||
TripStatus |
| 0:1 | xs:boolean | Whether this trip is an additional one that has not been planned. Default is false. | |
| 0:1 | xs:boolean | Whether this trip is cancelled and will not be run. Default is false. | ||
| 0:1 | xs:boolean | Whether this trip deviates from the planned service pattern. Default is false. | ||
| 0:1 | xs:boolean | Whether this trip is delayed. Default is false. | ||
| 0:1 | xs:boolean | Whether this trip cannot be used, due to operational delays and impossible transfers. Default is false. | ||
| 0:1 | xs:anyType |
LegStructure
| a single stage of a TRIP that is made without change of MODE or service (ie: between each interchange) | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | xs:NMTOKEN | Id of this trip leg. Unique within trip result. | ||
| 0:1 | siri:ParticipantRefStructure | [equivalent of PARTICIPANT in SIRI] IT system that is participating in a communication with other participant(s) | ||
Then, the element contains one of the following elements: | |||||
a |
| -1:1 | |||
b |
| -1:1 | |||
c |
| -1:1 |
TimedLegStructure
| passenger TRIP LEG with timetabled schedule. Corresponds to a RIDE. | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | Stop/Station where boarding is done | |||
| 0:* | information about the intermediate passed stop points. | |||
| 1:1 | Stop/Station to alight | |||
| 1:1 | Service that is used for this trip leg. | |||
| 0:* | Attributes that are not valid on the whole service, but only on parts of the journey leg. | |||
OperatingDays |
| 0:1 | Bit string definition of operating days. | ||
| 0:1 | Textual description of the operation days, e.g. "monday to friday" or "not on holidays". | |||
| 0:1 | Geographic embedding of this leg. | |||
| 0:1 | xs:anyType |
TransferLegStructure
| [a specialised type of NAVIGATION PATH in TMv6] description of a LEG which links other LEGs of a TRIP where a TRANSFER between different LOCATIONs is required | ||||
The element contains a sequence of the following elements: | |||||
Then, the element contains one of the following elements: | |||||
a |
| -1:1 | Mode that is used for this interchange between public services. | ||
b |
| -1:1 | Mode that is used for this interchange between public services. | ||
| 1:1 | Stop/Station where boarding is done | |||
| 1:1 | Stop/Station to alight | |||
TimeWindow |
| 0:1 | xs:dateTime | Time at which window begins. | |
| 0:1 | xs:dateTime | Time at which window ends. | ||
TripContentFilter |
| 0:1 | xs:boolean | Whether the result should include intermediate stops (between the passenger's board and alight stops). | |
| 0:1 | xs:boolean | Whether the result should include fare information. | ||
| 0:1 | xs:boolean | Whether the result should include operating day information - as encoded bit string and in natural language. | ||
| 0:1 | xs:boolean | If true, then the response will contain only summaries of the found trips. Default is false. |
NotViaStructure
| NNot-via restrictions for a TRIP, i.e. SCHEDULED STOP POINTs or STOP PLACEs that the TRIP is not allowed to pass through | ||||
The element contains only one element: | |||||
Then, the element contains one of the following elements: | |||||
a |
| -1:1 | →siri:StopPointRef | ||
b | -1:1 | Reference to a Stop Place |
NoChangeAtStructure
| no-change-at restrictions for a TRIP, i.e. SCHEDULED STOP POINTs or STOP PLACEs at which no TRANSFER is allowed within a TRIP. | ||||
The element contains only one element: | |||||
Then, the element contains one of the following elements: | |||||
a |
| -1:1 | →siri:StopPointRef | ||
b | -1:1 | Reference to a Stop Place |
TripResponseGroup
group
| Trip response structure. | ||||
TripResponse |
| 0:1 | Context to hold trip response objects that occur frequently. | ||
| 0:* | The trip results found by the server. |
TripResultStructure
| Structure for a single trip result and its accompanying error messages. | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | xs:NMTOKEN | Id of this trip result for referencing purposes. Unique within trip response. | ||
| 0:* | Error messages related to this trip result. | |||
Then, the element contains one of the following elements: | |||||
a |
| -1:1 | +Trip | Detailed information on trip. | |
b |
| -1:1 | Summary on trip. Only if requestor set TripSummaryOnly in request. | ||
| 0:* |
TripSummaryStructure
| Structure for trip overview information. | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | xs:NMTOKEN | Id of this trip for referencing purposes. Unique within trip response. | ||
| 0:1 | Describes the origin situation of this trip. | |||
| 0:1 | Describes the arrival situation of this trip. | |||
| 0:1 | xs:duration | Overall duration of the trip. | ||
| 0:1 | xs:dateTime | Departure time at origin. | ||
| 0:1 | xs:dateTime | Arrival time at destination. | ||
| 0:1 | xs:nonNegativeInteger | Number of public transport trip legs. | ||
| 0:1 | siri:DistanceType | Trip distance. | ||
OperatingDays |
| 0:1 | Bit string definition of operating days. | ||
| 0:1 | Textual description of the operation days, e.g. "monday to friday" or "not on holidays". | |||
0:* | Reference to situation message. Message details might be found in response context or through other communication channels. | ||||
| 0:1 | xs:anyType |
TripStructure
| [an extended form of PT TRIP in TM and NeTEx as it also includes the initial and final access legs to and from public transport] whole journey from passenger origin to passenger destination in one or more trip LEGs | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | xs:NMTOKEN | Id of this trip for referencing purposes. Unique within trip response. | ||
| 1:1 | xs:duration | Overall duration of the trip. | ||
| 1:1 | xs:dateTime | Departure time at origin. | ||
| 1:1 | xs:dateTime | Arrival time at destination. | ||
| 1:1 | xs:nonNegativeInteger | Number of interchanges. | ||
| 0:1 | siri:DistanceType | Trip distance. | ||
| 1:* | +Leg | Legs of the trip | ||
OperatingDays |
| 0:1 | Bit string definition of operating days. | ||
| 0:1 | Textual description of the operation days, e.g. "monday to friday" or "not on holidays". | |||
0:* | Reference to situation message. Message details might be found in response context or through other communication channels. | ||||
TripStatus |
| 0:1 | xs:boolean | Whether this trip is an additional one that has not been planned. Default is false. | |
| 0:1 | xs:boolean | Whether this trip is cancelled and will not be run. Default is false. | ||
| 0:1 | xs:boolean | Whether this trip deviates from the planned service pattern. Default is false. | ||
| 0:1 | xs:boolean | Whether this trip is delayed. Default is false. | ||
| 0:1 | xs:boolean | Whether this trip cannot be used, due to operational delays and impossible transfers. Default is false. | ||
| 0:1 | xs:anyType |
LegStructure
| a single stage of a TRIP that is made without change of MODE or service (ie: between each interchange) | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | xs:NMTOKEN | Id of this trip leg. Unique within trip result. | ||
| 0:1 | siri:ParticipantRefStructure | [equivalent of PARTICIPANT in SIRI] IT system that is participating in a communication with other participant(s) | ||
Then, the element contains one of the following elements: | |||||
a |
| -1:1 | |||
b |
| -1:1 | |||
c |
| -1:1 |
TimedLegStructure
| passenger TRIP LEG with timetabled schedule. Corresponds to a RIDE. | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | Stop/Station where boarding is done | |||
| 0:* | information about the intermediate passed stop points. | |||
| 1:1 | Stop/Station to alight | |||
| 1:1 | Service that is used for this trip leg. | |||
| 0:* | Attributes that are not valid on the whole service, but only on parts of the journey leg. | |||
OperatingDays |
| 0:1 | Bit string definition of operating days. | ||
| 0:1 | Textual description of the operation days, e.g. "monday to friday" or "not on holidays". | |||
| 0:1 | Geographic embedding of this leg. | |||
| 0:1 | xs:anyType |
TransferLegStructure
| [a specialised type of NAVIGATION PATH in TMv6] description of a LEG which links other LEGs of a TRIP where a TRANSFER between different LOCATIONs is required | ||||
The element contains a sequence of the following elements: | |||||
Then, the element contains one of the following elements: | |||||
a |
| -1:1 | Mode that is used for this interchange between public services. | ||
b |
| -1:1 | Mode that is used for this interchange between public services. | ||
| 1:1 | Stop/Station where boarding is done | |||
| 1:1 | Stop/Station to alight | |||
TimeWindow |
| 0:1 | xs:dateTime | Time at which window begins. | |
| 0:1 | xs:dateTime | Time at which window ends. | ||
TransferDuration |
| 1:1 | xs:duration | Overall duration of this interchange. | |
| 0:1 | xs:duration | Walk time as part of the overall interchange duration. |