REST Resource: transitobject

Ressource: TransitObject

JSON-Darstellung
{
  "classReference": {
    object (TransitClass)
  },
  "ticketNumber": string,
  "passengerType": enum (PassengerType),
  "passengerNames": string,
  "tripId": string,
  "ticketStatus": enum (TicketStatus),
  "customTicketStatus": {
    object (LocalizedString)
  },
  "concessionCategory": enum (ConcessionCategory),
  "customConcessionCategory": {
    object (LocalizedString)
  },
  "ticketRestrictions": {
    object (TicketRestrictions)
  },
  "purchaseDetails": {
    object (PurchaseDetails)
  },
  "ticketLeg": {
    object (TicketLeg)
  },
  "ticketLegs": [
    {
      object (TicketLeg)
    }
  ],
  "hexBackgroundColor": string,
  "tripType": enum (TripType),
  "id": string,
  "classId": string,
  "version": string,
  "state": enum (State),
  "barcode": {
    object (Barcode)
  },
  "messages": [
    {
      object (Message)
    }
  ],
  "validTimeInterval": {
    object (TimeInterval)
  },
  "locations": [
    {
      object (LatLongPoint)
    }
  ],
  "hasUsers": boolean,
  "smartTapRedemptionValue": string,
  "hasLinkedDevice": boolean,
  "disableExpirationNotification": boolean,
  "infoModuleData": {
    object (InfoModuleData)
  },
  "imageModulesData": [
    {
      object (ImageModuleData)
    }
  ],
  "textModulesData": [
    {
      object (TextModuleData)
    }
  ],
  "linksModuleData": {
    object (LinksModuleData)
  },
  "appLinkData": {
    object (AppLinkData)
  },
  "activationStatus": {
    object (ActivationStatus)
  },
  "rotatingBarcode": {
    object (RotatingBarcode)
  },
  "deviceContext": {
    object (DeviceContext)
  },
  "heroImage": {
    object (Image)
  },
  "groupingInfo": {
    object (GroupingInfo)
  },
  "passConstraints": {
    object (PassConstraints)
  },
  "saveRestrictions": {
    object (SaveRestrictions)
  },
  "linkedObjectIds": [
    string
  ],
  "notifyPreference": enum (NotificationSettingsForUpdates),
  "valueAddedModuleData": [
    {
      object (ValueAddedModuleData)
    }
  ]
}
Felder
classReference

object (TransitClass)

Eine Kopie der übernommenen Felder der übergeordneten Klasse. Diese Felder werden bei einem GET-Vorgang abgerufen.

ticketNumber

string

Die Ticketnummer. Dies ist eine eindeutige Kennung für das Ticket im System des Verkehrsunternehmens.

passengerType

enum (PassengerType)

Die Anzahl der Passagiere.

passengerNames

string

Der Name bzw. die Namen der Fahrgäste, denen das Ticket zugewiesen ist. Das Feld passengerType oben soll Google Kontext zu diesem Feld geben.

tripId

string

Anhand dieser ID werden Tickets gruppiert, wenn der Nutzer mehrere Tickets für dieselbe Fahrt gespeichert hat.

ticketStatus

enum (TicketStatus)

Der Status des Tickets. Verwenden Sie für Status, die sich auf die Anzeige auswirken, stattdessen das Feld state.

customTicketStatus

object (LocalizedString)

Ein benutzerdefinierter Status, der für den Ticketstatus verwendet werden soll, wenn ticketStatus nicht die richtige Option bietet. ticketStatus und customTicketStatus dürfen nicht gleichzeitig festgelegt werden.

concessionCategory

enum (ConcessionCategory)

Die Ermäßigungskategorie für das Ticket.

customConcessionCategory

object (LocalizedString)

Eine benutzerdefinierte Kulanzzusage, die verwendet werden soll, wenn concessionCategory nicht die richtige Option bietet. concessionCategory und customConcessionCategory dürfen nicht gleichzeitig festgelegt werden.

ticketRestrictions

object (TicketRestrictions)

Informationen zu den Einschränkungen bei der Verwendung dieses Tickets. Beispielsweise, an welchen Wochentagen sie verwendet werden muss oder welche Routen zulässig sind.

purchaseDetails

object (PurchaseDetails)

Details zum Kauf dieses Tickets.

ticketLeg

object (TicketLeg)

Ein einzelner Flugabschnitt enthält Abflug- und Ankunftsinformationen sowie Informationen zum Einsteigen und zum Sitzplatz. Wenn mehr als ein Abschnitt angegeben werden soll, verwenden Sie stattdessen das Feld ticketLegs. ticketLeg und ticketLegs dürfen nicht gleichzeitig festgelegt werden.

ticketLegs[]

object (TicketLeg)

Jedes Ticket kann einen oder mehrere Abschnitte enthalten. Jeder Abschnitt enthält Informationen zu Abfahrt und Ankunft sowie zu Ein- und Ausstieg und Sitzplatz. Wenn nur ein Abschnitt angegeben werden soll, verwenden Sie stattdessen das Feld ticketLeg. ticketLeg und ticketLegs dürfen nicht gleichzeitig festgelegt werden.

hexBackgroundColor

string

Die Hintergrundfarbe der Karte bzw. des Tickets. Falls 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 ist, z. B. #ffcc00. Du kannst auch die Kurzversion des RGB-Triplets (#rgb) verwenden, z. B. #fc0.

tripType

enum (TripType)

Erforderlich. Die Art der Fahrt, die dieses Verkehrsobjekt darstellt. Legt den Titel der Karte/des Tickets und/oder das Symbol zwischen Startpunkt und Ziel fest.

id

string

Erforderlich. Die eindeutige Kennung für ein Objekt. Diese ID muss für alle Objekte eines Ausstellers eindeutig sein. Dieser Wert sollte das Format issuer ID haben.identifier, wobei von Google ausgegeben und von dir ausgewählt wird. Die eindeutige Kennung darf nur alphanumerische Zeichen, „.“ (Punkt), „_“ (Unterstrich) oder „-“ (Bindestriche) enthalten.

classId

string

Erforderlich. Die Klasse, die mit diesem Objekt verknüpft ist. Die Klasse muss vom selben Typ wie dieses Objekt sein, bereits vorhanden und genehmigt sein.

Klassen-IDs müssen dem Format issuer ID entsprechen.identifier, wobei von Google ausgegeben und von dir ausgewählt wird.

version
(deprecated)

string (int64 format)

Verworfen

state

enum (State)

Erforderlich. Der Status des Objekts. Mit diesem Feld wird festgelegt, wie ein Objekt in der App angezeigt wird. Ein inactive-Objekt wird beispielsweise in den Abschnitt „Abgelaufene Karten/Tickets“ verschoben.

barcode

object (Barcode)

Der Typ und Wert des Barcodes.

messages[]

object (Message)

Eine Reihe von Nachrichten, die in der App angezeigt werden. Alle Nutzer dieses Objekts erhalten die zugehörigen Nachrichten. Die maximale Anzahl dieser Felder ist 10.

validTimeInterval

object (TimeInterval)

Der Zeitraum, in dem dieses Objekt active ist und verwendet werden kann. Nach Ablauf dieses Zeitraums ändert sich der Status des Objekts in expired.

locations[]
(deprecated)

object (LatLongPoint)

Hinweis: Dieses Feld wird derzeit nicht zum Auslösen von Benachrichtigungen unterstützt.

hasUsers

boolean

Gibt an, ob das Objekt Nutzer hat. Dieses Feld wird von der Plattform festgelegt.

smartTapRedemptionValue

string

Der Wert, der für dieses Objekt über NFC an ein Smart-Bonus-zertifiziertes Terminal übertragen wird. Die Felder enableSmartTap und redemptionIssuers auf Klassenebene müssen ebenfalls richtig eingerichtet sein, damit die Karte bzw. das Ticket Smart-Bonus unterstützt. Es werden nur ASCII-Zeichen unterstützt.

hasLinkedDevice

boolean

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 mit seinem Gerät verknüpft. Nur für ausgewählte Partner bestimmt. Weitere Informationen erhalten Sie vom Support.

disableExpirationNotification

boolean

Gibt an, ob Benachrichtigungen ausdrücklich unterdrückt werden sollen. Wenn dieses Feld auf „wahr“ gesetzt ist, werden unabhängig vom Feld messages keine Ablaufbenachrichtigungen an den Nutzer gesendet. Standardmäßig ist dieses Feld auf „false“ gesetzt.

Derzeit kann dies nur für Angebote festgelegt werden.

infoModuleData

object (InfoModuleData)

Verworfen. Verwenden Sie stattdessen „textModulesData“.

imageModulesData[]

object (ImageModuleData)

Daten des Bildmoduls. Maximal werden ein Feld auf Objektebene und ein Feld auf Klassenobjektebene angezeigt.

textModulesData[]

object (TextModuleData)

Textmoduldaten. Wenn für den Kurs auch Textmoduldaten definiert sind, werden beide angezeigt. Es werden maximal 10 Felder des Objekts und 10 Felder der Klasse angezeigt.

activationStatus

object (ActivationStatus)

Der Aktivierungsstatus für das Objekt. Erforderlich, wenn für die Klasse activationOptions festgelegt ist.

rotatingBarcode

object (RotatingBarcode)

Der Typ und Wert des rotierenden Barcodes.

deviceContext

object (DeviceContext)

Gerätekontext, der mit dem Objekt verknüpft ist.

heroImage

object (Image)

Optionales Bannerbild, das auf der Vorderseite der Karte angezeigt wird. Ist keins vorhanden, wird das Hero-Image der Klasse angezeigt, sofern vorhanden. Wenn auch das Hero-Image des Kurses nicht vorhanden ist, wird nichts angezeigt.

groupingInfo

object (GroupingInfo)

Informationen, die steuern, wie Karten/Tickets gruppiert werden.

passConstraints

object (PassConstraints)

Einschränkungen für Karten/Tickets für das Objekt. Dazu gehört auch die Einschränkung des NFC- und Screenshot-Verhaltens.

saveRestrictions

object (SaveRestrictions)

Einschränkungen für das Objekt, die überprüft werden müssen, bevor der Nutzer versucht, die Karte bzw. das Ticket zu speichern. Diese Einschränkungen gelten nur während der Speicherzeit. Wenn sich die Einschränkungen ändern, nachdem ein Nutzer die Karte bzw. das Ticket gespeichert hat, werden die neuen Einschränkungen nicht auf eine bereits gespeicherte Karte bzw. ein bereits gespeichertes Ticket angewendet.

linkedObjectIds[]

string

„linkedObjectIds“ ist eine Liste anderer Objekte wie Veranstaltungstickets, Kundenkarten, Angebote, generische Karten/Tickets, Geschenkkarten, Fahrkarten und Bordkarten, die automatisch mit diesem Mobilitätsobjekt verknüpft werden sollen. Wenn ein Nutzer diese Fahrkarten gespeichert hat, werden diese verknüpften ObjectIds automatisch an die Wallet des Nutzers gesendet, es sei denn, er hat die Einstellung deaktiviert, um solche verknüpften Karten zu erhalten.

Achten Sie darauf, dass Objekte, die in „linkedObjectIds“ vorhanden sind, bereits eingefügt wurden. Andernfalls schlagen Aufrufe fehl. Verknüpfte Objekte können nicht mehr getrennt werden. Sie können keine Objekte verknüpfen, die einem anderen Aussteller gehören. Die Anzahl der Objekte, die mit einem einzelnen Objekt verknüpft werden können, ist begrenzt. Wenn das Limit erreicht ist, werden neue verknüpfte Objekte im Anruf stumm ignoriert.

Objekt-IDs müssen dem Format issuer ID entsprechen.identifier, wobei von Google ausgegeben und von dir ausgewählt wird.

notifyPreference

enum (NotificationSettingsForUpdates)

Gibt an, ob Feldaktualisierungen für dieses Objekt Benachrichtigungen auslösen sollen. Wenn diese Option auf NOTIFY gesetzt ist, versuchen wir, eine Benachrichtigung über die Aktualisierung eines Felds an die Nutzer auszulösen. Diese Benachrichtigungen werden nur an Nutzer gesendet, wenn das Feld auf einer Zulassungsliste steht. Wenn „DO_NOT_NOTIFY“ oder „NOTIFICATION_SETTINGS_UNSPECIFIED“ festgelegt ist, wird keine Benachrichtigung ausgelöst. Diese Einstellung ist temporär und muss bei jeder PATCH- oder UPDATE-Anfrage festgelegt werden. Andernfalls wird keine Benachrichtigung ausgelöst.

valueAddedModuleData[]

object (ValueAddedModuleData)

Optionale Daten zum Mehrwertmodul. Maximal zehn für das Objekt.

PassengerType

Enums
PASSENGER_TYPE_UNSPECIFIED
SINGLE_PASSENGER
singlePassenger

Alter Alias für SINGLE_PASSENGER. Verworfen.

MULTIPLE_PASSENGERS
multiplePassengers

Alter Alias für MULTIPLE_PASSENGERS. Verworfen.

TicketStatus

Enums
TICKET_STATUS_UNSPECIFIED
USED
used

Alter Alias für USED. Verworfen.

REFUNDED
refunded

Alter Alias für REFUNDED. Verworfen.

EXCHANGED
exchanged

Alter Alias für EXCHANGED. Verworfen.

ConcessionCategory

Enums
CONCESSION_CATEGORY_UNSPECIFIED
ADULT
adult

Alter Alias für ADULT. Verworfen.

CHILD
child

Alter Alias für CHILD. Verworfen.

SENIOR
senior

Alter Alias für SENIOR. Verworfen.

TicketRestrictions

JSON-Darstellung
{
  "routeRestrictions": {
    object (LocalizedString)
  },
  "routeRestrictionsDetails": {
    object (LocalizedString)
  },
  "timeRestrictions": {
    object (LocalizedString)
  },
  "otherRestrictions": {
    object (LocalizedString)
  }
}
Felder
routeRestrictions

object (LocalizedString)

Einschränkungen für befahrbare Routen Das kann beispielsweise der String „Nur reservierte CrossCountry-Züge“ sein.

routeRestrictionsDetails

object (LocalizedString)

Weitere Informationen zu routeRestrictions

timeRestrictions

object (LocalizedString)

Einschränkungen hinsichtlich der Häufigkeit, mit der dieses Ticket verwendet werden kann.

otherRestrictions

object (LocalizedString)

Zusätzliche Einschränkungen, die nicht in die Kategorien „Route“ oder „Uhrzeit“ fallen.

PurchaseDetails

JSON-Darstellung
{
  "purchaseReceiptNumber": string,
  "purchaseDateTime": string,
  "accountId": string,
  "confirmationCode": string,
  "ticketCost": {
    object (TicketCost)
  }
}
Felder
purchaseReceiptNumber

string

Belegnummer/-kennzeichnung, um den Ticketkauf über den Verkäufer zu verfolgen.

purchaseDateTime

string

Das Kaufdatum und die -uhrzeit des Tickets.

Datum/Uhrzeit im erweiterten ISO 8601-Format mit oder ohne Offset. Die Uhrzeit kann bis auf die Nanosekunde genau angegeben werden. Offsets können bis auf die Sekunde genau angegeben werden (obwohl Offset-Sekunden nicht in ISO 8601 enthalten sind).

Beispiel:

1985-04-12T23:20:50.52Z entspricht 20 Minuten und 50, 52 Sekunden nach der 23. Stunde am 12. April 1985 in UTC.

1985-04-12T19:20:50.52-04:00 entspricht 20 Minuten und 50, 52 Sekunden nach der 19. Stunde am 12. April 1985, 4 Stunden vor UTC (gleicher Zeitpunkt wie im obigen Beispiel). Falls die Veranstaltung in New York stattfindet, wäre dies die Entsprechung in Eastern Daylight Time (EDT). Der Offset variiert saisonal in Regionen mit Sommerzeit.

1985-04-12T19:20:50.52 entspricht 20 Minuten und 50, 52 Sekunden nach der 19. Stunde am 12. April 1985 ohne Offset-Angabe.

Ohne Offset-Informationen sind einige erweiterte Funktionen möglicherweise nicht verfügbar.

accountId

string

ID des Kontos, mit dem das Ticket gekauft wurde.

confirmationCode

string

Der Bestätigungscode für den Kauf. Dieser kann für mehrere verschiedene Tickets identisch sein und wird verwendet, um Tickets zu gruppieren.

ticketCost

object (TicketCost)

Der Preis des Tickets.

TicketCost

JSON-Darstellung
{
  "faceValue": {
    object (Money)
  },
  "purchasePrice": {
    object (Money)
  },
  "discountMessage": {
    object (LocalizedString)
  }
}
Felder
faceValue

object (Money)

Der Nennwert des Tickets.

purchasePrice

object (Money)

Der tatsächliche Kaufpreis des Tickets nach Abzug von Steuern und/oder Rabatten.

discountMessage

object (LocalizedString)

Eine Nachricht, in der alle angewendeten Rabatte beschrieben werden.

TicketLeg

JSON-Darstellung
{
  "originStationCode": string,
  "originName": {
    object (LocalizedString)
  },
  "destinationStationCode": string,
  "destinationName": {
    object (LocalizedString)
  },
  "departureDateTime": string,
  "arrivalDateTime": string,
  "fareName": {
    object (LocalizedString)
  },
  "carriage": string,
  "platform": string,
  "zone": string,
  "ticketSeat": {
    object (TicketSeat)
  },
  "ticketSeats": [
    {
      object (TicketSeat)
    }
  ],
  "transitOperatorName": {
    object (LocalizedString)
  },
  "transitTerminusName": {
    object (LocalizedString)
  }
}
Felder
originStationCode

string

Der Code der Starthaltestelle. Erforderlich, wenn destinationStationCode vorhanden ist oder originName nicht vorhanden ist.

originName

object (LocalizedString)

Der Name der Startstation. Erforderlich, wenn desinationName vorhanden ist oder originStationCode nicht vorhanden ist.

destinationStationCode

string

Der Code der Zielhaltestelle.

destinationName

object (LocalizedString)

Der Name des Ziels.

departureDateTime

string

Datum und Uhrzeit der Abreise. Dies ist erforderlich, wenn für das öffentliche Verkehrsmittelobjekt kein Gültigkeitszeitraum festgelegt ist.

Datum/Uhrzeit im erweiterten ISO 8601-Format mit oder ohne Offset. Die Uhrzeit kann bis auf die Nanosekunde genau angegeben werden. Offsets können bis auf die Sekunde genau angegeben werden (obwohl Offset-Sekunden nicht in ISO 8601 enthalten sind).

Beispiel:

1985-04-12T23:20:50.52Z entspricht 20 Minuten und 50, 52 Sekunden nach der 23. Stunde am 12. April 1985 in UTC.

1985-04-12T19:20:50.52-04:00 entspricht 20 Minuten und 50, 52 Sekunden nach der 19. Stunde am 12. April 1985, 4 Stunden vor UTC (gleicher Zeitpunkt wie im obigen Beispiel). Falls die Veranstaltung in New York stattfindet, wäre dies die Entsprechung in Eastern Daylight Time (EDT). Der Offset variiert saisonal in Regionen mit Sommerzeit.

1985-04-12T19:20:50.52 entspricht 20 Minuten und 50, 52 Sekunden nach der 19. Stunde am 12. April 1985 ohne Offset-Angabe.

Der Teil des Datums/der Uhrzeit ohne den Zeitunterschied wird als „lokales Datum/lokale Uhrzeit“ bezeichnet. Das sollte das lokale Datum und die lokale Uhrzeit der Startstation sein. Wenn die Abfahrt beispielsweise am 5. Juni 2018 um 20 Uhr am Startbahnhof erfolgt, sollte der Teil für Datum und Uhrzeit in der Ortszeit 2018-06-05T20:00:00 sein. Wenn das lokale Datum und die lokale Uhrzeit der Startstation 4 Stunden vor UTC liegen, kann ein Offset von -04:00 angehängt werden.

Ohne Offset-Informationen sind einige erweiterte Funktionen möglicherweise nicht verfügbar.

arrivalDateTime

string

Datum und Uhrzeit der Ankunft.

Datum/Uhrzeit im erweiterten ISO 8601-Format mit oder ohne Offset. Die Uhrzeit kann bis auf die Nanosekunde genau angegeben werden. Offsets können bis auf die Sekunde genau angegeben werden (obwohl Offset-Sekunden nicht in ISO 8601 enthalten sind).

Beispiel:

1985-04-12T23:20:50.52Z entspricht 20 Minuten und 50, 52 Sekunden nach der 23. Stunde am 12. April 1985 in UTC.

1985-04-12T19:20:50.52-04:00 entspricht 20 Minuten und 50, 52 Sekunden nach der 19. Stunde am 12. April 1985, 4 Stunden vor UTC (gleicher Zeitpunkt wie im obigen Beispiel). Falls die Veranstaltung in New York stattfindet, wäre dies die Entsprechung in Eastern Daylight Time (EDT). Der Offset variiert saisonal in Regionen mit Sommerzeit.

1985-04-12T19:20:50.52 entspricht 20 Minuten und 50, 52 Sekunden nach der 19. Stunde am 12. April 1985 ohne Offset-Angabe.

Der Teil des Datums/der Uhrzeit ohne den Zeitunterschied wird als „lokales Datum/lokale Uhrzeit“ bezeichnet. Dies sollte das lokale Datum und die lokale Uhrzeit der Zielstation sein. Wenn das Ereignis beispielsweise am 5. Juni 2018 um 20:00 Uhr an der Zielstation stattfindet, sollte der Teil mit Datum und Uhrzeit in lokaler Zeit 2018-06-05T20:00:00 sein. Wenn das lokale Datum und die lokale Uhrzeit an der Zielstation 4 Stunden vor UTC liegen, kann ein Offset von -04:00 angehängt werden.

Ohne Offset-Informationen sind einige erweiterte Funktionen möglicherweise nicht verfügbar.

fareName

object (LocalizedString)

Kurze Beschreibung/Name des Fahrpreises für diesen Streckenabschnitt. Beispiel: „Einmal verwenden – jederzeit“.

carriage

string

Der Name oder die Nummer des Zuges oder Schiffs, in den bzw. das der Fahrgast einsteigen muss.

platform

string

Der Bahnsteig oder das Tor, an dem der Fahrgast in den Wagen einsteigen kann.

zone

string

Die Zone für das Einsteigen auf dem Bahnsteig.

ticketSeat

object (TicketSeat)

Der reservierte Sitzplatz für die Passagiere. Wenn mehr als ein Sitzplatz angegeben werden soll, verwenden Sie stattdessen das Feld ticketSeats. ticketSeat und ticketSeats dürfen nicht gleichzeitig festgelegt werden.

ticketSeats[]

object (TicketSeat)

Der reservierte Sitzplatz für die Passagiere. Wenn nur ein Sitzplatz angegeben werden soll, verwenden Sie stattdessen das Feld ticketSeat. ticketSeat und ticketSeats dürfen nicht gleichzeitig festgelegt werden.

transitOperatorName

object (LocalizedString)

Der Name des Verkehrsunternehmens, das diesen Abschnitt einer Fahrt durchführt.

transitTerminusName

object (LocalizedString)

Endstation oder Ziel des Zuges/Busses usw.

TicketSeat

JSON-Darstellung
{
  "fareClass": enum (FareClass),
  "customFareClass": {
    object (LocalizedString)
  },
  "coach": string,
  "seat": string,
  "seatAssignment": {
    object (LocalizedString)
  }
}
Felder
fareClass

enum (FareClass)

Die Preisklasse des Sitzplatzes, für den ein Ticket gekauft wurde.

customFareClass

object (LocalizedString)

Eine benutzerdefinierte Preisklasse, die verwendet wird, wenn keine fareClass gilt. fareClass und customFareClass dürfen nicht gleichzeitig festgelegt werden.

coach

string

Die Kennung des Waggons, in dem sich der Sitzplatz befindet. z. B. „10“

seat

string

Die Kennung des Standorts des Sitzplatzes, für den das Ticket gilt. z. B. „42“. Wenn keine bestimmte Kennung vorhanden ist, verwenden Sie stattdessen seatAssigment.

seatAssignment

object (LocalizedString)

Die Sitzplatzzuweisung des Fahrgastes. z. B. „Kein bestimmter Sitzplatz“ Wird verwendet, wenn in seat keine bestimmte Kennung verwendet werden soll.

FareClass

Enums
FARE_CLASS_UNSPECIFIED
ECONOMY
economy

Alter Alias für ECONOMY. Verworfen.

FIRST
first

Alter Alias für FIRST. Verworfen.

BUSINESS
business

Alter Alias für BUSINESS. Verworfen.

TripType

Enums
TRIP_TYPE_UNSPECIFIED
ROUND_TRIP
roundTrip

Alter Alias für ROUND_TRIP. Verworfen.

ONE_WAY
oneWay

Alter Alias für ONE_WAY. Verworfen.

ActivationStatus

Der Aktivierungsstatus des Objekts. Dieses Feld enthält den Aktivierungsstatus, sofern das Asset eine Aktivierung unterstützt.

JSON-Darstellung
{
  "state": enum (State)
}
Felder
state

enum (State)

Status

Enums
UNKNOWN_STATE
NOT_ACTIVATED Nicht aktiviert (Standardstatus)
not_activated

Alter Alias für NOT_ACTIVATED. Verworfen.

ACTIVATED Aktiviert
activated

Alter Alias für ACTIVATED. Verworfen.

DeviceContext

Gerätekontext, der mit dem Objekt verknüpft ist.

JSON-Darstellung
{
  "deviceToken": string
}
Felder
deviceToken

string

Wenn festgelegt, werden Einlösungsinformationen nur bei Aktivierung des Objekts an das angegebene Gerät zurückgegeben. Sie sollte nicht als stabile Kennung verwendet werden, um das Gerät eines Nutzers nachzuverfolgen. Es kann bei den verschiedenen Karten/Tickets für dasselbe Gerät oder sogar bei verschiedenen Aktivierungen für dasselbe Gerät variieren. Bei dieser Einstellung müssen Aufrufer „hasLinkedDevice“ für das zu aktivierende Objekt festlegen.

Methoden

addmessage

Fügt dem Verkehrsobjekt, auf das durch die angegebene Objekt-ID verwiesen wird, eine Nachricht hinzu.

get

Gibt das Verkehrsobjekt mit der angegebenen Objekt-ID zurück.

insert

Ein Verkehrsobjekt mit der angegebenen ID und den angegebenen Eigenschaften wird eingefügt.

list

Gibt eine Liste aller Mobilitätsobjekte für eine bestimmte Aussteller-ID zurück.

patch

Aktualisiert das Verkehrsobjekt, auf das durch die angegebene Objekt-ID verwiesen wird.

update

Aktualisiert das Verkehrsobjekt, auf das durch die angegebene Objekt-ID verwiesen wird.