POST /API/v1/Report/CargoManifests/Register
帳票：積荷目録を保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織（と事業種別）に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子（***_etag***）がつけられています。 このバージョン識別子（***_etag***）は、帳票の保存（Register）が行われると、違う値に更新されます。帳票の保存（Register）のときに、このバージョン識別子（***_etag***）が異なると、排他エラー（***409：Conflict***）が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。
Request Information
URI Parameters
None.
Body Parameters
CargoManifests
| Name | Description | Type | Additional information |
|---|---|---|---|
| _etag | etag |
String |
Required |
| bLDetails |
Collection, Null of bLDetails |
None. |
|
| businessTypeId | 事業種別ID |
String |
Required Format : Protect Pattern : ^(?!.*(\?|\$|#|&|,|=)).*$ |
| callSign | コールサイン |
String, Null |
Format : ForeignKey /API/v1/Master/BusinessCodes?$filter=categoryCode eq '029' and businessCode eq '{value}' |
| consolId | 混載業者番号 |
String, Null |
None. |
| customId | カスタムID |
String, Null |
Format : Protect |
| dealReportId | 取引・帳票ID |
String |
Required |
| estimatedTimeOfArrivalPodEta | 荷揚港 入港予定日 |
String, Null |
Format : date |
| estimatedTimeOfArrivalPolEta | 積荷港 入港予定日 |
String, Null |
Format : date |
| estimatedTimeOfDeparturePolEtd | 積荷港 出港予定日 |
String, Null |
Format : date |
| finalDestination | 最終仕向地_名称 |
String, Null |
None. |
| finalDestinationCode | 最終仕向地_コード |
String, Null |
None. |
| freightAndCharges |
Collection, Null of freightAndCharges |
None. |
|
| nationalityOfShip | 船籍 |
String, Null |
None. |
| note1 | 備考１ |
String, Null |
Min length: 0 Max length: 140 |
| note2 | 備考２ |
String, Null |
None. |
| note3 | 備考３ |
String, Null |
None. |
| oceanCarrierCompanyName | 運送人(海運)_会社名 |
String, Null |
None. |
| organizationId | 組織ID |
String |
Required Format : Protect Pattern : ^(?!.*(\?|\$|#|&|,|=)).*$ |
| partitionNo | パーティション番号 |
Integer, Null |
Format : Protect |
| placeOfDelivery | 荷渡地_名称 |
String, Null |
None. |
| placeOfDeliveryCode | 荷渡地_コード |
String, Null |
None. |
| portOfDischarge | 荷揚港_名称 |
String, Null |
None. |
| portOfDischargeCode | 荷揚港_コード |
String, Null |
None. |
| portOfLoading | 積荷港_名称 |
String, Null |
None. |
| portOfLoadingCode | 積荷港_コード |
String, Null |
None. |
| portTotalCbm | 港の総体積 |
Number, Null |
Format : Number(10,3) Maximum : 9999999.999 Minimum : 0 |
| portTotalKgs | 港の総重量 |
Number, Null |
Format : Number(10,3) Maximum : 9999999.999 Minimum : 0 |
| portTotalPkg | 港の総パッケージ数 |
Number, Null |
Format : Number(8,0) Maximum : 99999999 Minimum : 0 |
| portTotalRt | 港の総レベニュートン |
Number, Null |
Format : Number(10,3) Maximum : 9999999.999 Minimum : 0 |
| portWhereReportIsMade | 報告書作成港 |
String, Null |
None. |
| printedDate | 書類発行日 |
String, Null |
Format : date |
| receiptDate | 荷受日 |
String, Null |
Format : date |
| 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 |
Response Information
Resource Description
None.