POST /API/v1/Report/BookingListOceanVessels/CreateByBookingNo
ブッキング番号を指定して、帳票:外航ブッキングリストを作成します。 ## 概要 ユーザが所属している組織が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:外航ブッキングリストを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対して、Write権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が複数存在する場合はエラーとなります。 ## 指定するパラメタについて ### 船社コード 船社コード(***scacCode***)は、取引に対して設定するのではなく、帳票を通して(帳票の項目として)設定します。 ### ブッキング番号 ブッキング番号(***bookingNo***)は、取引に対して設定するのではなく、帳票を通して(帳票の項目として)設定します。 ### 帳票を作成する組織の組織ID・事業種別ID 帳票を作成する権限のある組織の組織ID(***organizationId***)と事業種別ID(***businessTypeId***)のセットで指定します。
Request Information
URI Parameters
None.
Body Parameters
CreateNoLimitOnNumberReportByBookingNoRequest
CreateNoLimitOnNumberReportByBookingNoRequest
Name | Description | Type | Additional information |
---|---|---|---|
bookingNo | ブッキング番号 |
String |
Required |
businessTypeId | 事業種別ID |
String |
Required |
customId | カスタムID |
String |
Required |
organizationId | 組織ID |
String |
Required |
scacCode | 船社コード |
String |
Required |
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 |