Data Dictionary Home

MatchingResults : /API/v1/Report/MatchingResults

Venndor name

システム管理ベンダー

System name

システム管理システム

照合結果

Infomation
Category
Field
Governments
Data / 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/v1/Report/MatchingResults/Create	帳票：照合結果を作成します。 ## 概要帳票を作成するには、その帳票を格納する取引を作成、または参加している組織（と事業種別）に所属するユーザであり、かつ、その帳票に対して、Write権限が必要です。また、取引内に帳票：照合結果が存在する場合は、ステータスコード：200となり、Getメソッドと同じ動作となります。 ## 指定するパラメタについて ### 取引管理番号帳票を作成する取引の取引管理番号（*dealNo）を指定します。 ### 帳票を作成する組織の組織ID・事業種別ID 帳票を作成する権限のある組織の組織ID（organizationId）と事業種別ID（businessTypeId*）のセットで指定します。
POST	/API/v1/Report/MatchingResults/CreateByBlNo	B/L番号を指定して、帳票：照合結果を作成します。 ## 概要ユーザが所属している組織が作成、または参加している取引の中から、指定されたB/L番号（*blNo）に該当する取引に対して、帳票：照合結果を作成します。帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織（と事業種別）に所属するユーザであり、かつ、その帳票に対して、Write権限が必要です。ただし、指定されたB/L番号（blNo）に該当する取引が複数存在する場合はエラーとなります。 ## 指定するパラメタについて ### B/L番号 B/L番号（blNo）は、取引に対して設定するのではなく、帳票を通して（帳票の項目として）設定します。 ### 帳票を作成する組織の組織ID・事業種別ID 帳票を作成する権限のある組織の組織ID（organizationId）と事業種別ID（businessTypeId*）のセットで指定します。
POST	/API/v1/Report/MatchingResults/CreateByBookingNo	ブッキング番号を指定して、帳票：照合結果を作成します。 ## 概要ユーザが所属している組織が作成、または参加している取引の中から、指定された船社コード（*scacCode）とブッキング番号（bookingNo）に該当する取引に対して、帳票：照合結果を作成します。帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織（と事業種別）に所属するユーザであり、かつ、その帳票に対して、Write権限が必要です。ただし、指定された船社コード（scacCode）とブッキング番号（bookingNo）に該当する取引が複数存在する場合はエラーとなります。 ## 指定するパラメタについて ### 船社コード船社コード（scacCode）は、取引に対して設定するのではなく、帳票を通して（帳票の項目として）設定します。 ### ブッキング番号ブッキング番号（bookingNo）は、取引に対して設定するのではなく、帳票を通して（帳票の項目として）設定します。 ### 帳票を作成する組織の組織ID・事業種別ID 帳票を作成する権限のある組織の組織ID（organizationId）と事業種別ID（businessTypeId*）のセットで指定します。
POST	/API/v1/Report/MatchingResults/CreateByDomesticNo	社内管理番号を指定して、帳票：照合結果を作成します。 ## 概要ユーザが所属している組織が作成、または参加している取引の中から、指定された社内管理番号（*domesticNo）に該当する取引に対して、帳票：照合結果を作成します。帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織（と事業種別）に所属するユーザであり、かつ、その帳票に対して、Write権限が必要です。ただし、社内管理番号に該当する取引が複数存在する場合はエラーとなります。 ## 指定するパラメタについて ### 社内管理番号社内管理番号（domesticNo）を指定します。 ### 帳票を作成する組織の組織ID・事業種別ID 帳票を作成する権限のある組織の組織ID（organizationId）と事業種別ID（businessTypeId*）のセットで指定します。
DELETE	/API/v1/Report/MatchingResults/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId}	帳票：照合結果を削除します。 ## 概要帳票を削除できるのは、その帳票を作成した組織（と事業種別）に所属するユーザのみです。 ## 指定するパラメタについて ### 取引・帳票ID 削除する帳票の取引・帳票ID（*dealReportId）を指定します。 ### 帳票を削除する組織の組織ID・事業種別ID 帳票を削除する権限のある組織の組織ID（organizationId）と事業種別ID（businessTypeId*）のセットで指定します。
DELETE	/API/v1/Report/MatchingResults/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId}&containerNo={containerNo}	B/L番号を指定して、帳票：照合結果を削除します。 ## 概要帳票を削除できるのは、その帳票を作成した組織（と事業種別）に所属するユーザのみです。指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 ## 指定するパラメタについて ### B/L番号削除する帳票のB/L番号（*blNo）を指定します。 ### 帳票を削除する組織の組織ID・事業種別ID 帳票を削除する権限のある組織の組織ID（organizationId）と事業種別ID（businessTypeId*）のセットで指定します。
DELETE	/API/v1/Report/MatchingResults/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId}&containerNo={containerNo}	ブッキング番号を指定して、帳票：照合結果を削除します。 ## 概要帳票を削除できるのは、その帳票を作成した組織（と事業種別）に所属するユーザのみです。指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 ## 指定するパラメタについて ### 船社コード削除する帳票の船社コード（*scacCode）を指定します。 ### ブッキング番号削除する帳票のブッキング番号（bookingNo）を指定します。 ### 帳票を削除する組織の組織ID・事業種別ID 帳票を削除する権限のある組織の組織ID（organizationId）と事業種別ID（businessTypeId*）のセットで指定します。
DELETE	/API/v1/Report/MatchingResults/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId}&containerNo={containerNo}	取引管理番号を指定して、帳票：照合結果を削除します。 ## 概要帳票を削除できるのは、その帳票を作成した組織（と事業種別）に所属するユーザのみです。指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 ## 指定するパラメタについて ### 取引管理番号削除する帳票の取引管理番号（*dealNo）を指定します。 ### 帳票を削除する組織の組織ID・事業種別ID 帳票を削除する権限のある組織の組織ID（organizationId）と事業種別ID（businessTypeId*）のセットで指定します。
DELETE	/API/v1/Report/MatchingResults/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId}&containerNo={containerNo}	社内管理番号を指定して、帳票：照合結果を削除します。 ## 概要帳票を削除できるのは、その帳票を作成した組織（と事業種別）に所属するユーザのみです。指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 ## 指定するパラメタについて ### 社内管理番号削除する帳票の社内管理番号（*domesticNo）を指定します。 ### 帳票を削除する組織の組織ID・事業種別ID 帳票を削除する権限のある組織の組織ID（organizationId）と事業種別ID（businessTypeId*）のセットで指定します。
GET	/API/v1/Report/MatchingResults/Get/{dealReportId}	帳票：照合結果を取得します。 ## 概要帳票を取得するには、その帳票が格納された取引を作成、または参加している組織（と事業種別）に所属するユーザであり、かつ、その帳票に対して、Read権限が必要です。 ## 指定するパラメタについて ### 取引・帳票ID 取得する帳票の取引・帳票ID（*dealReportId*）を指定します。
GET	/API/v1/Report/MatchingResults/GetListByBlNo/{blNo}?containerNo={containerNo}	B/L番号を指定して、帳票：照合結果を取得します。 ## 概要ユーザが所属している組織が作成、または参加している取引の中から、B/L番号（*blNo）に該当する取引より、照合結果を取得します。取引内に作成する帳票にB/L番号（blNo）を設定すると、その帳票が格納された取引はB/L番号（blNo）で特定できるようになります。このAPIでは、指定されたB/L番号（blNo）が附番されている全ての取引から、帳票：照合結果を取得します。 ## 指定するパラメタについて ### B/L番号 B/L番号（blNo*）は、取引に対して設定するのではなく、帳票を通して（帳票の項目として）設定します。
GET	/API/v1/Report/MatchingResults/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&containerNo={containerNo}	ブッキング番号を指定して、帳票：照合結果を取得します。 ## 概要ユーザが所属している組織が作成、または参加している取引の中から、船社コード（*scacCode）とブッキング番号（bookingNo）に該当する取引より、帳票：照合結果を取得します。取引内に作成する帳票に船社コード（scacCode）とブッキング番号（bookingNo）を設定すると、その帳票が格納された取引は船社コード（scacCode）とブッキング番号（bookingNo）で特定できるようになります。このAPIでは、指定された船社コード（scacCode）とブッキング番号（bookingNo）が附番されている全ての取引から、帳票：照合結果を取得します。 ## 指定するパラメタについて ### 船社コード船社コード（scacCode）は、取引に対して設定するのではなく、帳票を通して（帳票の項目として）設定します。 ### ブッキング番号ブッキング番号（bookingNo*）は、取引に対して設定するのではなく、帳票を通して（帳票の項目として）設定します。
GET	/API/v1/Report/MatchingResults/GetListByDealNo/{dealNo}	取引管理番号を指定して、帳票：照合結果を取得します。 ## 概要ユーザが所属している組織が作成、または参加している取引の中から、取引管理番号（*dealNo）に該当する取引より、帳票：照合結果を取得します。 ## 指定するパラメタについて ### 取引管理番号取引管理番号（dealNo*）を指定します。
GET	/API/v1/Report/MatchingResults/GetListByDomesticNo/{domesticNo}?containerNo={containerNo}	社内管理番号を指定して、帳票：照合結果を取得します。 ## 概要ユーザが所属している組織が作成、または参加している取引の中から、社内管理番号（*domesticNo）に該当する取引より、帳票：照合結果を取得します。社内管理番号（domesticNo）は、取引管理番号の別名として機能します。社内管理番号（domesticNo）は取引に参加している組織・事業種別毎に附番できるので、各組織で任意の文字列による取引の特定が可能になります。このAPIでは、社内管理番号（domesticNo）が附番されている全ての取引から、帳票：照合結果を取得します。 ## 指定するパラメタについて ### 社内管理番号社内管理番号（domesticNo*）を指定します。
POST	/API/v1/Report/MatchingResults/Register	帳票：照合結果を保存します。 ## 概要帳票を保存するには、その帳票を格納する取引を作成、または参加している組織（と事業種別）に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子（*_etag）がつけられています。このバージョン識別子（_etag）は、帳票の保存（Register）が行われると、違う値に更新されます。帳票の保存（Register）のときに、このバージョン識別子（_etag）が異なると、排他エラー（409：Conflict*）が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。