Ship Ticket
This page describes the extended dataInfo for ship ticket scenarios, please also check the base API.
Please be aware below UI snapshots may not be the latest, you should refer to the actual APP UI as the final version. |
Request parameters
$from_zh_HK$ string REQUIRED
Name of the departure station.
More information:
- Maximum length: 24 characters
$from_en_US$ string REQUIRED
Name of the departure station.
More information:
- Maximum length: 48 characters
$fromAddress_zh_HK$ string REQUIRED
Address of the departure station.
More information:
- Maximum length: 64 characters
$fromAddress_en_US$ string REQUIRED
Address of the departure station.
More information:
- Maximum length: 128 characters
$to_zh_HK$ string REQUIRED
Name of the arrival station.
More information:
- Maximum length: 24 characters
$to_en_US$ string REQUIRED
Name of the departure station.
More information:
- Maximum length: 48 characters
$toAddress_zh_HK$ string REQUIRED
Address of the arrival station.
More information:
- Maximum length: 64 characters
$toAddress_en_US$ string REQUIRED
Address of the arrival station.
More information:
- Maximum length: 128 characters
$availableTimes_zh_HK$ number
Available usage of this ticket.
$availableTimes_en_US$ number
Available usage of this ticket.
$price_zh_HK$ object
Price information of this ticket.
$price_en_US$ object
Price information of this ticket.
$startTime_zh_HK$ number REQUIRED
Departure datetime in milliseconds.
$startTime_en_US$ number REQUIRED
Departure datetime in milliseconds.
$endTime_zh_HK$ number REQUIRED
Arrival datetime in milliseconds.
$endTime_en_US$ number REQUIRED
Arrival datetime in milliseconds.
$ticketType_zh_HK$ string
Type of the ticket.
More information:
- Maximum length: 12 characters
$ticketType_en_US$ string
Type of the ticket.
$ticketLevel_zh_HK$ string
Service level of this ticket.
More information:
- Maximum length: 12 characters
$ticketLevel_en_US$ string
Service level of this ticket.
More information:
- Maximum length: 24 characters
$platformName_zh_HK$ string
Name of the platform / agency.
More information:
- Maximum length: 32 characters
$platformName_en_US$ string
Name of the platform / agency.
More information:
- Maximum length: 64 characters
$platformLogo_zh_HK$ string
An URL redirects to the logo of the platform / agency.
More information:
- Maximum length: 256 characters
- Value range: <100 KB
$platformLogo_en_US$ string
An URL redirects to the logo of the platform / agency.
More information:
- Maximum length: 256 characters
- Value range: <100 KB