- Ressource: TransitObject
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- PassengerType
- TicketStatus
- ConcessionCategory
- TicketRestrictions
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- PurchaseDetails
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- TicketCost
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- TicketLeg
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- TicketSeat
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- FareClass
- TripType
- ActivationStatus
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- Bundesland
- DeviceContext
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- Methoden
Ressource: TransitObject
JSON-Darstellung |
---|
{ "classReference": { object ( |
Felder | |
---|---|
classReference |
Eine Kopie der übernommenen Felder der übergeordneten Klasse. Diese Felder werden während einer GET-Anfrage abgerufen. |
ticketNumber |
Die Nummer des Tickets. Dies ist eine eindeutige Kennung für das Ticket im System des Verkehrsunternehmens. |
passengerType |
Die Anzahl der Passagiere. |
passengerNames |
Die Namen der Passagiere, denen das Ticket zugewiesen ist. Das obige Feld |
tripId |
Diese ID wird verwendet, um Tickets zu gruppieren, wenn der Nutzer mehrere Tickets für dieselbe Fahrt gespeichert hat. |
ticketStatus |
Der Status des Tickets. Verwenden Sie für Status, die sich auf die Anzeige auswirken, stattdessen das Feld |
customTicketStatus |
Ein benutzerdefinierter Status, der für den Ticketstatuswert verwendet wird, wenn |
concessionCategory |
Die Ermäßigungskategorie für das Ticket. |
customConcessionCategory |
Eine benutzerdefinierte Konzessionskategorie, die verwendet werden soll, wenn |
ticketRestrictions |
Informationen zu den Einschränkungen bei der Nutzung dieses Tickets. z. B. welche Wochentage er verwendet werden muss oder welche Routen verwendet werden dürfen. |
purchaseDetails |
Kaufdetails für dieses Ticket. |
ticketLeg |
Eine Einzelfahrkarte enthält Abfahrts- und Ankunftsinformationen sowie Informationen zu Einstieg und Sitzplatz. Wenn mehr als ein Abschnitt angegeben werden soll, verwenden Sie stattdessen das Feld |
ticketLegs[] |
Jedes Ticket kann einen oder mehrere Streckenabschnitte umfassen. Für jeden Abschnitt gibt es Abfahrts- und Ankunftsinformationen sowie Informationen zu Boarding und Sitzplatz. Wenn nur ein Abschnitt angegeben werden soll, verwenden Sie stattdessen das Feld |
hexBackgroundColor |
Die Hintergrundfarbe der Karte. Wenn nicht festgelegt, wird die Hauptfarbe des Hero-Images verwendet, und wenn kein Hero-Image festgelegt ist, wird die Hauptfarbe des Logos verwendet. Das Format ist #rrggbb, wobei rrggbb ein hexadezimales RGB-Triplet wie |
tripType |
Erforderlich. Die Art der Fahrt, die dieses Verkehrsobjekt darstellt. Wird verwendet, um den Titel der Karte bzw. das Ticket und/oder das Symbol festzulegen, das zwischen Start- und Zielort verwendet werden soll. |
id |
Erforderlich. Die eindeutige Kennung für ein Objekt. Diese ID muss für alle Objekte eines Ausstellers eindeutig sein. Dieser Wert muss das Format issuer ID haben.identifier, wobei Ersteres von Google ausgestellt und Letzteres von Ihnen ausgewählt wird. Die eindeutige Kennung darf nur alphanumerische Zeichen sowie „.“, „_“ oder „-“ enthalten. |
classId |
Erforderlich. Die mit diesem Objekt verknüpfte Klasse. Die Klasse muss denselben Typ wie dieses Objekt haben, bereits vorhanden und genehmigt sein. Klassen-IDs müssen das Format issuer ID haben.identifier, wobei Ersteres von Google ausgestellt und Letzteres von Ihnen ausgewählt wird. |
version |
Verworfen |
state |
Erforderlich. Der Status des Objekts. Mit diesem Feld wird festgelegt, wie ein Objekt in der App angezeigt wird. Beispielsweise wird ein |
barcode |
Typ und Wert des Barcodes. |
messages[] |
Ein Array von Mitteilungen, die in der App angezeigt werden. Alle Nutzer dieses Objekts erhalten die zugehörigen Nachrichten. Die maximale Anzahl dieser Felder ist 10. |
validTimeInterval |
Der Zeitraum, in dem dieses Objekt |
locations[] |
Hinweis: Dieses Feld wird derzeit nicht zum Auslösen von Geo-Benachrichtigungen unterstützt. |
hasUsers |
Gibt an, ob das Objekt Nutzer hat. Dieses Feld wird von der Plattform festgelegt. |
smartTapRedemptionValue |
Der Wert, der für dieses Objekt über NFC an ein Smart-Bonus-zertifiziertes Terminal übertragen wird. Die Felder auf Klassenebene |
hasLinkedDevice |
Gibt an, ob dieses Objekt derzeit mit einem einzelnen Gerät verknüpft ist. Dieses Feld wird von der Plattform festgelegt, wenn ein Nutzer das Objekt speichert und es mit seinem Gerät verknüpft. Zur Verwendung durch ausgewählte Partner vorgesehen. Weitere Informationen erhalten Sie vom Support. |
disableExpirationNotification |
Gibt an, ob Benachrichtigungen explizit unterdrückt werden sollen. Wenn dieses Feld auf „true“ gesetzt ist, werden Benachrichtigungen zu Ablaufdaten an den Nutzer unabhängig vom Feld Diese Option kann derzeit nur für Angebote festgelegt werden. |
infoModuleData |
Verworfen. Verwenden Sie stattdessen textModulesData. |
imageModulesData[] |
Bildmoduldaten. Es werden maximal ein Feld aus der Objektebene und eines auf der Klassenobjektebene angezeigt. |
textModulesData[] |
Textmoduldaten. Wenn auch Textmoduldaten für die Klasse definiert sind, werden beide angezeigt. Die maximale Anzahl der angezeigten Felder beträgt 10 vom -Objekt und 10 aus der Klasse. |
linksModuleData |
Linkmoduldaten. Wenn Linkmoduldaten ebenfalls für die Klasse definiert sind, werden beide angezeigt. |
appLinkData |
Optionaler App- oder Websitelink, der als Schaltfläche auf der Vorderseite der Karte bzw. des Tickets angezeigt wird. Wenn AppLinkData für das entsprechende Klassenobjekt bereitgestellt wird, wird nur das AppLinkData-Objekt angezeigt. |
activationStatus |
Der Aktivierungsstatus für das Objekt. Erforderlich, wenn für die Klasse |
rotatingBarcode |
Typ und Wert des rotierenden Barcodes. |
deviceContext |
Gerätekontext, der dem Objekt zugeordnet ist. |
heroImage |
Optionales Bannerbild, das auf der Vorderseite der Karte angezeigt wird Ist keins vorhanden, wird gegebenenfalls das Hero-Image des Kurses angezeigt. Wenn auch kein Hero-Image des Kurses vorhanden ist, wird nichts angezeigt. |
groupingInfo |
Informationen, die steuern, wie Karten/Tickets gruppiert werden. |
passConstraints |
Übergeben Sie die Einschränkungen für das Objekt. Dazu gehört auch das Einschränken von NFC- und Screenshot-Verhalten. |
saveRestrictions |
Einschränkungen für das Objekt, das überprüft werden muss, bevor der Nutzer versucht, die Karte bzw. das Ticket zu speichern. Diese Einschränkungen werden nur beim Speichern angewendet. Wenn sich die Einschränkungen ändern, nachdem ein Nutzer die Karte bzw. das Ticket gespeichert hat, werden die neuen Einschränkungen nicht auf bereits gespeicherte Karten/Tickets angewendet. |
PassengerType
Enums | |
---|---|
PASSENGER_TYPE_UNSPECIFIED |
|
SINGLE_PASSENGER |
|
singlePassenger |
Alter Alias für |
MULTIPLE_PASSENGERS |
|
multiplePassengers |
Alter Alias für |
TicketStatus
Enums | |
---|---|
TICKET_STATUS_UNSPECIFIED |
|
USED |
|
used |
Alter Alias für |
REFUNDED |
|
refunded |
Alter Alias für |
EXCHANGED |
|
exchanged |
Alter Alias für |
ConcessionCategory
Enums | |
---|---|
CONCESSION_CATEGORY_UNSPECIFIED |
|
ADULT |
|
adult |
Alter Alias für |
CHILD |
|
child |
Alter Alias für |
SENIOR |
|
senior |
Alter Alias für |
TicketRestrictions
JSON-Darstellung |
---|
{ "routeRestrictions": { object ( |
Felder | |
---|---|
routeRestrictions |
Beschränkungen für mögliche Routen Dies kann beispielsweise der String "Reservierte Cross-Country-Züge" sein. |
routeRestrictionsDetails |
Weitere Informationen zu den |
timeRestrictions |
Einschränkungen für die Nutzungszeiten dieses Tickets. |
otherRestrictions |
Zusätzliche Einschränkungen, die nicht unter die „Route“ fallen oder „Uhrzeit“ Kategorien. |
PurchaseDetails
JSON-Darstellung |
---|
{
"purchaseReceiptNumber": string,
"purchaseDateTime": string,
"accountId": string,
"confirmationCode": string,
"ticketCost": {
object ( |
Felder | |
---|---|
purchaseReceiptNumber |
Belegnummer/-ID zur Nachverfolgung des Ticketkaufs über die Stelle, die das Ticket verkauft hat |
purchaseDateTime |
Datum und Uhrzeit des Kaufs des Tickets. Datum/Uhrzeit im erweiterten ISO 8601-Format, mit oder ohne Offset. Die Zeit kann bis auf die Nanosekunde genau angegeben werden. Offsets können sekundengenau angegeben werden, auch wenn Offset-Sekunden nicht in ISO 8601 enthalten sind. Beispiel:
Ohne Versatzinformationen sind einige Rich-Funktionen möglicherweise nicht verfügbar. |
accountId |
ID des Kontos, das für den Kauf des Tickets verwendet wurde. |
confirmationCode |
Der Bestätigungscode für den Kauf. Sie kann für mehrere verschiedene Tickets identisch sein und wird verwendet, um Tickets zu gruppieren. |
ticketCost |
Der Preis des Tickets. |
TicketCost
JSON-Darstellung |
---|
{ "faceValue": { object ( |
Felder | |
---|---|
faceValue |
Der Nennbetrag des Tickets. |
purchasePrice |
Der tatsächliche Kaufpreis des Tickets nach Abzug von Steuern und/oder Rabatten. |
discountMessage |
Eine Nachricht, in der alle angewendeten Rabatte beschrieben werden. |
TicketLeg
JSON-Darstellung |
---|
{ "originStationCode": string, "originName": { object ( |
Felder | |
---|---|
originStationCode |
Der Code der Starthaltestelle. Dies ist erforderlich, wenn |
originName |
Der Name der Starthaltestelle. Dies ist erforderlich, wenn |
destinationStationCode |
Code der Zielhaltestelle. |
destinationName |
Der Name des Ziels. |
departureDateTime |
Datum und Uhrzeit der Abreise. Dies ist erforderlich, wenn für das Transit-Objekt kein Gültigkeitszeitintervall festgelegt ist. Datum/Uhrzeit im erweiterten ISO 8601-Format, mit oder ohne Offset. Die Zeit kann bis auf die Nanosekunde genau angegeben werden. Offsets können sekundengenau angegeben werden, auch wenn Offset-Sekunden nicht in ISO 8601 enthalten sind. Beispiel:
Der Teil der Datums-/Uhrzeitangabe ohne Versatz wird als "lokales Datum/die lokale Uhrzeit" betrachtet. Dies sollte das lokale Datum und die lokale Uhrzeit an der Starthaltestelle sein. Wenn die Abfahrt beispielsweise am 5. Juni 2018 in der 20. Stunde am Startbahnhof stattfindet, sollte der lokale Datums-/Uhrzeitteil Ohne Versatzinformationen sind einige Rich-Funktionen möglicherweise nicht verfügbar. |
arrivalDateTime |
Datum und Uhrzeit der Ankunft. Datum/Uhrzeit im erweiterten ISO 8601-Format, mit oder ohne Offset. Die Zeit kann bis auf die Nanosekunde genau angegeben werden. Offsets können sekundengenau angegeben werden, auch wenn Offset-Sekunden nicht in ISO 8601 enthalten sind. Beispiel:
Der Teil der Datums-/Uhrzeitangabe ohne Versatz wird als "lokales Datum/die lokale Uhrzeit" betrachtet. Dies sollte das lokale Datum und die lokale Uhrzeit an der Zielhaltestelle sein. Wenn die Veranstaltung beispielsweise um die 20. Stunde des 5. Juni 2018 an der Zielstation stattfindet, sollte der lokale Datums-/Uhrzeitteil Ohne Versatzinformationen sind einige Rich-Funktionen möglicherweise nicht verfügbar. |
fareName |
Kurze Beschreibung/Name des Preises für diesen Streckenabschnitt. z. B. „Anytime Single Use“ (Jederzeitige Einzelnutzung) |
carriage |
Name/Nummer des Zugs oder Schiffes, an dem der Passanten einsteigen muss. |
platform |
Der Bahnsteig oder das Gate, an dem der Fahrgast zusteigen kann. |
zone |
Der Einstiegsbereich innerhalb des Bahnsteigs. |
ticketSeat |
Der für den/die Passagier(e) reservierte Sitzplatz. Wenn mehr als ein Sitzplatz angegeben werden soll, verwenden Sie stattdessen das Feld |
ticketSeats[] |
Der für den/die Passagier(e) reservierte Sitzplatz. Wenn nur ein Sitzplatz angegeben werden soll, verwenden Sie stattdessen das Feld |
transitOperatorName |
Der Name des Betreibers, der diesen Abschnitt einer Fahrt durchführt. |
transitTerminusName |
Endhaltestelle oder Ziel von Zug/Bus usw. |
TicketSeat
JSON-Darstellung |
---|
{ "fareClass": enum ( |
Felder | |
---|---|
fareClass |
Die Preisklasse des Ticketplatzes. |
customFareClass |
Eine eigene Preisklasse, die verwendet wird, wenn keine |
coach |
Die Kennung des Zugwaggons oder Waggons, in dem sich der Fahrkartenplatz befindet. z. B. „10“ |
seat |
Die Kennung des Sitzplatzes. z. B. „42“. Wenn es keine spezifische Kennung gibt, verwenden Sie stattdessen |
seatAssignment |
Die Sitzzuweisung des Passagiers. z. B. „kein bestimmter Sitzplatz“. Zu verwenden, wenn keine spezifische Kennung in |
FareClass
Enums | |
---|---|
FARE_CLASS_UNSPECIFIED |
|
ECONOMY |
|
economy |
Alter Alias für |
FIRST |
|
first |
Alter Alias für |
BUSINESS |
|
business |
Alter Alias für |
TripType
Enums | |
---|---|
TRIP_TYPE_UNSPECIFIED |
|
ROUND_TRIP |
|
roundTrip |
Alter Alias für |
ONE_WAY |
|
oneWay |
Alter Alias für |
ActivationStatus
Der Aktivierungsstatus des Objekts. Dieses Feld enthält den Aktivierungsstatus, wenn das Wert die Aktivierung unterstützt.
JSON-Darstellung |
---|
{
"state": enum ( |
Felder | |
---|---|
state |
|
Status
Enums | |
---|---|
UNKNOWN_STATE |
|
NOT_ACTIVATED |
Nicht aktiviert (Standardstatus) |
not_activated |
Alter Alias für |
ACTIVATED |
Aktiviert |
activated |
Alter Alias für |
DeviceContext
Gerätekontext, der dem Objekt zugeordnet ist.
JSON-Darstellung |
---|
{ "deviceToken": string } |
Felder | |
---|---|
deviceToken |
Wenn festgelegt, werden Einlösungsinformationen nur bei Aktivierung des Objekts an das angegebene Gerät zurückgegeben. Er sollte nicht als stabile Kennung zur Verfolgung des Nutzergeräts verwendet werden. Sie kann sich bei verschiedenen Karten/Tickets für dasselbe Gerät oder sogar bei verschiedenen Aktivierungen für dasselbe Gerät ändern. Wenn diese Option festgelegt ist, müssen Aufrufer für das zu aktivierende Objekt auch „hasLinkedDevice“ festlegen. |
Methoden |
|
---|---|
|
Fügt dem Verkehrsobjekt, auf das von der angegebenen Objekt-ID verwiesen wird, eine Nachricht hinzu. |
|
Gibt das Verkehrsobjekt mit der angegebenen Objekt-ID zurück. |
|
Fügt ein Verkehrsobjekt mit der angegebenen ID und den angegebenen Eigenschaften ein. |
|
Gibt eine Liste aller Verkehrsobjekte für eine bestimmte Aussteller-ID zurück. |
|
Aktualisiert das Verkehrsobjekt, auf das von der angegebenen Objekt-ID verwiesen wird. |
|
Aktualisiert das Verkehrsobjekt, auf das von der angegebenen Objekt-ID verwiesen wird. |