Transitobject: patch

Requires authorization

Updates the transit object referenced by the given object ID. This method supports patch semantics.

Note about arrays: Patch requests that contain arrays replace the existing array with the one you provide. You cannot modify, add, or delete items in an array in a piecemeal fashion.

Request

HTTP request

PATCH https://www.googleapis.com/walletobjects/v1/transitObject/resourceId

Parameters

Parameter name Value Description
Path parameters
resourceId string The unique identifier for an object. This ID must be unique across all objects from an issuer. This value should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you. The unique identifier should only include alphanumeric characters, '.', '_', or '-'.

Authorization

This request requires authorization with the following scope (read more about authentication and authorization).

Scope
https://www.googleapis.com/auth/wallet_object.issuer

Request body

In the request body, supply the relevant portions of a Transitobject resource, according to the rules of patch semantics, with the following properties:

Property name Value Description Notes
Optional Properties
barcode nested object The barcode type and value. writable
barcode.alternateText string An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned. writable
barcode.type string The type of barcode.

Acceptable values are:
  • "aztec"
  • "codabar"
  • "code128"
  • "code39"
  • "dataMatrix"
  • "ean13"
  • "ean8"
  • "itf14"
  • "pdf417"
  • "qrCode"
  • "textOnly"
  • "upcA"
  • "upcE"
writable
barcode.value string The value encoded in the barcode. writable
classId string The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved.

Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
writable
concessionCategory string The concession category for the ticket.

Acceptable values are:
  • "adult"
  • "child"
  • "senior"
writable
customConcessionCategory nested object A custom concession category to use when concessionCategory does not provide the right option. Both concessionCategory and customConcessionCategory may not be set. writable
customConcessionCategory.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
customConcessionCategory.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
customConcessionCategory.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
customConcessionCategory.translatedValues[] list Contains the translations for the string. writable
customConcessionCategory.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
customConcessionCategory.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
customTicketStatus nested object A custom status to use for the ticket status value when ticketStatus does not provide the right option. Both ticketStatus and customTicketStatus may not be set. writable
customTicketStatus.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
customTicketStatus.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
customTicketStatus.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
customTicketStatus.translatedValues[] list Contains the translations for the string. writable
customTicketStatus.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
customTicketStatus.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
hexBackgroundColor string The background color for the card. If not set the dominant color of the hero image is used, and if no hero image is set, the dominant color of the logo is used. The format is #rrggbb where rrggbb is a hex RGB triplet, such as #ffcc00. You can also use the shorthand version of the RGB triplet which is #rgb, such as #fc0. writable
imageModulesData[] list Image module data. If image modules data is also defined on the class, those will be merged with the image data defined on the object. The maximum number of these fields (combined with the class) is 1. writable
imageModulesData[].mainImage nested object A 100% width image. writable
imageModulesData[].mainImage.sourceUri nested object The URI for the image. writable
imageModulesData[].mainImage.sourceUri.description string The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.

Note that in some contexts this text is not used, such as when description is part of an image.
writable
imageModulesData[].mainImage.sourceUri.id string The ID associated with a uri. This field is here to enable ease of management of uris. writable
imageModulesData[].mainImage.sourceUri.localizedDescription nested object Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. writable
imageModulesData[].mainImage.sourceUri.localizedDescription.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
imageModulesData[].mainImage.sourceUri.localizedDescription.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
imageModulesData[].mainImage.sourceUri.localizedDescription.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
imageModulesData[].mainImage.sourceUri.localizedDescription.translatedValues[] list Contains the translations for the string. writable
imageModulesData[].mainImage.sourceUri.localizedDescription.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
imageModulesData[].mainImage.sourceUri.localizedDescription.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
imageModulesData[].mainImage.sourceUri.uri string The location of a web page, image, or other resource. URIs in the LinksModuleData module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme. writable
infoModuleData.labelValueRows[].columns[].label string The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout. writable
infoModuleData.labelValueRows[].columns[].localizedLabel nested object Translated strings for the label. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.

writable
infoModuleData.labelValueRows[].columns[].localizedLabel.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
infoModuleData.labelValueRows[].columns[].localizedLabel.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
infoModuleData.labelValueRows[].columns[].localizedLabel.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
infoModuleData.labelValueRows[].columns[].localizedLabel.translatedValues[] list Contains the translations for the string. writable
infoModuleData.labelValueRows[].columns[].localizedLabel.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
infoModuleData.labelValueRows[].columns[].localizedLabel.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
infoModuleData.labelValueRows[].columns[].localizedValue nested object Translated strings for the value. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout. writable
infoModuleData.labelValueRows[].columns[].localizedValue.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
infoModuleData.labelValueRows[].columns[].localizedValue.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
infoModuleData.labelValueRows[].columns[].localizedValue.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
infoModuleData.labelValueRows[].columns[].localizedValue.translatedValues[] list Contains the translations for the string. writable
infoModuleData.labelValueRows[].columns[].localizedValue.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
infoModuleData.labelValueRows[].columns[].localizedValue.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
infoModuleData.labelValueRows[].columns[].value string The value for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout. writable
linksModuleData nested object Links module data. If links module data is also defined on the class, both will be displayed. The maximum number of these fields (combined with the class) is 10. writable
linksModuleData.uris[] list The list of URIs. writable
linksModuleData.uris[].description string The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.

Note that in some contexts this text is not used, such as when description is part of an image.
writable
linksModuleData.uris[].id string The ID associated with a uri. This field is here to enable ease of management of uris. writable
linksModuleData.uris[].localizedDescription nested object Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. writable
linksModuleData.uris[].localizedDescription.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
linksModuleData.uris[].localizedDescription.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
linksModuleData.uris[].localizedDescription.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
linksModuleData.uris[].localizedDescription.translatedValues[] list Contains the translations for the string. writable
linksModuleData.uris[].localizedDescription.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
linksModuleData.uris[].localizedDescription.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
linksModuleData.uris[].uri string The location of a web page, image, or other resource. URIs in the LinksModuleData module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme. writable
messages[] list An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10. writable
messages[].body string The message body. writable
messages[].displayInterval nested object The period of time that the message will be displayed to users. You can define both a startTime and endTime for each message. A message is displayed immediately after a Wallet Object is inserted unless a startTime is set. The message will appear in a list of messages indefinitely if endTime is not provided. writable
messages[].displayInterval.end nested object End time of the interval.

Offset is not required. If an offset is provided and start time is set, start must also include an offset.
writable
messages[].displayInterval.end.date string An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601).

For example:

1985-04-12T23:20:50.52Z would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC.

1985-04-12T19:20:50.52-04:00 would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year.

1985-04-12T19:20:50.52 would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information.

Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of 2018-06-19T18:30:00-04:00 will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles.

Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of 2018-06-19T18:30:00 will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
writable
messages[].displayInterval.start nested object Start time of the interval.

Offset is not required. If an offset is provided and end time is set, end must also include an offset.
writable
messages[].displayInterval.start.date string An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601).

For example:

1985-04-12T23:20:50.52Z would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC.

1985-04-12T19:20:50.52-04:00 would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year.

1985-04-12T19:20:50.52 would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information.

Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of 2018-06-19T18:30:00-04:00 will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles.

Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of 2018-06-19T18:30:00 will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
writable
messages[].header string The message header. writable
messages[].id string The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message. writable
messages[].localizedBody nested object Translated strings for the message body. writable
messages[].localizedBody.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
messages[].localizedBody.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
messages[].localizedBody.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
messages[].localizedBody.translatedValues[] list Contains the translations for the string. writable
messages[].localizedBody.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
messages[].localizedBody.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
messages[].localizedHeader nested object Translated strings for the message header. writable
messages[].localizedHeader.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
messages[].localizedHeader.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
messages[].localizedHeader.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
messages[].localizedHeader.translatedValues[] list Contains the translations for the string. writable
messages[].localizedHeader.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
messages[].localizedHeader.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
passengerNames string The name(s) of the passengers the ticket is assigned to. The passengerType field is meant to give Google context on this field. writable
passengerType string The number of passengers.

Acceptable values are:
  • "multiplePassengers"
  • "singlePassenger"
writable
purchaseDetails nested object Purchase details for this ticket. writable
purchaseDetails.accountId string ID of the account used to purchase the ticket. writable
purchaseDetails.confirmationCode string The confirmation code for the purchase. This may be the same for multiple different tickets and is used to group tickets together. writable
purchaseDetails.purchaseDateTime string The purchase date/time of the ticket.

This is an ISO 8601 extended format date/time, with or without an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601).

For example:

1985-04-12T23:20:50.52Z would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC.

1985-04-12T19:20:50.52-04:00 would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year.

1985-04-12T19:20:50.52 would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information.

Without offset information, some rich features may not be available.
writable
purchaseDetails.ticketCost nested object The cost of the ticket. writable
purchaseDetails.ticketCost.discountMessage nested object A message describing any kind of discount that was applied. writable
purchaseDetails.ticketCost.discountMessage.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
purchaseDetails.ticketCost.discountMessage.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
purchaseDetails.ticketCost.discountMessage.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
purchaseDetails.ticketCost.discountMessage.translatedValues[] list Contains the translations for the string. writable
purchaseDetails.ticketCost.discountMessage.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
purchaseDetails.ticketCost.discountMessage.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
purchaseDetails.ticketCost.faceValue nested object The face value of the ticket. writable
purchaseDetails.ticketCost.faceValue.currencyCode string The currency code, such as "USD" or "EUR." writable
purchaseDetails.ticketCost.faceValue.micros long The unit of money amount in micros. For example, $1 USD would be represented as 1000000 micros. writable
purchaseDetails.ticketCost.purchasePrice nested object The actual purchase price of the ticket, after tax and/or discounts. writable
purchaseDetails.ticketCost.purchasePrice.currencyCode string The currency code, such as "USD" or "EUR." writable
purchaseDetails.ticketCost.purchasePrice.micros long The unit of money amount in micros. For example, $1 USD would be represented as 1000000 micros. writable
smartTapRedemptionValue string Available only to Smart Tap enabled partners. Contact support for additional guidance. writable
state string The state of the object. This field is used to determine how an object is displayed in the app.

Acceptable values are:
  • "active"
  • "completed"
  • "expired"
  • "inactive"
writable
textModulesData[] list Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields (combined with the class) is 10. writable
textModulesData[].body string The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens. writable
textModulesData[].header string The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens. writable
textModulesData[].localizedBody nested object Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens. writable
textModulesData[].localizedBody.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
textModulesData[].localizedBody.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
textModulesData[].localizedBody.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
textModulesData[].localizedBody.translatedValues[] list Contains the translations for the string. writable
textModulesData[].localizedBody.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
textModulesData[].localizedBody.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
textModulesData[].localizedHeader nested object Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens. writable
textModulesData[].localizedHeader.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
textModulesData[].localizedHeader.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
textModulesData[].localizedHeader.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
textModulesData[].localizedHeader.translatedValues[] list Contains the translations for the string. writable
textModulesData[].localizedHeader.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
textModulesData[].localizedHeader.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
ticketLeg nested object A single ticket leg contains departure and arrival information along with boarding and seating information. If more than one leg is to be specified then use the ticketLegs field instead. Both ticketLeg and ticketLegs may not be set. writable
ticketLeg.arrivalDateTime string The date/time of arrival.

This is an ISO 8601 extended format date/time, with or without an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601).

For example:

1985-04-12T23:20:50.52Z would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC.

1985-04-12T19:20:50.52-04:00 would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year.

1985-04-12T19:20:50.52 would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information.

The portion of the date/time without the offset is considered the "local date/time". This should be the local date/time at the destination station. For example, if the event occurs at the 20th hour of June 5th, 2018 at the destination station, the local date/time portion should be 2018-06-05T20:00:00. If the local date/time at the destination station is 4 hours before UTC, an offset of -04:00 may be appended.

Without offset information, some rich features may not be available.
writable
ticketLeg.carriage string The train or ship name/number that the passsenger needs to board. writable
ticketLeg.departureDateTime string The date/time of departure. This is required if there is no validity time interval set on the transit object.

This is an ISO 8601 extended format date/time, with or without an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601).

For example:

1985-04-12T23:20:50.52Z would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC.

1985-04-12T19:20:50.52-04:00 would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year.

1985-04-12T19:20:50.52 would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information.

The portion of the date/time without the offset is considered the "local date/time". This should be the local date/time at the origin station. For example, if the departure occurs at the 20th hour of June 5th, 2018 at the origin station, the local date/time portion should be 2018-06-05T20:00:00. If the local date/time at the origin station is 4 hours before UTC, an offset of -04:00 may be appended.

Without offset information, some rich features may not be available.
writable
ticketLeg.destinationName nested object The destination name. writable
ticketLeg.destinationName.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
ticketLeg.destinationName.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
ticketLeg.destinationName.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
ticketLeg.destinationName.translatedValues[] list Contains the translations for the string. writable
ticketLeg.destinationName.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
ticketLeg.destinationName.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
ticketLeg.destinationStationCode string The destination station code. writable
ticketLeg.fareName nested object Short description/name of the fare for this leg of travel. Eg "Anytime Single Use". writable
ticketLeg.fareName.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
ticketLeg.fareName.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
ticketLeg.fareName.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
ticketLeg.fareName.translatedValues[] list Contains the translations for the string. writable
ticketLeg.fareName.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
ticketLeg.fareName.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
ticketLeg.originName nested object The name of the origin station. This is required if desinationName is present or if originStationCode is not present. writable
ticketLeg.originName.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
ticketLeg.originName.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
ticketLeg.originName.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
ticketLeg.originName.translatedValues[] list Contains the translations for the string. writable
ticketLeg.originName.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
ticketLeg.originName.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
ticketLeg.originStationCode string The origin station code. This is required if destinationStationCode is present or if originName is not present. writable
ticketLeg.platform string The platform or gate where the passenger can board the carriage. writable
ticketLeg.ticketSeat nested object The reserved seat for the passenger(s). If more than one seat is to be specified then use the ticketSeats field instead. Both ticketSeat and ticketSeats may not be set. writable
ticketLeg.ticketSeat.coach string The identifier of the train car or coach in which the ticketed seat is located. Eg. "10" writable
ticketLeg.ticketSeat.customFareClass nested object A custome fare class to be used if no fareClass applies. Both fareClass and customFareClass may not be set. writable
ticketLeg.ticketSeat.customFareClass.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
ticketLeg.ticketSeat.customFareClass.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
ticketLeg.ticketSeat.customFareClass.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
ticketLeg.ticketSeat.customFareClass.translatedValues[] list Contains the translations for the string. writable
ticketLeg.ticketSeat.customFareClass.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
ticketLeg.ticketSeat.customFareClass.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
ticketLeg.ticketSeat.fareClass string The fare class of the ticketed seat.

Acceptable values are:
  • "business"
  • "economy"
  • "first"
writable
ticketLeg.ticketSeat.seat string The identifier of where the ticketed seat is located. Eg. "42" writable
ticketLeg.ticketSeats[] list The reserved seat for the passenger(s). If only one seat is to be specified then use the ticketSeat field instead. Both ticketSeat and ticketSeats may not be set. writable
ticketLeg.ticketSeats[].coach string The identifier of the train car or coach in which the ticketed seat is located. Eg. "10" writable
ticketLeg.ticketSeats[].customFareClass nested object A custome fare class to be used if no fareClass applies. Both fareClass and customFareClass may not be set. writable
ticketLeg.ticketSeats[].customFareClass.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
ticketLeg.ticketSeats[].customFareClass.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
ticketLeg.ticketSeats[].customFareClass.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
ticketLeg.ticketSeats[].customFareClass.translatedValues[] list Contains the translations for the string. writable
ticketLeg.ticketSeats[].customFareClass.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
ticketLeg.ticketSeats[].customFareClass.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
ticketLeg.ticketSeats[].fareClass string The fare class of the ticketed seat.

Acceptable values are:
  • "business"
  • "economy"
  • "first"
writable
ticketLeg.ticketSeats[].seat string The identifier of where the ticketed seat is located. Eg. "42" writable
ticketLeg.transitOperatorName nested object The name of the transit operator that is operating this leg of a trip. writable
ticketLeg.transitOperatorName.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
ticketLeg.transitOperatorName.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
ticketLeg.transitOperatorName.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
ticketLeg.transitOperatorName.translatedValues[] list Contains the translations for the string. writable
ticketLeg.transitOperatorName.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
ticketLeg.transitOperatorName.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
ticketLeg.transitTerminusName nested object Terminus station or destination of the train/bus/etc. writable
ticketLeg.transitTerminusName.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
ticketLeg.transitTerminusName.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
ticketLeg.transitTerminusName.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
ticketLeg.transitTerminusName.translatedValues[] list Contains the translations for the string. writable
ticketLeg.transitTerminusName.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
ticketLeg.transitTerminusName.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
ticketLeg.zone string The zone of boarding within the platform. writable
ticketLegs[] list Each ticket may contain one or more legs. Each leg contains departure and arrival information along with boarding and seating information. If only one leg is to be specified then use the ticketLeg field instead. Both ticketLeg and ticketLegs may not be set. writable
ticketLegs[].arrivalDateTime string The date/time of arrival.

This is an ISO 8601 extended format date/time, with or without an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601).

For example:

1985-04-12T23:20:50.52Z would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC.

1985-04-12T19:20:50.52-04:00 would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year.

1985-04-12T19:20:50.52 would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information.

The portion of the date/time without the offset is considered the "local date/time". This should be the local date/time at the destination station. For example, if the event occurs at the 20th hour of June 5th, 2018 at the destination station, the local date/time portion should be 2018-06-05T20:00:00. If the local date/time at the destination station is 4 hours before UTC, an offset of -04:00 may be appended.

Without offset information, some rich features may not be available.
writable
ticketLegs[].carriage string The train or ship name/number that the passsenger needs to board. writable
ticketLegs[].departureDateTime string The date/time of departure. This is required if there is no validity time interval set on the transit object.

This is an ISO 8601 extended format date/time, with or without an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601).

For example:

1985-04-12T23:20:50.52Z would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC.

1985-04-12T19:20:50.52-04:00 would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year.

1985-04-12T19:20:50.52 would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information.

The portion of the date/time without the offset is considered the "local date/time". This should be the local date/time at the origin station. For example, if the departure occurs at the 20th hour of June 5th, 2018 at the origin station, the local date/time portion should be 2018-06-05T20:00:00. If the local date/time at the origin station is 4 hours before UTC, an offset of -04:00 may be appended.

Without offset information, some rich features may not be available.
writable
ticketLegs[].destinationName nested object The destination name. writable
ticketLegs[].destinationName.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
ticketLegs[].destinationName.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
ticketLegs[].destinationName.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
ticketLegs[].destinationName.translatedValues[] list Contains the translations for the string. writable
ticketLegs[].destinationName.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
ticketLegs[].destinationName.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
ticketLegs[].destinationStationCode string The destination station code. writable
ticketLegs[].fareName nested object Short description/name of the fare for this leg of travel. Eg "Anytime Single Use". writable
ticketLegs[].fareName.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
ticketLegs[].fareName.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
ticketLegs[].fareName.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
ticketLegs[].fareName.translatedValues[] list Contains the translations for the string. writable
ticketLegs[].fareName.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
ticketLegs[].fareName.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
ticketLegs[].originName nested object The name of the origin station. This is required if desinationName is present or if originStationCode is not present. writable
ticketLegs[].originName.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
ticketLegs[].originName.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
ticketLegs[].originName.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
ticketLegs[].originName.translatedValues[] list Contains the translations for the string. writable
ticketLegs[].originName.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
ticketLegs[].originName.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
ticketLegs[].originStationCode string The origin station code. This is required if destinationStationCode is present or if originName is not present. writable
ticketLegs[].platform string The platform or gate where the passenger can board the carriage. writable
ticketLegs[].ticketSeat nested object The reserved seat for the passenger(s). If more than one seat is to be specified then use the ticketSeats field instead. Both ticketSeat and ticketSeats may not be set. writable
ticketLegs[].ticketSeat.coach string The identifier of the train car or coach in which the ticketed seat is located. Eg. "10" writable
ticketLegs[].ticketSeat.customFareClass nested object A custome fare class to be used if no fareClass applies. Both fareClass and customFareClass may not be set. writable
ticketLegs[].ticketSeat.customFareClass.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
ticketLegs[].ticketSeat.customFareClass.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
ticketLegs[].ticketSeat.customFareClass.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
ticketLegs[].ticketSeat.customFareClass.translatedValues[] list Contains the translations for the string. writable
ticketLegs[].ticketSeat.customFareClass.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
ticketLegs[].ticketSeat.customFareClass.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
ticketLegs[].ticketSeat.fareClass string The fare class of the ticketed seat.

Acceptable values are:
  • "business"
  • "economy"
  • "first"
writable
ticketLegs[].ticketSeat.seat string The identifier of where the ticketed seat is located. Eg. "42" writable
ticketLegs[].ticketSeats[] list The reserved seat for the passenger(s). If only one seat is to be specified then use the ticketSeat field instead. Both ticketSeat and ticketSeats may not be set. writable
ticketLegs[].ticketSeats[].coach string The identifier of the train car or coach in which the ticketed seat is located. Eg. "10" writable
ticketLegs[].ticketSeats[].customFareClass nested object A custome fare class to be used if no fareClass applies. Both fareClass and customFareClass may not be set. writable
ticketLegs[].ticketSeats[].customFareClass.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
ticketLegs[].ticketSeats[].customFareClass.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
ticketLegs[].ticketSeats[].customFareClass.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
ticketLegs[].ticketSeats[].customFareClass.translatedValues[] list Contains the translations for the string. writable
ticketLegs[].ticketSeats[].customFareClass.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
ticketLegs[].ticketSeats[].customFareClass.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
ticketLegs[].ticketSeats[].fareClass string The fare class of the ticketed seat.

Acceptable values are:
  • "business"
  • "economy"
  • "first"
writable
ticketLegs[].ticketSeats[].seat string The identifier of where the ticketed seat is located. Eg. "42" writable
ticketLegs[].transitOperatorName nested object The name of the transit operator that is operating this leg of a trip. writable
ticketLegs[].transitOperatorName.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
ticketLegs[].transitOperatorName.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
ticketLegs[].transitOperatorName.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
ticketLegs[].transitOperatorName.translatedValues[] list Contains the translations for the string. writable
ticketLegs[].transitOperatorName.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
ticketLegs[].transitOperatorName.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
ticketLegs[].transitTerminusName nested object Terminus station or destination of the train/bus/etc. writable
ticketLegs[].transitTerminusName.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
ticketLegs[].transitTerminusName.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
ticketLegs[].transitTerminusName.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
ticketLegs[].transitTerminusName.translatedValues[] list Contains the translations for the string. writable
ticketLegs[].transitTerminusName.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
ticketLegs[].transitTerminusName.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
ticketLegs[].zone string The zone of boarding within the platform. writable
ticketNumber string The number of the ticket. This is a unique identifier for the ticket. writable
ticketRestrictions nested object Information about what kind of restrictions there are on using this ticket. For example, which days of the week it must be used, or which routes are allowed to be taken. writable
ticketRestrictions.otherRestrictions nested object Extra restrictions that don't fall under the "route" or "time" categories. writable
ticketRestrictions.otherRestrictions.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
ticketRestrictions.otherRestrictions.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
ticketRestrictions.otherRestrictions.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
ticketRestrictions.otherRestrictions.translatedValues[] list Contains the translations for the string. writable
ticketRestrictions.otherRestrictions.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
ticketRestrictions.otherRestrictions.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
ticketRestrictions.routeRestrictions nested object Restrictions about routes that may be taken. For example, this may be the string "Reserved CrossCountry trains only". writable
ticketRestrictions.routeRestrictions.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
ticketRestrictions.routeRestrictions.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
ticketRestrictions.routeRestrictions.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
ticketRestrictions.routeRestrictions.translatedValues[] list Contains the translations for the string. writable
ticketRestrictions.routeRestrictions.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
ticketRestrictions.routeRestrictions.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
ticketRestrictions.routeRestrictionsDetails nested object More details about the above routeRestrictions. writable
ticketRestrictions.routeRestrictionsDetails.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
ticketRestrictions.routeRestrictionsDetails.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
ticketRestrictions.routeRestrictionsDetails.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
ticketRestrictions.routeRestrictionsDetails.translatedValues[] list Contains the translations for the string. writable
ticketRestrictions.routeRestrictionsDetails.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
ticketRestrictions.routeRestrictionsDetails.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
ticketRestrictions.timeRestrictions nested object Restrictions about times this ticket may be used. writable
ticketRestrictions.timeRestrictions.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
ticketRestrictions.timeRestrictions.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
ticketRestrictions.timeRestrictions.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
ticketRestrictions.timeRestrictions.translatedValues[] list Contains the translations for the string. writable
ticketRestrictions.timeRestrictions.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
ticketRestrictions.timeRestrictions.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
ticketStatus string The status of the ticket. For states which affect display, use the state field instead.

Acceptable values are:
  • "exchanged"
  • "refunded"
  • "used"
writable
tripId string This id is used to group tickets together if the user has saved multiple tickets for the same trip. writable
tripType string The type of trip this transit object represents. Used to determine which symbol to use between the origin and destination.

Acceptable values are:
  • "oneWay"
  • "roundTrip"
writable
validTimeInterval nested object The time period this object will be active and object can be used. An object's state will be changed to expired when this time period has passed. writable
validTimeInterval.end nested object End time of the interval.

Offset is not required. If an offset is provided and start time is set, start must also include an offset.
writable
validTimeInterval.end.date string An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601).

For example:

1985-04-12T23:20:50.52Z would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC.

1985-04-12T19:20:50.52-04:00 would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year.

1985-04-12T19:20:50.52 would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information.

Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of 2018-06-19T18:30:00-04:00 will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles.

Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of 2018-06-19T18:30:00 will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
writable
validTimeInterval.start nested object Start time of the interval.

Offset is not required. If an offset is provided and end time is set, end must also include an offset.
writable
validTimeInterval.start.date string An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601).

For example:

1985-04-12T23:20:50.52Z would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC.

1985-04-12T19:20:50.52-04:00 would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year.

1985-04-12T19:20:50.52 would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information.

Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of 2018-06-19T18:30:00-04:00 will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles.

Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of 2018-06-19T18:30:00 will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
writable

Response

If successful, this method returns a Transitobject resource in the response body.

Enviar comentários sobre…

Google Pay for Passes