邮轮品牌、船只、甲板、舱型、港口和位置字典
Classes
Methods
-
<static> brands(header [, body])
-
post获取品牌字典,支持 codes/since 增量同步。Parameters:
Name Type Argument Description headermodule:request.YHeader Http request header
bodyobject <optional>
Http request body
Properties
Name Type Argument Description preferredmodule:common.Preferred <optional>
首选设置,名称和描述按 preferred.language 返回
codesArray.<string> <optional>
品牌编码
sincestring <optional>
上次同步时间,ISO 8601;只返回
updatedAt晚于该时间的记录- Since:
-
- 1.0.0
Returns:
- Type
- metaBrandsResponse
-
<static> cabinTypes(header, body)
-
post获取船只舱型字典。Parameters:
Name Type Description headermodule:request.YHeader Http request header
bodyobject Http request body
Properties
Name Type Argument Description preferredmodule:common.Preferred <optional>
首选设置,名称和描述按 preferred.language 返回
shipCodestring 船只编码
categoryCodesArray.<string> <optional>
舱型编码
- Since:
-
- 1.0.0
Returns:
- Type
- metaCabinTypesResponse
-
<static> decks(header, body)
-
post获取船只甲板及交互 SVG 资源。Parameters:
Name Type Description headermodule:request.YHeader Http request header
bodyobject Http request body
Properties
Name Type Argument Description preferredmodule:common.Preferred <optional>
首选设置,名称和描述按 preferred.language 返回
shipCodestring 船只编码
deckNosArray.<string> <optional>
甲板号
includeArray.<string> <optional>
展开项,可选
roomIdssincestring <optional>
上次同步时间,ISO 8601
- Since:
-
- 1.0.0
Returns:
- Type
- metaDecksResponse
-
<static> locations(header [, body])
-
post获取舱位位置字典。Parameters:
Name Type Argument Description headermodule:request.YHeader Http request header
bodyobject <optional>
Http request body
Properties
Name Type Argument Description preferredmodule:common.Preferred <optional>
首选设置,名称和描述按 preferred.language 返回
codesArray.<string> <optional>
位置编码;不传时返回全部舱位位置
- Since:
-
- 1.0.0
Returns:
- Type
- metaLocationsResponse
-
<static> ports(header [, body])
-
post获取港口字典。Parameters:
Name Type Argument Description headermodule:request.YHeader Http request header
bodyobject <optional>
Http request body
Properties
Name Type Argument Description preferredmodule:common.Preferred <optional>
首选设置,名称和描述按 preferred.language 返回
codesArray.<string> <optional>
港口编码;不传时返回全部已知港口
- Since:
-
- 1.0.0
Returns:
- Type
- metaPortsResponse
-
<static> ships(header [, body])
-
post获取船只字典,可按 include 展开甲板、舱型和视频。Parameters:
Name Type Argument Description headermodule:request.YHeader Http request header
bodyobject <optional>
Http request body
Properties
Name Type Argument Description preferredmodule:common.Preferred <optional>
首选设置,名称和描述按 preferred.language 返回
codesArray.<string> <optional>
船只编码
brandCodesArray.<string> <optional>
品牌编码
includeArray.<string> <optional>
展开项,可选
videos、decks、cabinTypes;默认不展开sincestring <optional>
上次同步时间,ISO 8601
- Since:
-
- 1.0.0
Returns:
- Type
- metaShipsResponse
Type Definitions
-
metaBrandsResponse
-
Type:
- object
- Since:
-
- 1.0.0
Properties:
Name Type Argument Description errmodule:common.Error <optional>
错误信息
syncedAtstring 同步时间,ISO 8601
brandsArray.<module:common.Brand> 品牌列表
-
metaCabinTypesResponse
-
Type:
- object
- Since:
-
- 1.0.0
Properties:
Name Type Argument Description errmodule:common.Error <optional>
错误信息
syncedAtstring 同步时间,ISO 8601
cabinTypesArray.<module:cruise/meta.CruiseCabinType> 舱型列表
-
metaDecksResponse
-
Type:
- object
- Since:
-
- 1.0.0
Properties:
Name Type Argument Description errmodule:common.Error <optional>
错误信息
syncedAtstring 同步时间,ISO 8601
shipobject <optional>
船只摘要
Properties
Name Type Argument Description codestring <optional>
船只编码
namestring <optional>
船只名称
decksArray.<module:cruise/meta.CruiseDeck> 甲板列表
-
metaLocationsResponse
-
Type:
- object
- Since:
-
- 1.0.0
Properties:
Name Type Argument Description errmodule:common.Error <optional>
错误信息
syncedAtstring 同步时间,ISO 8601
locationsArray.<module:cruise/meta.CruiseLocation> 舱位位置列表
-
metaPortsResponse
-
Type:
- object
- Since:
-
- 1.0.0
Properties:
Name Type Argument Description errmodule:common.Error <optional>
错误信息
syncedAtstring 同步时间,ISO 8601
portsArray.<module:cruise/meta.CruisePort> 港口列表
-
metaShipsResponse
-
Type:
- object
- Since:
-
- 1.0.0
Properties:
Name Type Argument Description errmodule:common.Error <optional>
错误信息
syncedAtstring 同步时间,ISO 8601
shipsArray.<module:cruise/meta.CruiseShip> 船只列表