Data Dictionary Home

TerminalInquiries : /API/v2/Reports/TerminalInquiries

Venndor name

0000000000000_CyberPort（港湾物流分野）

System name

CyberPort

ターミナル問合せ

Infomation
Category
Field
Governments
Data / Business logic	Business logic
Paid / Free	Free
Fees
Created by
Maintainer
Date created
Last updated
Update frequency
Necessity of contract	Unnecessary
About contract
Version
Terms and Conditions

API List

API		Description
POST	/API/v2/Reports/TerminalInquiries/Create	ターミナル問合せを作成します。ターミナル問合せを作成するには、利用者がターミナル問合せを作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。ターミナル問合せに関する詳細については、[ターミナル問合せについて]()を参照ください。
DELETE	/API/v2/Reports/TerminalInquiries/Delete/{reportId}	ターミナル問合せを削除します。帳票ID（*reportId）を指定して、ターミナル問合せを削除します。ターミナル問合せを削除しても、ルートドキュメントの内容までは削除されません。申請種別を使用して、作成したターミナル問合せのキャンセルを伝える場合は、キャンセル（Cancel）を実施後、帳票の提出（Submit*）を実施してください。ターミナル問合せに関する詳細については、[ターミナル問合せについて]()を参照ください。
DELETE	/API/v2/Reports/TerminalInquiries/DeleteFile/{fileId}	ターミナル問合せの添付ファイルを削除します。ファイルID（*fileId*）を指定して、ターミナル問合せの添付ファイルを削除します。帳票の添付ファイルを削除できるのは、そのファイルを添付したパートナーに所属している利用者だけです。帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。
GET	/API/v2/Reports/TerminalInquiries/Get/{reportId}	ターミナル問合せを取得します。帳票ID（*reportId*）を指定して、ターミナル問合せを取得します。編集が行われていない場合は、ルートドキュメントから最新の搬入確認依頼票を取得します。編集中の場合は、先に保存した、ターミナル問合せを取得します。ターミナル問合せに関する詳細については、[ターミナル問合せについて]()を参照ください。
GET	/API/v2/Reports/TerminalInquiries/GetFile/{fileId}	ターミナル問合せに添付されたファイルを取得します。ファイルID（*fileId）を指定して、ターミナル問合せに添付されたファイルを取得します。帳票の添付ファイルを獲得できるパートナーは、帳票にアクセス可能なパートナー（/API/v2/Reports/AccessiblePartners*）にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。
GET	/API/v2/Reports/TerminalInquiries/GetList?tradeNo=!{tradeNo}&uniqueNo=!{uniqueNo}&bookingNo=!{bookingNo}&blNo=!{blNo}	ターミナル問合せを全て取得します。検索条件に該当するターミナル問合せを全て取得します。編集が行われていない場合は、ルートドキュメントから最新のターミナル問合せを取得します。編集中の場合は、先に保存した、ターミナル問合せを取得します。ターミナル問合せに関する詳細については、[ターミナル問合せについて]()を参照ください。
PATCH	/API/v2/Reports/TerminalInquiries/Lock/{reportId}	編集するため、ターミナル問合せをロックします帳票ID（*reportId）を指定して、ターミナル問合せをロックします。ターミナル問合せを作成（Create）した時点では、ターミナル問合せをロックが掛かりますが、取得（Get）したあとで、ターミナル問合せを編集する場合は、このメソッドを呼び出して、ターミナル問合せをロックします。ロックされたターミナル問合せは、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、ターミナル問合せをルートドキュメントから参照できますが、編集中（ロック中）のターミナル問合せは参照できません。このロックは、アンロック（Unlock）を呼び出すか、帳票の保存後、帳票の提出（Submit**）を行うと解除されます。ターミナル問合せに関する詳細については、[ターミナル問合せについて]()を参照ください。
PATCH	/API/v2/Reports/TerminalInquiries/SetCancel/{reportId}	ターミナル問合せの申請種別をキャンセルします帳票ID（*reportId）を指定して、ターミナル問合せの申請種別（applyType）を、キャンセル（CANCEL）にします。申請種別（applyType）が、訂正（AMEND）の場合に、この操作は有効になります。このメソッドで、申請種別（applyType）を、キャンセル（CANCEL）にし、帳票の提出（Submit*）することで、申請種別が確定します。ターミナル問合せに関する詳細については、[ターミナル問合せについて]()を参照ください。
PATCH	/API/v2/Reports/TerminalInquiries/Submit/{reportId}	ターミナル問合せを提出します帳票ID（*reportId）を指定して、更新（Update）したターミナル問合せを提出します。このメソッドでは、変更内容をルートドキュメントへ反映し、ターミナル問合せが参照できる取引内のパートナーに、変更内容を公開することになります。帳票の更新（Update*）しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ターミナル問合せもロックされた状態のままなので、ご注意ください。ターミナル問合せに関する詳細については、[ターミナル問合せについて]()を参照ください。
PATCH	/API/v2/Reports/TerminalInquiries/Unlock/{reportId}	ターミナル問合せのロックを解除します帳票ID（*reportId）を指定して、ターミナル問合せのロックを解除します。更新内容のルートドキュメントへの反映は、帳票の提出（Submit*）で行うので、このメソッドを呼び出すと、編集内容は破棄されます。ターミナル問合せに関する詳細については、[ターミナル問合せについて]()を参照ください。
PATCH	/API/v2/Reports/TerminalInquiries/Update/{reportId}	ターミナル問合せを更新します。帳票ID（*reportId）を指定して、ターミナル問合せを更新します。このメソッドでは、ターミナル問合せの更新内容を保存しますが、ルートドキュメントへの反映は実施しません。ルートドキュメントへの反映は、帳票の提出メソッド（Submit*）を使用します。ターミナル問合せに関する詳細については、[ターミナル問合せについて]()を参照ください。
POST	/API/v2/Reports/TerminalInquiries/UploadFile	ターミナル問合せにファイルを添付します。指定されたターミナル問合せに、ファイルを添付します。帳票にファイルを添付できるパートナーは、帳票にアクセス可能なパートナー（*/API/v2/Reports/AccessiblePartners*）にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。