POST /API/v1/NaccsReport/BookingRegistrations/Register
帳票:BKRを保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。
Request Information
URI Parameters
None.
Body Parameters
BookingRegistrations
Name | Description | Type | Additional information |
---|---|---|---|
_etag | etag |
String |
Required |
article | 記事 |
String, Null |
None. |
articleforNGbooking | 記事(ブッキングNG用) |
String, Null |
None. |
bookingApplicationNo | ブッキング申込番号 |
String, Null |
None. |
bookingNo | ブッキング番号 |
String, Null |
None. |
bookingReceivedDate | ブッキング受付年月日 |
String, Null |
None. |
businessTypeId | 事業種別ID |
String |
Required Format : Protect Pattern : ^(?!.*(\?|\$|#|&|,|=)).*$ |
cargoPackingCode | 貨物荷姿コード |
String, Null |
None. |
cargoQuantity | 貨物個数 |
Number, Null |
Format : Number(8,0) Minimum : 0 |
cargoType | 貨物タイプ |
String, Null |
None. |
cargoTypeCode | 貨物種類コード |
String, Null |
None. |
cargoVolume | 貨物容積 |
Number, Null |
Format : Number(9,3) Maximum : 999999.999 Minimum : 0 |
cargoWeight | 貨物重量 |
Number, Null |
Format : Number(9,3) Maximum : 999999.999 Minimum : 0 |
containerDetails |
Collection, Null of containerDetails |
None. |
|
containerRequests |
Collection, Null of containerRequests |
Format : Reference("/API/v1/Root/ContainerRequests/OData?$select=request_containerLengthCode,request_containerHeightCode,request_containerTypeCode,request_numberOfContainers,containerPickUpPlaceName,temperature,temperatureUnitCode,humidity,overSizeHeight,overSizeLeft,overSizeRight,overSizeFront,overSizeRear,containerRequestId,dealNo,sortNo,partitionNo&$filter=dealNo+eq+{value}&$orderby=sortNo",request_containerLengthCode,request_containerHeightCode,request_containerTypeCode,request_numberOfContainers,containerPickUpPlaceName,temperature,temperatureUnitCode,humidity,overSizeHeight,overSizeLeft,overSizeRight,overSizeFront,overSizeRear,containerRequestId,dealNo,sortNo,partitionNo);Protect;Notify |
|
dealInformation |
Required |
||
dealReportId | 取引・帳票ID |
String |
Required |
deliveryLocationCode | 荷渡地コード |
String, Null |
None. |
deliveryLocationName | 荷渡地名 |
String, Null |
None. |
deliveryTypeCode | 荷渡形態コード |
String, Null |
None. |
estimatedDepartureDate | 出港予定年月日 |
String, Null |
None. |
finalDestinationCode | 最終仕向地コード |
String, Null |
None. |
finalDestinationName | 最終仕向地名 |
String, Null |
None. |
forwarderCode | 海貨業者コード |
String, Null |
None. |
forwarderName | 海貨業者名 |
String, Null |
None. |
invoice |
Required |
||
notificationCodeOffloadingPortCY | 通知先コード(積出港CY) |
String, Null |
None. |
notificationCodeOthers | 通知先コード(その他) |
String, Null |
None. |
notificationDestinationCodeReceiptPlaceCY | 通知先コード(荷受地CY) |
String, Null |
None. |
offloadingPortCode | 積出港コード |
String, Null |
None. |
organizationId | 組織ID |
String |
Required Format : Protect Pattern : ^(?!.*(\?|\$|#|&|,|=)).*$ |
packingCode | 荷姿コード |
String, Null |
None. |
partitionNo | パーティション番号 |
Integer, Null |
Format : Protect |
processClassificationCode | 処理区分コード |
String, Null |
None. |
productName | 品名 |
String, Null |
None. |
receiptLocationCode | 荷受地コード |
String, Null |
None. |
receiptTypeCode | 荷受形態コード |
String, Null |
None. |
shipCodetobeLoaded | 積載予定船舶コード |
String, Null |
None. |
shipNametobeLoaded | 積載予定船舶名 |
String, Null |
None. |
shipperCode | 荷送人コード |
String, Null |
None. |
shipperName | 荷送人名 |
String, Null |
None. |
shippingCompanyCode | 船会社コード |
String, Null |
None. |
shipWholesalePortCode1 | 船卸港コード 1 |
String, Null |
None. |
shipWholesalePortCode2 | 船卸港コード 2 |
String, Null |
None. |
transhipPort | Tranship Port |
String, Null |
None. |
volumeUnitCode | 容積単位コード |
String, Null |
None. |
voyageNo | 航海番号 |
String, Null |
None. |
weightUnitCode | 重量単位コード |
String, Null |
None. |
Response Information
Resource Description
None.