ExchangeRateInquiries : /API/v1/NaccsReport/ExchangeRateInquiries

Venndor name

システム管理ベンダー

System name

システム管理システム

IER

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

APIDescription
POST /API/v1/NaccsReport/ExchangeRateInquiries/Create

帳票:IERを作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 帳票:IERが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。

POST /API/v1/NaccsReport/ExchangeRateInquiries/CreateByBlNo

B/L番号を指定して、帳票:IERを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定されたB/L番号(***blNo***)に該当する取引に対して、帳票:IERを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定されたB/L番号(***blNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:IERが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。

POST /API/v1/NaccsReport/ExchangeRateInquiries/CreateByBookingNo

ブッキング番号を指定して、帳票:IERを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:IERを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:IERが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。

POST /API/v1/NaccsReport/ExchangeRateInquiries/CreateByDomesticNo

社内管理番号を指定して、帳票:IERを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:IERを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:IERが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。

DELETE /API/v1/NaccsReport/ExchangeRateInquiries/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId}

帳票:IERを削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。

DELETE /API/v1/NaccsReport/ExchangeRateInquiries/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId}

B/L番号を指定して、帳票:IERを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、帳票:IERを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。

DELETE /API/v1/NaccsReport/ExchangeRateInquiries/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId}

ブッキング番号を指定して、帳票:IERを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:IERを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。

DELETE /API/v1/NaccsReport/ExchangeRateInquiries/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId}

取引管理番号を指定して、帳票:IERを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:IERを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。

DELETE /API/v1/NaccsReport/ExchangeRateInquiries/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId}

社内管理番号を指定して、帳票:IERを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:IERを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。

GET /API/v1/NaccsReport/ExchangeRateInquiries/Get/{dealReportId}

帳票:IERを取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。

GET /API/v1/NaccsReport/ExchangeRateInquiries/GetByDealNo/{dealNo}

取引管理番号を指定して、帳票:IERを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:IERを取得します。

GET /API/v1/NaccsReport/ExchangeRateInquiries/GetListByBlNo/{blNo}

B/L番号を指定して、帳票:IERを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、IERを取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が付番されている全ての取引から、帳票:IERを取得します。

GET /API/v1/NaccsReport/ExchangeRateInquiries/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}

ブッキング番号を指定して、帳票:IERを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:IERを取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が付番されている全ての取引から、帳票:IERを取得します。

GET /API/v1/NaccsReport/ExchangeRateInquiries/GetListByDomesticNo/{domesticNo}

社内管理番号を指定して、帳票:IERを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:IERを取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:IERを取得します。

POST /API/v1/NaccsReport/ExchangeRateInquiries/NaccsSendRequest

本業務のNACCS送信を依頼します。 ## 概要 登録業務の場合、取引・帳票ID(***dealReportId***)で指定した帳票から電文を生成しNACCSへ送信します。呼出業務、照会業務の場合は、指定したパラメータから電文を生成しNACCSへ送信します。 ## 送信条件 NACCSへ送信するにはユーザがNACCS利用者IDと紐づけられている必要があります。 また、本帳票に対するWrite権限、Send権限が必要です。 ## 指定するパラメタについて ### NACCS業務コード 送信を行うNACCS業務コード(***naccsBusinessCode***)を必ず指定します。 APIと指定したNACCS業務コードがアンマッチの場合エラーとなります。 ### 組織ID 自身が所属する組織で、且つ、本業務のNACCS送信権限のある事業種別を持っている組織IDを(***organizationId***)を必ず指定します。 指定した組織にユーザが所属していない場合エラーとなります。 ### 事業種別ID 自身が所属する組織で、且つ、本業務のNACCS送信権限のある事業種別(***businessTypeId***)を必ず指定します。 指定した組織にない事業種別の場合エラーとなります。 また送信権限のない事業種別の場合もエラーとなります。 ### 取引管理番号 取引管理番号(***dealNo***)を必ず指定します。 組織が、指定した取引管理番号に紐づく取引の所属していない場合エラーとなります。 但し、照会業務で取引管理番号に空文字を指定した場合、取引外照会としてNACCSへ送信されます。 ### 取引・帳票ID 取引・帳票ID(***dealReportId***)を必ず指定します。 組織が帳票のWrite権限を持っていない場合エラーとなります。 また取引・帳票IDで指定された帳票が、本業務の帳票で無い場合エラーとなります。 但し、照会業務で取引・帳票IDに空文字を指定した場合、取引外照会としてNACCSへ送信されます。 ### NACCS利用者コード、NACCS識別番号 ユーザと紐づいているNACCS利用者コード(***naccsUserCode***)、NACCS識別番号(***naccsIdNo***)を必ず指定します。 指定したNACCS利用者コード、NACCS識別番号がユーザと紐づいているNACCS利用者コード、NACCS識別番号で無い場合エラーとなります。 ### 検索条件項目 呼出業務、照会業務の場合は、業務毎に必要なパラメータを指定します。 指定したパラメータから電文が生成されます。 未指定の場合は空白埋めとなります。 ## 取引外照会について 取引外照会を行う場合、以下項目を空文字を指定してください ・取引管理番号(***dealNo***) ・取引・帳票ID(***dealReportId***)

POST /API/v1/NaccsReport/ExchangeRateInquiries/Register

帳票:IERを保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。