POST /API/v1/Report/BookingRequests/Register

帳票:ブッキング依頼書を保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 ## 申請種別について 申請種別(***applicationType***)は、区分値として、***NEW***(新規)、***AMEND***(訂正)、***CANCEL***(キャンセル)のいずれかの区分値を設定できます。 また、設定できる値には以下の制約があります。 ・当該帳票が未送信のときは、申請種別に***NEW***のみ設定可能。(***AMEND***か***CANCEL***が設定されていたらエラー(***400:BadRequest***)が発生します) ・当該帳票が既に送信済みのときは、申請種別に***AMEND***か***CANCEL***が設定可能。(***NEW***が設定された場合は***AMEND***に自動で置換します) 値が未設定であれば、当該帳票の送信回数によってデフォルト値をセットします。(初回送信時:***NEW*** 2回目以降:***AMEND***)

Request Information

URI Parameters

None.

Body Parameters

BookingRequests

BookingRequests

NameDescriptionTypeAdditional information
_etag

etag

String

Required

applicationType

申請種別

String, Null

None.

businessTypeId

事業種別ID

String

Required

Format : Protect

Pattern : ^(?!.*(\?|\$|#|&|,|=)).*$

containerRequests

Collection, Null of containerRequests

Format : Reference("/API/v1/Root/ContainerRequests/OData?$select=containerRequestId,dealNo,sortNo,request_containerLengthCode,request_containerHeightCode,request_containerTypeCode,request_numberOfContainers,fullOrEmpty,containerPickUpPlaceName,containerPickUpDate,containerVanDevanPlaceName,containerVanDevanPlaceAddress,containerVanDevanPlacePersoninCharge,containerVanDevanPlaceTel,containerVanDevanPlaceFax,containerVanDevanPlaceCellPhone,overSize,overSizeHeight,overSizeLeft,overSizeRight,overSizeFront,overSizeRear,individualQuickFrozen,cargoType,existenceOfDangerousGoods,imoClass,marinePollutant,unNo,numberOfProbes,stuffieContainer,sortieContainer,ventilationDivision,ventilationOpeningRate,ventilationCMH,controlledAtmosphereO2,controlledAtmosphereCo2,humidity,ethyleneFilter,highValueCargo,fishloaderService,temperature,temperatureUnitCode,minimumAcceptable,maximumAcceptable,drainHoles,gensetRequired,preCooling,coldTreatment,partitionNo&$filter=dealNo+eq+{value}&$orderby=sortNo",containerRequestId,dealNo,sortNo,request_containerLengthCode,request_containerHeightCode,request_containerTypeCode,request_numberOfContainers,fullOrEmpty,containerPickUpPlaceName,containerPickUpDate,containerVanDevanPlaceName,containerVanDevanPlaceAddress,containerVanDevanPlacePersoninCharge,containerVanDevanPlaceTel,containerVanDevanPlaceFax,containerVanDevanPlaceCellPhone,overSize,overSizeHeight,overSizeLeft,overSizeRight,overSizeFront,overSizeRear,individualQuickFrozen,cargoType,existenceOfDangerousGoods,imoClass,marinePollutant,unNo,numberOfProbes,stuffieContainer,sortieContainer,ventilationDivision,ventilationOpeningRate,ventilationCMH,controlledAtmosphereO2,controlledAtmosphereCo2,humidity,ethyleneFilter,highValueCargo,fishloaderService,temperature,temperatureUnitCode,minimumAcceptable,maximumAcceptable,drainHoles,gensetRequired,preCooling,coldTreatment,partitionNo);Protect;Notify

customerCargo

顧客貨物

String, Null

None.

dealInformation

dealInformation

Required

dealReportId

取引・帳票ID

String

Required

invoice

invoice

Required

note1

備考1

String, Null

Min length: 0

Max length: 140

note2

備考2

String, Null

None.

note3

備考3

String, Null

None.

organizationId

組織ID

String

Required

Format : Protect

Pattern : ^(?!.*(\?|\$|#|&|,|=)).*$

partitionNo

パーティション番号

Integer, Null

Format : Protect

printedDate

書類発行日

String, Null

Format : date

publisherAddress

書類発行者_住所

String, Null

None.

publisherCompanyName

書類発行者_会社名

String, Null

None.

publisherEmail

書類発行者_メールアドレス

String, Null

None.

publisherFax

書類発行者_FAX番号

String, Null

None.

publisherPersonInCharge

書類発行者_担当者

String, Null

None.

publisherTel

書類発行者_電話番号

String, Null

None.

remarks

摘要

String, Null

None.

Response Information

Resource Description

None.