GET /API/v1/Report/BookingListOceanVessels/GetListByDomesticNo/{domesticNo}?customId={customId}
社内管理番号を指定して、帳票:外航ブッキングリストを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:外航ブッキングリストを取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:外航ブッキングリストを取得します。
Request Information
URI Parameters
NoLimitOnNumberGetListByDomesticNoRequest
Name | Description | Type | Additional information |
---|---|---|---|
customId | 帳票のカスタムIDを指定します。 |
String |
Required |
domesticNo | 帳票を取得する取引を特定するために社内管理番号を指定します。 |
String |
Required |
Body Parameters
None.
Response Information
Resource Description
BookingListOceanVessels
Name | Description | Type | Additional information |
---|---|---|---|
_etag | etag |
String |
Required |
bookingDetails |
Collection, Null of bookingDetails |
None. |
|
bundleCarryInDate | 一括搬入日 |
String, Null |
Format : date |
businessTypeId | 事業種別ID |
String |
Required Format : Protect Pattern : ^(?!.*(\?|\$|#|&|,|=)).*$ |
callSign | コールサイン |
String, Null |
Format : ForeignKey /API/v1/Master/BusinessCodes?$filter=categoryCode eq '029' and businessCode eq '{value}' |
cfsCutDate | CFSカット日 |
String, Null |
Format : date |
containerTerminalName | コンテナターミナル |
String, Null |
None. |
customId | カスタムID |
String, Null |
Format : Protect |
cyCutDate | CYカット日 |
String, Null |
Format : date |
dealReportId | 取引・帳票ID |
String |
Required |
domesticTrade | 内貿 |
Boolean, Null |
None. |
oceanCarrierCompanyName | 運送人(海運)_会社名 |
String, Null |
None. |
oceanRouteName | 外航航路名 |
String, Null |
None. |
organizationId | 組織ID |
String |
Required Format : Protect Pattern : ^(?!.*(\?|\$|#|&|,|=)).*$ |
partitionNo | パーティション番号 |
Integer, Null |
Format : Protect |
vesselCode | 本船コード |
String, Null |
Format : ForeignKey /API/v1/Master/BusinessCodes?$filter=categoryCode eq '029' and businessCode eq '{value}' |
vesselIMONo | IMO船舶識別番号 |
String, Null |
None. |
vesselName | 本船名 |
String, Null |
Min length: 0 Max length: 35 |
voyageNo | 航海番号 |
String, Null |
Min length: 0 Max length: 10 |