Module: cruise/meta

邮轮品牌、船只、甲板、舱型、港口和位置字典

Classes

CruiseCabinType
CruiseDeck
CruiseDeckManifest
CruiseLocation
CruisePort
CruiseShip

Methods


<static> brands(header [, body])

post 获取品牌字典,支持 codes/since 增量同步。

Parameters:
Name Type Argument Description
header module:request.YHeader

Http request header

body object <optional>

Http request body

Properties
Name Type Argument Description
preferred module:common.Preferred <optional>

首选设置,名称和描述按 preferred.language 返回

codes Array.<string> <optional>

品牌编码

since string <optional>

上次同步时间,ISO 8601;只返回 updatedAt 晚于该时间的记录

Since:
  • 1.0.0
Returns:
Type
metaBrandsResponse

<static> cabinTypes(header, body)

post 获取船只舱型字典。

Parameters:
Name Type Description
header module:request.YHeader

Http request header

body object

Http request body

Properties
Name Type Argument Description
preferred module:common.Preferred <optional>

首选设置,名称和描述按 preferred.language 返回

shipCode string

船只编码

categoryCodes Array.<string> <optional>

舱型编码

Since:
  • 1.0.0
Returns:
Type
metaCabinTypesResponse

<static> decks(header, body)

post 获取船只甲板及交互 SVG 资源。

Parameters:
Name Type Description
header module:request.YHeader

Http request header

body object

Http request body

Properties
Name Type Argument Description
preferred module:common.Preferred <optional>

首选设置,名称和描述按 preferred.language 返回

shipCode string

船只编码

deckNos Array.<string> <optional>

甲板号

include Array.<string> <optional>

展开项,可选 roomIds

since string <optional>

上次同步时间,ISO 8601

Since:
  • 1.0.0
Returns:
Type
metaDecksResponse

<static> locations(header [, body])

post 获取舱位位置字典。

Parameters:
Name Type Argument Description
header module:request.YHeader

Http request header

body object <optional>

Http request body

Properties
Name Type Argument Description
preferred module:common.Preferred <optional>

首选设置,名称和描述按 preferred.language 返回

codes Array.<string> <optional>

位置编码;不传时返回全部舱位位置

Since:
  • 1.0.0
Returns:
Type
metaLocationsResponse

<static> ports(header [, body])

post 获取港口字典。

Parameters:
Name Type Argument Description
header module:request.YHeader

Http request header

body object <optional>

Http request body

Properties
Name Type Argument Description
preferred module:common.Preferred <optional>

首选设置,名称和描述按 preferred.language 返回

codes Array.<string> <optional>

港口编码;不传时返回全部已知港口

Since:
  • 1.0.0
Returns:
Type
metaPortsResponse

<static> ships(header [, body])

post 获取船只字典,可按 include 展开甲板、舱型和视频。

Parameters:
Name Type Argument Description
header module:request.YHeader

Http request header

body object <optional>

Http request body

Properties
Name Type Argument Description
preferred module:common.Preferred <optional>

首选设置,名称和描述按 preferred.language 返回

codes Array.<string> <optional>

船只编码

brandCodes Array.<string> <optional>

品牌编码

include Array.<string> <optional>

展开项,可选 videos、decks、cabinTypes;默认不展开

since string <optional>

上次同步时间,ISO 8601

Since:
  • 1.0.0
Returns:
Type
metaShipsResponse

Type Definitions


metaBrandsResponse

Type:
  • object
Properties:
Name Type Argument Description
err module:common.Error <optional>

错误信息

syncedAt string

同步时间,ISO 8601

brands Array.<module:common.Brand>

品牌列表

Since:
  • 1.0.0

metaCabinTypesResponse

Type:
  • object
Properties:
Name Type Argument Description
err module:common.Error <optional>

错误信息

syncedAt string

同步时间,ISO 8601

cabinTypes Array.<module:cruise/meta.CruiseCabinType>

舱型列表

Since:
  • 1.0.0

metaDecksResponse

Type:
  • object
Properties:
Name Type Argument Description
err module:common.Error <optional>

错误信息

syncedAt string

同步时间,ISO 8601

ship object <optional>

船只摘要

Properties
Name Type Argument Description
code string <optional>

船只编码

name string <optional>

船只名称

decks Array.<module:cruise/meta.CruiseDeck>

甲板列表

Since:
  • 1.0.0

metaLocationsResponse

Type:
  • object
Properties:
Name Type Argument Description
err module:common.Error <optional>

错误信息

syncedAt string

同步时间,ISO 8601

locations Array.<module:cruise/meta.CruiseLocation>

舱位位置列表

Since:
  • 1.0.0

metaPortsResponse

Type:
  • object
Properties:
Name Type Argument Description
err module:common.Error <optional>

错误信息

syncedAt string

同步时间,ISO 8601

ports Array.<module:cruise/meta.CruisePort>

港口列表

Since:
  • 1.0.0

metaShipsResponse

Type:
  • object
Properties:
Name Type Argument Description
err module:common.Error <optional>

错误信息

syncedAt string

同步时间,ISO 8601

ships Array.<module:cruise/meta.CruiseShip>

船只列表

Since:
  • 1.0.0