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