BookingChanges : /API/v2/NaccsReports/BookingChanges

Venndor name

0000000000000_CyberPort(港湾物流分野)

System name

CyberPort

BKC_ブッキング情報変更

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

APIDescription
POST /API/v2/NaccsReports/BookingChanges/Create

BKCを作成します。 BKCを作成するには、利用者がBKCを作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。

DELETE /API/v2/NaccsReports/BookingChanges/Delete/{reportId}

BKCを削除します。 帳票ID(***reportId***)を指定して、、BKCを削除します。 BKCを削除しても、ルートドキュメントの内容までは削除されません。

DELETE /API/v2/NaccsReports/BookingChanges/DeleteFile/{fileId}

BKCの添付ファイルを削除します。 ファイルID(***fileId***)を指定して、BKCの添付ファイルを削除します。

GET /API/v2/NaccsReports/BookingChanges/Get/{reportId}

BKCを取得します。 帳票ID(***reportId***)を指定して、BKC取得します。 編集が行われていない場合は、ルートドキュメントから最新のBKCを取得します。 編集中の場合は、先に保存した、BKCを取得します。

GET /API/v2/NaccsReports/BookingChanges/GetFile/{fileId}

BKCに添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、BKCに添付されたファイルを取得します。

PATCH /API/v2/NaccsReports/BookingChanges/Lock/{reportId}

編集するため、BKCをロックします。 帳票ID(***reportId***)を指定して、BKCをロックします。 BKCを作成(***Create***)した時点では、ロックが掛かりますが、取得(***Get***)したあとで、BKCを編集する場合は、このメソッドを呼び出してロックします。 ロックされたBKCは、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、BKCをルートドキュメントから参照できますが、編集中(ロック中)のBKCは参照できません。

POST /API/v2/NaccsReports/BookingChanges/SendToNaccs

BKCをNACCSへ送信します。 取引管理番号(***tradeNo***)、帳票ID(***reportId***)を指定して、更新(***Update***)したBKCをNACCSへ送信します。 このメソッドでは、変更内容をルートドキュメントへ反映し、BKCが参照できる取引内のパートナーに、変更内容を公開することになります。 その後、指定されたパラメータと登録情報をもとにNACCSへ送信を行います。 取引外照会の場合には、取引管理番号(***tradeNo***)、帳票ID(***reportId***)に空文字を指定してください。

PATCH /API/v2/NaccsReports/BookingChanges/SetCancel/{reportId}

BKCの申請種別をキャンセルします。 帳票ID(***reportId***)を指定して、BKCの申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。

PATCH /API/v2/NaccsReports/BookingChanges/Submit/{reportId}

BKCを提出します。 帳票ID(***reportId***)を指定して、更新(***Update***)したBKCを提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、BKCが参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ロックされた状態のままなのでご注意ください。

POST /API/v2/NaccsReports/BookingChanges/SubmitByPost

BKCを提出します。 動作は帳票の提出メソッド(***Submit***)と同様です。

PATCH /API/v2/NaccsReports/BookingChanges/Unlock/{reportId}

BKCのロックを解除します。 帳票ID(***reportId***)を指定して、BKCのロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。

PATCH /API/v2/NaccsReports/BookingChanges/Update/{reportId}

BKCを更新します。 帳票ID(***reportId***)を指定して、BKCを更新します。 このメソッドでは、BKCの更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。

POST /API/v2/NaccsReports/BookingChanges/UpdateByPost

BKCを更新します。 動作は帳票の更新メソッド(***Update***)と同様です。

POST /API/v2/NaccsReports/BookingChanges/UploadFile

BKCにファイルを添付します。 指定されたBKCに、ファイルを添付します。