POST /API/v1/Report/TerminalInquiry/Register
帳票:ターミナル問合せを保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対して、Write権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(etag)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 ## 指定するパラメタについて ### 取引管理番号 帳票を作成する取引の取引管理番号(***dealNo***)を指定します。 ### 帳票を作成する組織の組織ID・事業種別ID 帳票を作成する権限のある組織の組織ID(***organizationId***)と事業種別ID(***businessTypeId***)のセットで指定します。
Request Information
URI Parameters
None.
Body Parameters
TerminalInquiry
Name | Description | Type | Additional information |
---|---|---|---|
_etag | etag |
String |
Required |
bookingNo | ブッキング(船腹予約)番号 |
String, Null |
None. |
businessTypeId | 事業種別ID |
String |
Required Format : Protect Pattern : ^(?!.*(\?|\$|#|&|,|=)).*$ |
chargeDetails | 料金詳細 |
String, Null |
None. |
containerDetails |
Collection, Null of containerDetails |
None. |
|
customerCompanyName | 問合せ元_会社名 |
String, Null |
None. |
customerEmail | 問合せ元_メールアドレス |
String, Null |
None. |
customerPersonInCharge | 問合せ元_担当者 |
String, Null |
None. |
customerTel | 問合せ元_電話番号 |
String, Null |
None. |
customId | カスタムID |
String, Null |
Format : Protect |
dealReportId | 取引・帳票ID |
String |
Required |
errorMessage | エラーメッセージ |
String, Null |
None. |
inquiryDate | 問合せ日付 |
String, Null |
None. |
inquiryItem | 問合せ項目 |
String, Null |
None. |
inspectionDate | 検査日付 |
String, Null |
None. |
inspectionTime | 検査時刻 |
String, Null |
Pattern : ^([01][0-9]|2[0-3]):[0-5][0-9]$ |
inspectionType | 検査種別 |
String, Null |
None. |
number | B/L番号 |
String, Null |
None. |
organizationId | 組織ID |
String |
Required Format : Protect Pattern : ^(?!.*(\?|\$|#|&|,|=)).*$ |
partitionNo | パーティション番号 |
Integer, Null |
Format : Protect |
scacCode | 船社コード |
String, Null |
Format : ForeignKey /API/v1/Master/BusinessCodes?$filter=categoryCode eq '021' and businessCode eq '{value}' |
status | ステータス |
String, Null |
None. |
totalCharge | 料金合計 |
Number, Null |
Format : Number(9,0) Maximum : 999999999 Minimum : 0 |
Response Information
Resource Description
None.