Skip to content

Commit

Permalink
Status Service (#216)
Browse files Browse the repository at this point in the history 
Co-authored-by: Stefan de Konink <[email protected]>
Co-authored-by: Stephan Großberndt <[email protected]>
  • Loading branch information
@ue71603 @skinkie @sgrossberndt
3 people authored Apr 14, 2023
1 parent a77556f commit 18a10a2
Show file tree
Hide file tree
Showing 9 changed files with 188 additions and 18 deletions.
1 change: 1 addition & 0 deletions OJP/OJP_All.xsd
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,5 @@
<xs:include schemaLocation="OJP_TripInfo.xsd"/>
<xs:include schemaLocation="OJP_Trips.xsd"/>
<xs:include schemaLocation="OJP_Utility.xsd"/>
<xs:include schemaLocation="OJP_Status.xsd"/>
</xs:schema>
9 changes: 9 additions & 0 deletions OJP/OJP_Common.xsd
View file
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,15 @@
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:simpleType name="Percentage">
<xs:annotation>
<xs:documentation>A percentage value between 0 and 100</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:decimal">
<xs:minInclusive value="0.0"/>
<xs:maxInclusive value="100.0"/>
</xs:restriction>
</xs:simpleType>
<xs:complexType name="AreaStructure">
<xs:annotation>
<xs:documentation>Area described as a polygon.</xs:documentation>
Expand Down
9 changes: 0 additions & 9 deletions OJP/OJP_FareSupport.xsd
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,15 +18,6 @@
<xs:enumeration value="economy"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="Percentage">
<xs:annotation>
<xs:documentation>A percentage value between 0 and 100</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:decimal">
<xs:minInclusive value="0.0"/>
<xs:maxInclusive value="100.0"/>
</xs:restriction>
</xs:simpleType>
<xs:annotation>
<xs:documentation>========================================== Fare Authority ==========================================</xs:documentation>
</xs:annotation>
Expand Down
26 changes: 26 additions & 0 deletions OJP/OJP_Requests.xsd
View file
Original file line number Diff line number Diff line change
Expand Up @@ -194,6 +194,32 @@
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:annotation>
<xs:documentation>========================================== Status Service ==========================================</xs:documentation>
</xs:annotation>
<xs:element name="OJPStatusRequest" type="OJPStatusRequestStructure" substitutionGroup="siri:AbstractFunctionalServiceRequest"/>
<xs:complexType name="OJPStatusRequestStructure">
<xs:complexContent>
<xs:extension base="AbstractOJPServiceRequestStructure">
<xs:sequence>
<xs:element ref="siri:Extensions" minOccurs="0"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:element name="OJPStatusDelivery" type="OJPStatusDeliveryStructure" substitutionGroup="siri:AbstractFunctionalServiceDelivery"/>
<xs:complexType name="OJPStatusDeliveryStructure">
<xs:complexContent>
<xs:extension base="siri:AbstractServiceDeliveryStructure">
<xs:sequence>
<xs:element ref="OJPStatusRequest" minOccurs="0"/>
<xs:group ref="ServiceResponseContextGroup"/>
<xs:group ref="OJPStatusResponseGroup"/>
<xs:element ref="siri:Extensions" minOccurs="0"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:annotation>
<xs:documentation>========================================== TripRefine Service ==========================================</xs:documentation>
</xs:annotation>
Expand Down
72 changes: 72 additions & 0 deletions OJP/OJP_Status.xsd
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns="http://www.vdv.de/ojp" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:siri="http://www.siri.org.uk/siri" targetNamespace="http://www.vdv.de/ojp" elementFormDefault="qualified" attributeFormDefault="unqualified" id="OJP_siri_service">
<xs:annotation>
<xs:documentation>OJP/OJP_Status.xsd - OJP Status request and response</xs:documentation>
</xs:annotation>
<xs:import namespace="http://www.siri.org.uk/siri" schemaLocation="../siri/siri_model/siri_all-v2.0.xsd"/>
<xs:include schemaLocation="OJP_All.xsd"/>
<xs:import namespace="http://www.siri.org.uk/siri" schemaLocation="../siri/siri_model/siri_modes-v1.1.xsd"/>
<xs:annotation>
<xs:documentation>=============================== Status Service ==========================================</xs:documentation>
</xs:annotation>
<xs:simpleType name="StatusProblemTypeEnumeration">
<xs:annotation>
<xs:documentation>Types of problems that may be returned in responses to status requests.</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:string">
<xs:enumeration value="STATUS_INSTANCE_USAGE_DEPRECATED">
<xs:annotation>
<xs:documentation>Usage of this instance is deprecated. Contact the provider for more information.</xs:documentation>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="STATUS_OTHER">
<xs:annotation>
<xs:documentation>A problem has occurred that does not have a specific problem type.</xs:documentation>
</xs:annotation>
</xs:enumeration>
</xs:restriction>
</xs:simpleType>
<xs:element name="StatusProblemType" type="StatusProblemTypeEnumeration" substitutionGroup="ErrorType"/>
<xs:element name="OJPStatusResponse" type="OJPStatusResponseStructure" substitutionGroup="siri:AbstractFunctionalServiceCapabilitiesResponse"/>
<xs:complexType name="OJPStatusResponseStructure">
<xs:complexContent>
<xs:extension base="siri:AbstractServiceCapabilitiesResponseStructure">
<xs:sequence>
<xs:group ref="ServiceResponseContextGroup"/>
<xs:group ref="OJPStatusResponseGroup"/>
<xs:element ref="siri:Extensions" minOccurs="0"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:annotation>
<xs:documentation>=============================== Status Response Group ==========================================</xs:documentation>
</xs:annotation>
<xs:group name="OJPStatusResponseGroup">
<xs:annotation>
<xs:documentation>Status response group.</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="ServiceStarted" type="xs:dateTime" minOccurs="0">
<xs:annotation>
<xs:documentation>Time when the service was started.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="ServiceReady" type="xs:dateTime" minOccurs="0">
<xs:annotation>
<xs:documentation>Time when the service started responding to queries.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="LastTimetableUpdate" type="xs:dateTime" minOccurs="0">
<xs:annotation>
<xs:documentation>Time when the timetable was last updated.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="ServerBuildVersion" type="xs:normalizedString" minOccurs="0">
<xs:annotation>
<xs:documentation>Information about the server build.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:group>
</xs:schema>
55 changes: 46 additions & 9 deletions docs/generated/index.html
View file

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions docs/schema-collection.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,5 @@
<xi:include href="../OJP/OJP_ModesSupport.xsd"/>
<xi:include href="../OJP/OJP_SituationSupport.xsd"/>
<xi:include href="../OJP/OJP_Utility.xsd"/>
<xi:include href="../OJP/OJP_Status.xsd"/>
</schema-collection>
13 changes: 13 additions & 0 deletions examples/functions/status/OJPStatus_Request.xml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<?xml version="1.0" encoding="UTF-8"?>
<OJP xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.siri.org.uk/siri" xmlns:ojp="http://www.vdv.de/ojp" version="1.1-dev" xsi:schemaLocation="http://www.siri.org.uk/siri ../../../OJP.xsd">
<OJPRequest>
<ServiceRequest>
<RequestTimestamp>2020-01-19T12:00:00Z</RequestTimestamp>
<RequestorRef>IRMA</RequestorRef>
<ojp:OJPStatusRequest>
<RequestTimestamp>2020-01-19T12:00:00Z</RequestTimestamp>
<MessageIdentifier>4711</MessageIdentifier>
</ojp:OJPStatusRequest>
</ServiceRequest>
</OJPRequest>
</OJP>
20 changes: 20 additions & 0 deletions examples/functions/status/OJPStatus_Response.xml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
<?xml version="1.0" encoding="UTF-8"?>
<siri:OJP xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:siri="http://www.siri.org.uk/siri" xmlns:ojp="http://www.vdv.de/ojp" version="1.1-dev" xsi:schemaLocation="http://www.siri.org.uk/siri ../../../OJP.xsd">
<siri:OJPResponse>
<siri:ServiceDelivery>
<siri:ResponseTimestamp>2020-10-01T17:54:38Z</siri:ResponseTimestamp>
<siri:ProducerRef>OJPCH_Prod</siri:ProducerRef>
<siri:Status>true</siri:Status>
<ojp:OJPStatusDelivery>
<siri:ResponseTimestamp>2020-10-01T17:54:38Z</siri:ResponseTimestamp>
<siri:RequestMessageRef>4711</siri:RequestMessageRef>
<siri:Status>true</siri:Status>
<ojp:CalcTime>20</ojp:CalcTime>
<ojp:ServiceStarted>2022-06-27T11:08:45Z</ojp:ServiceStarted>
<ojp:ServiceReady>2022-06-27T11:08:49Z</ojp:ServiceReady>
<ojp:LastTimetableUpdate>2022-08-23T11:08:45Z</ojp:LastTimetableUpdate>
<ojp:ServerBuildVersion>12.2.1.2 (2022-05-03)</ojp:ServerBuildVersion>
</ojp:OJPStatusDelivery>
</siri:ServiceDelivery>
</siri:OJPResponse>
</siri:OJP>

0 comments on commit 18a10a2

Please sign in to comment.