ACL01
ACL01_ACL情報登録(コンテナ船用)
API | Description | ||
---|---|---|---|
POST | /API/v1/NACCS/ACL01/Create |
帳票:ACL01_ACL情報登録(コンテナ船用)を作成します。 帳票:ACL01_ACL情報登録(コンテナ船用)を作成します。帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対して、Write権限が必要です。また、取引内に帳票:ACL01_ACL情報登録(コンテナ船用)が存在する場合は、ステータスコード:200となり、Getメソッドと同じ動作となります。 |
|
DELETE | /API/v1/NACCS/ACL01/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:ACL01_ACL情報登録(コンテナ船用)を削除します。 帳票:ACL01_ACL情報登録(コンテナ船用)を削除します。帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
GET | /API/v1/NACCS/ACL01/Get/{dealReportId} |
帳票:ACL01_ACL情報登録(コンテナ船用)を取得します。 帳票:ACL01_ACL情報登録(コンテナ船用)を取得します。帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対して、Read権限が必要です。 |
AclInformationInquiries
IAL
API | Description | ||
---|---|---|---|
POST | /API/v1/NaccsReport/AclInformationInquiries/Create |
帳票:IALを作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 帳票:IALが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/AclInformationInquiries/CreateByBlNo |
B/L番号を指定して、帳票:IALを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定されたB/L番号(***blNo***)に該当する取引に対して、帳票:IALを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定されたB/L番号(***blNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:IALが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/AclInformationInquiries/CreateByBookingNo |
ブッキング番号を指定して、帳票:IALを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:IALを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:IALが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/AclInformationInquiries/CreateByDomesticNo |
社内管理番号を指定して、帳票:IALを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:IALを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:IALが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/NaccsReport/AclInformationInquiries/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:IALを削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/NaccsReport/AclInformationInquiries/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
B/L番号を指定して、帳票:IALを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、帳票:IALを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/AclInformationInquiries/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId} |
ブッキング番号を指定して、帳票:IALを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:IALを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/AclInformationInquiries/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
取引管理番号を指定して、帳票:IALを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:IALを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/AclInformationInquiries/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
社内管理番号を指定して、帳票:IALを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:IALを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/NaccsReport/AclInformationInquiries/Get/{dealReportId} |
帳票:IALを取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/NaccsReport/AclInformationInquiries/GetByDealNo/{dealNo} |
取引管理番号を指定して、帳票:IALを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:IALを取得します。 |
|
GET | /API/v1/NaccsReport/AclInformationInquiries/GetListByBlNo/{blNo} |
B/L番号を指定して、帳票:IALを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、IALを取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が付番されている全ての取引から、帳票:IALを取得します。 |
|
GET | /API/v1/NaccsReport/AclInformationInquiries/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo} |
ブッキング番号を指定して、帳票:IALを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:IALを取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が付番されている全ての取引から、帳票:IALを取得します。 |
|
GET | /API/v1/NaccsReport/AclInformationInquiries/GetListByDomesticNo/{domesticNo} |
社内管理番号を指定して、帳票:IALを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:IALを取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:IALを取得します。 |
|
POST | /API/v1/NaccsReport/AclInformationInquiries/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/AclInformationInquiries/Register |
帳票:IALを保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
AclRegistrationCalls
ACL11
API | Description | ||
---|---|---|---|
POST | /API/v1/NaccsReport/AclRegistrationCalls/Create |
帳票:ACL11を作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 帳票:ACL11が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/AclRegistrationCalls/CreateByBlNo |
B/L番号を指定して、帳票:ACL11を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定されたB/L番号(***blNo***)に該当する取引に対して、帳票:ACL11を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定されたB/L番号(***blNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:ACL11が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/AclRegistrationCalls/CreateByBookingNo |
ブッキング番号を指定して、帳票:ACL11を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:ACL11を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:ACL11が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/AclRegistrationCalls/CreateByDomesticNo |
社内管理番号を指定して、帳票:ACL11を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:ACL11を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:ACL11が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/NaccsReport/AclRegistrationCalls/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:ACL11を削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/NaccsReport/AclRegistrationCalls/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
B/L番号を指定して、帳票:ACL11を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、帳票:ACL11を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/AclRegistrationCalls/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId} |
ブッキング番号を指定して、帳票:ACL11を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:ACL11を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/AclRegistrationCalls/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
取引管理番号を指定して、帳票:ACL11を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:ACL11を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/AclRegistrationCalls/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
社内管理番号を指定して、帳票:ACL11を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:ACL11を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/NaccsReport/AclRegistrationCalls/Get/{dealReportId} |
帳票:ACL11を取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/NaccsReport/AclRegistrationCalls/GetByDealNo/{dealNo} |
取引管理番号を指定して、帳票:ACL11を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:ACL11を取得します。 |
|
GET | /API/v1/NaccsReport/AclRegistrationCalls/GetListByBlNo/{blNo} |
B/L番号を指定して、帳票:ACL11を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、ACL11を取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が付番されている全ての取引から、帳票:ACL11を取得します。 |
|
GET | /API/v1/NaccsReport/AclRegistrationCalls/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo} |
ブッキング番号を指定して、帳票:ACL11を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:ACL11を取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が付番されている全ての取引から、帳票:ACL11を取得します。 |
|
GET | /API/v1/NaccsReport/AclRegistrationCalls/GetListByDomesticNo/{domesticNo} |
社内管理番号を指定して、帳票:ACL11を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:ACL11を取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:ACL11を取得します。 |
|
POST | /API/v1/NaccsReport/AclRegistrationCalls/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/AclRegistrationCalls/Register |
帳票:ACL11を保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
AclRegistrationForShips
ACL01
API | Description | ||
---|---|---|---|
POST | /API/v1/NaccsReport/AclRegistrationForShips/Create |
帳票:ACL01を作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 帳票:ACL01が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/AclRegistrationForShips/CreateByBlNo |
B/L番号を指定して、帳票:ACL01を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定されたB/L番号(***blNo***)に該当する取引に対して、帳票:ACL01を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定されたB/L番号(***blNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:ACL01が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/AclRegistrationForShips/CreateByBookingNo |
ブッキング番号を指定して、帳票:ACL01を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:ACL01を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:ACL01が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/AclRegistrationForShips/CreateByDomesticNo |
社内管理番号を指定して、帳票:ACL01を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:ACL01を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:ACL01が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/NaccsReport/AclRegistrationForShips/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:ACL01を削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/NaccsReport/AclRegistrationForShips/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
B/L番号を指定して、帳票:ACL01を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、帳票:ACL01を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/AclRegistrationForShips/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId} |
ブッキング番号を指定して、帳票:ACL01を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:ACL01を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/AclRegistrationForShips/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
取引管理番号を指定して、帳票:ACL01を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:ACL01を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/AclRegistrationForShips/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
社内管理番号を指定して、帳票:ACL01を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:ACL01を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/NaccsReport/AclRegistrationForShips/Get/{dealReportId} |
帳票:ACL01を取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/NaccsReport/AclRegistrationForShips/GetByDealNo/{dealNo} |
取引管理番号を指定して、帳票:ACL01を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:ACL01を取得します。 |
|
GET | /API/v1/NaccsReport/AclRegistrationForShips/GetListByBlNo/{blNo} |
B/L番号を指定して、帳票:ACL01を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、ACL01を取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が付番されている全ての取引から、帳票:ACL01を取得します。 |
|
GET | /API/v1/NaccsReport/AclRegistrationForShips/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo} |
ブッキング番号を指定して、帳票:ACL01を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:ACL01を取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が付番されている全ての取引から、帳票:ACL01を取得します。 |
|
GET | /API/v1/NaccsReport/AclRegistrationForShips/GetListByDomesticNo/{domesticNo} |
社内管理番号を指定して、帳票:ACL01を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:ACL01を取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:ACL01を取得します。 |
|
POST | /API/v1/NaccsReport/AclRegistrationForShips/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/AclRegistrationForShips/Register |
帳票:ACL01を保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
ArrivalAndDepartureInquiries
IVS
API | Description | ||
---|---|---|---|
POST | /API/v1/NaccsReport/ArrivalAndDepartureInquiries/Create |
帳票:IVSを作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 帳票:IVSが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/ArrivalAndDepartureInquiries/CreateByBlNo |
B/L番号を指定して、帳票:IVSを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定されたB/L番号(***blNo***)に該当する取引に対して、帳票:IVSを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定されたB/L番号(***blNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:IVSが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/ArrivalAndDepartureInquiries/CreateByBookingNo |
ブッキング番号を指定して、帳票:IVSを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:IVSを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:IVSが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/ArrivalAndDepartureInquiries/CreateByDomesticNo |
社内管理番号を指定して、帳票:IVSを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:IVSを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:IVSが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/NaccsReport/ArrivalAndDepartureInquiries/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:IVSを削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/NaccsReport/ArrivalAndDepartureInquiries/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
B/L番号を指定して、帳票:IVSを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、帳票:IVSを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/ArrivalAndDepartureInquiries/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId} |
ブッキング番号を指定して、帳票:IVSを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:IVSを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/ArrivalAndDepartureInquiries/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
取引管理番号を指定して、帳票:IVSを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:IVSを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/ArrivalAndDepartureInquiries/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
社内管理番号を指定して、帳票:IVSを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:IVSを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/NaccsReport/ArrivalAndDepartureInquiries/Get/{dealReportId} |
帳票:IVSを取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/NaccsReport/ArrivalAndDepartureInquiries/GetByDealNo/{dealNo} |
取引管理番号を指定して、帳票:IVSを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:IVSを取得します。 |
|
GET | /API/v1/NaccsReport/ArrivalAndDepartureInquiries/GetListByBlNo/{blNo} |
B/L番号を指定して、帳票:IVSを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、IVSを取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が付番されている全ての取引から、帳票:IVSを取得します。 |
|
GET | /API/v1/NaccsReport/ArrivalAndDepartureInquiries/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo} |
ブッキング番号を指定して、帳票:IVSを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:IVSを取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が付番されている全ての取引から、帳票:IVSを取得します。 |
|
GET | /API/v1/NaccsReport/ArrivalAndDepartureInquiries/GetListByDomesticNo/{domesticNo} |
社内管理番号を指定して、帳票:IVSを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:IVSを取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:IVSを取得します。 |
|
POST | /API/v1/NaccsReport/ArrivalAndDepartureInquiries/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/ArrivalAndDepartureInquiries/Register |
帳票:IVSを保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
ArrivalNotices
到着通知
API | Description | ||
---|---|---|---|
POST | /API/v1/Report/ArrivalNotices/Create |
帳票:到着通知を作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 帳票:到着通知が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/Report/ArrivalNotices/CreateAttachFileMeta |
添付ファイルメタ情報を登録します。 |
|
POST | /API/v1/Report/ArrivalNotices/CreateByBlNo |
B/L番号を指定して、帳票:到着通知を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定されたB/L番号(***blNo***)に該当する取引に対して、帳票:到着通知を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定されたB/L番号(***blNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:到着通知が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/Report/ArrivalNotices/CreateByBookingNo |
ブッキング番号を指定して、帳票:到着通知を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:到着通知を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:到着通知が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/Report/ArrivalNotices/CreateByDomesticNo |
社内管理番号を指定して、帳票:到着通知を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:到着通知を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:到着通知が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/Report/ArrivalNotices/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:到着通知を削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/Report/ArrivalNotices/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
B/L番号を指定して、帳票:到着通知を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、帳票:到着通知を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/Report/ArrivalNotices/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId} |
ブッキング番号を指定して、帳票:到着通知を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:到着通知を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/Report/ArrivalNotices/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
取引管理番号を指定して、帳票:到着通知を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:到着通知を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/Report/ArrivalNotices/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
社内管理番号を指定して、帳票:到着通知を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:到着通知を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/Report/ArrivalNotices/Get/{dealReportId} |
帳票:到着通知を取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/Report/ArrivalNotices/GetAttachFileMetaList/{dealReportId} |
添付ファイル情報一覧を取得します。 |
|
GET | /API/v1/Report/ArrivalNotices/GetByDealNo/{dealNo} |
取引管理番号を指定して、帳票:到着通知を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:到着通知を取得します。 |
|
GET | /API/v1/Report/ArrivalNotices/GetListByBlNo/{blNo} |
B/L番号を指定して、帳票:到着通知を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、到着通知を取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が付番されている全ての取引から、帳票:到着通知を取得します。 |
|
GET | /API/v1/Report/ArrivalNotices/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo} |
ブッキング番号を指定して、帳票:到着通知を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:到着通知を取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が付番されている全ての取引から、帳票:到着通知を取得します。 |
|
GET | /API/v1/Report/ArrivalNotices/GetListByDomesticNo/{domesticNo} |
社内管理番号を指定して、帳票:到着通知を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:到着通知を取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:到着通知を取得します。 |
|
POST | /API/v1/Report/ArrivalNotices/Register |
帳票:到着通知を保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
AttachmentFileRegistrations
MSB
API | Description | ||
---|---|---|---|
POST | /API/v1/NaccsReport/AttachmentFileRegistrations/Create |
帳票:MSBを作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 帳票:MSBが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/AttachmentFileRegistrations/CreateByBlNo |
B/L番号を指定して、帳票:MSBを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定されたB/L番号(***blNo***)に該当する取引に対して、帳票:MSBを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定されたB/L番号(***blNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:MSBが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/AttachmentFileRegistrations/CreateByBookingNo |
ブッキング番号を指定して、帳票:MSBを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:MSBを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:MSBが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/AttachmentFileRegistrations/CreateByDomesticNo |
社内管理番号を指定して、帳票:MSBを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:MSBを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:MSBが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/NaccsReport/AttachmentFileRegistrations/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:MSBを削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/NaccsReport/AttachmentFileRegistrations/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
B/L番号を指定して、帳票:MSBを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、帳票:MSBを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/AttachmentFileRegistrations/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId} |
ブッキング番号を指定して、帳票:MSBを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:MSBを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/AttachmentFileRegistrations/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
取引管理番号を指定して、帳票:MSBを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:MSBを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/AttachmentFileRegistrations/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
社内管理番号を指定して、帳票:MSBを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:MSBを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/NaccsReport/AttachmentFileRegistrations/Get/{dealReportId} |
帳票:MSBを取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/NaccsReport/AttachmentFileRegistrations/GetByDealNo/{dealNo} |
取引管理番号を指定して、帳票:MSBを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:MSBを取得します。 |
|
GET | /API/v1/NaccsReport/AttachmentFileRegistrations/GetListByBlNo/{blNo} |
B/L番号を指定して、帳票:MSBを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、MSBを取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が付番されている全ての取引から、帳票:MSBを取得します。 |
|
GET | /API/v1/NaccsReport/AttachmentFileRegistrations/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo} |
ブッキング番号を指定して、帳票:MSBを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:MSBを取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が付番されている全ての取引から、帳票:MSBを取得します。 |
|
GET | /API/v1/NaccsReport/AttachmentFileRegistrations/GetListByDomesticNo/{domesticNo} |
社内管理番号を指定して、帳票:MSBを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:MSBを取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:MSBを取得します。 |
|
POST | /API/v1/NaccsReport/AttachmentFileRegistrations/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/AttachmentFileRegistrations/Register |
帳票:MSBを保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
BillOfLadingNumberNotices
B/L番号通知書
API | Description | ||
---|---|---|---|
POST | /API/v1/Report/BillOfLadingNumberNotices/Create |
帳票:B/L番号通知書を作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 帳票:B/L番号通知書が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/Report/BillOfLadingNumberNotices/CreateAttachFileMeta |
添付ファイルメタ情報を登録します。 |
|
POST | /API/v1/Report/BillOfLadingNumberNotices/CreateByBlNo |
B/L番号を指定して、帳票:B/L番号通知書を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定されたB/L番号(***blNo***)に該当する取引に対して、帳票:B/L番号通知書を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定されたB/L番号(***blNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:B/L番号通知書が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/Report/BillOfLadingNumberNotices/CreateByBookingNo |
ブッキング番号を指定して、帳票:B/L番号通知書を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:B/L番号通知書を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:B/L番号通知書が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/Report/BillOfLadingNumberNotices/CreateByDomesticNo |
社内管理番号を指定して、帳票:B/L番号通知書を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:B/L番号通知書を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:B/L番号通知書が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/Report/BillOfLadingNumberNotices/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:B/L番号通知書を削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/Report/BillOfLadingNumberNotices/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
B/L番号を指定して、帳票:B/L番号通知書を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、帳票:B/L番号通知書を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/Report/BillOfLadingNumberNotices/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId} |
ブッキング番号を指定して、帳票:B/L番号通知書を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:B/L番号通知書を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/Report/BillOfLadingNumberNotices/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
取引管理番号を指定して、帳票:B/L番号通知書を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:B/L番号通知書を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/Report/BillOfLadingNumberNotices/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
社内管理番号を指定して、帳票:B/L番号通知書を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:B/L番号通知書を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/Report/BillOfLadingNumberNotices/Get/{dealReportId} |
帳票:B/L番号通知書を取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/Report/BillOfLadingNumberNotices/GetAttachFileMetaList/{dealReportId} |
添付ファイル情報一覧を取得します。 |
|
GET | /API/v1/Report/BillOfLadingNumberNotices/GetByDealNo/{dealNo} |
取引管理番号を指定して、帳票:B/L番号通知書を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:B/L番号通知書を取得します。 |
|
GET | /API/v1/Report/BillOfLadingNumberNotices/GetListByBlNo/{blNo} |
B/L番号を指定して、帳票:B/L番号通知書を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、B/L番号通知書を取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が付番されている全ての取引から、帳票:B/L番号通知書を取得します。 |
|
GET | /API/v1/Report/BillOfLadingNumberNotices/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo} |
ブッキング番号を指定して、帳票:B/L番号通知書を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:B/L番号通知書を取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が付番されている全ての取引から、帳票:B/L番号通知書を取得します。 |
|
GET | /API/v1/Report/BillOfLadingNumberNotices/GetListByDomesticNo/{domesticNo} |
社内管理番号を指定して、帳票:B/L番号通知書を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:B/L番号通知書を取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:B/L番号通知書を取得します。 |
|
POST | /API/v1/Report/BillOfLadingNumberNotices/Register |
帳票:B/L番号通知書を保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
BillOfLadings
船荷証券
API | Description | ||
---|---|---|---|
POST | /API/v1/Report/BillOfLadings/Create |
帳票:船荷証券を作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 帳票:船荷証券が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/Report/BillOfLadings/CreateAttachFileMeta |
添付ファイルメタ情報を登録します。 |
|
POST | /API/v1/Report/BillOfLadings/CreateByBlNo |
B/L番号を指定して、帳票:船荷証券を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定されたB/L番号(***blNo***)に該当する取引に対して、帳票:船荷証券を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定されたB/L番号(***blNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:船荷証券が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/Report/BillOfLadings/CreateByBookingNo |
ブッキング番号を指定して、帳票:船荷証券を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:船荷証券を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:船荷証券が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/Report/BillOfLadings/CreateByDomesticNo |
社内管理番号を指定して、帳票:船荷証券を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:船荷証券を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:船荷証券が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/Report/BillOfLadings/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:船荷証券を削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/Report/BillOfLadings/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
B/L番号を指定して、帳票:船荷証券を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、帳票:船荷証券を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/Report/BillOfLadings/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId} |
ブッキング番号を指定して、帳票:船荷証券を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:船荷証券を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/Report/BillOfLadings/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
取引管理番号を指定して、帳票:船荷証券を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:船荷証券を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/Report/BillOfLadings/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
社内管理番号を指定して、帳票:船荷証券を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:船荷証券を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/Report/BillOfLadings/Get/{dealReportId} |
帳票:船荷証券を取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/Report/BillOfLadings/GetAttachFileMetaList/{dealReportId} |
添付ファイル情報一覧を取得します。 |
|
GET | /API/v1/Report/BillOfLadings/GetByDealNo/{dealNo} |
取引管理番号を指定して、帳票:船荷証券を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:船荷証券を取得します。 |
|
GET | /API/v1/Report/BillOfLadings/GetListByBlNo/{blNo} |
B/L番号を指定して、帳票:船荷証券を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、船荷証券を取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が付番されている全ての取引から、帳票:船荷証券を取得します。 |
|
GET | /API/v1/Report/BillOfLadings/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo} |
ブッキング番号を指定して、帳票:船荷証券を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:船荷証券を取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が付番されている全ての取引から、帳票:船荷証券を取得します。 |
|
GET | /API/v1/Report/BillOfLadings/GetListByDomesticNo/{domesticNo} |
社内管理番号を指定して、帳票:船荷証券を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:船荷証券を取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:船荷証券を取得します。 |
|
POST | /API/v1/Report/BillOfLadings/Register |
帳票:船荷証券を保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
BookingChangeCalls
BKC11
API | Description | ||
---|---|---|---|
POST | /API/v1/NaccsReport/BookingChangeCalls/Create |
帳票:BKC11を作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 帳票:BKC11が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/BookingChangeCalls/CreateByBlNo |
B/L番号を指定して、帳票:BKC11を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定されたB/L番号(***blNo***)に該当する取引に対して、帳票:BKC11を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定されたB/L番号(***blNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:BKC11が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/BookingChangeCalls/CreateByBookingNo |
ブッキング番号を指定して、帳票:BKC11を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:BKC11を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:BKC11が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/BookingChangeCalls/CreateByDomesticNo |
社内管理番号を指定して、帳票:BKC11を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:BKC11を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:BKC11が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/NaccsReport/BookingChangeCalls/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:BKC11を削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/NaccsReport/BookingChangeCalls/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
B/L番号を指定して、帳票:BKC11を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、帳票:BKC11を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/BookingChangeCalls/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId} |
ブッキング番号を指定して、帳票:BKC11を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:BKC11を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/BookingChangeCalls/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
取引管理番号を指定して、帳票:BKC11を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:BKC11を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/BookingChangeCalls/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
社内管理番号を指定して、帳票:BKC11を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:BKC11を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/NaccsReport/BookingChangeCalls/Get/{dealReportId} |
帳票:BKC11を取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/NaccsReport/BookingChangeCalls/GetByDealNo/{dealNo} |
取引管理番号を指定して、帳票:BKC11を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:BKC11を取得します。 |
|
GET | /API/v1/NaccsReport/BookingChangeCalls/GetListByBlNo/{blNo} |
B/L番号を指定して、帳票:BKC11を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、BKC11を取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が付番されている全ての取引から、帳票:BKC11を取得します。 |
|
GET | /API/v1/NaccsReport/BookingChangeCalls/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo} |
ブッキング番号を指定して、帳票:BKC11を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:BKC11を取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が付番されている全ての取引から、帳票:BKC11を取得します。 |
|
GET | /API/v1/NaccsReport/BookingChangeCalls/GetListByDomesticNo/{domesticNo} |
社内管理番号を指定して、帳票:BKC11を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:BKC11を取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:BKC11を取得します。 |
|
POST | /API/v1/NaccsReport/BookingChangeCalls/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/BookingChangeCalls/Register |
帳票:BKC11を保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
BookingChanges
BKC
API | Description | ||
---|---|---|---|
POST | /API/v1/NaccsReport/BookingChanges/Create |
帳票:BKCを作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 帳票:BKCが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/BookingChanges/CreateByBlNo |
B/L番号を指定して、帳票:BKCを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定されたB/L番号(***blNo***)に該当する取引に対して、帳票:BKCを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定されたB/L番号(***blNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:BKCが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/BookingChanges/CreateByBookingNo |
ブッキング番号を指定して、帳票:BKCを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:BKCを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:BKCが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/BookingChanges/CreateByDomesticNo |
社内管理番号を指定して、帳票:BKCを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:BKCを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:BKCが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/NaccsReport/BookingChanges/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:BKCを削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/NaccsReport/BookingChanges/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
B/L番号を指定して、帳票:BKCを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、帳票:BKCを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/BookingChanges/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId} |
ブッキング番号を指定して、帳票:BKCを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:BKCを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/BookingChanges/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
取引管理番号を指定して、帳票:BKCを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:BKCを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/BookingChanges/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
社内管理番号を指定して、帳票:BKCを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:BKCを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/NaccsReport/BookingChanges/Get/{dealReportId} |
帳票:BKCを取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/NaccsReport/BookingChanges/GetByDealNo/{dealNo} |
取引管理番号を指定して、帳票:BKCを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:BKCを取得します。 |
|
GET | /API/v1/NaccsReport/BookingChanges/GetListByBlNo/{blNo} |
B/L番号を指定して、帳票:BKCを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、BKCを取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が付番されている全ての取引から、帳票:BKCを取得します。 |
|
GET | /API/v1/NaccsReport/BookingChanges/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo} |
ブッキング番号を指定して、帳票:BKCを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:BKCを取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が付番されている全ての取引から、帳票:BKCを取得します。 |
|
GET | /API/v1/NaccsReport/BookingChanges/GetListByDomesticNo/{domesticNo} |
社内管理番号を指定して、帳票:BKCを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:BKCを取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:BKCを取得します。 |
|
POST | /API/v1/NaccsReport/BookingChanges/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/BookingChanges/Register |
帳票:BKCを保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
BookingConfirmations
船腹予約確認書
API | Description | ||
---|---|---|---|
POST | /API/v1/Report/BookingConfirmations/Create |
帳票:船腹予約確認書を作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 帳票:船腹予約確認書が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/Report/BookingConfirmations/CreateAttachFileMeta |
添付ファイルメタ情報を登録します。 |
|
POST | /API/v1/Report/BookingConfirmations/CreateByBlNo |
B/L番号を指定して、帳票:船腹予約確認書を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定されたB/L番号(***blNo***)に該当する取引に対して、帳票:船腹予約確認書を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定されたB/L番号(***blNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:船腹予約確認書が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/Report/BookingConfirmations/CreateByBookingNo |
ブッキング番号を指定して、帳票:船腹予約確認書を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:船腹予約確認書を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:船腹予約確認書が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/Report/BookingConfirmations/CreateByDomesticNo |
社内管理番号を指定して、帳票:船腹予約確認書を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:船腹予約確認書を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:船腹予約確認書が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/Report/BookingConfirmations/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:船腹予約確認書を削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/Report/BookingConfirmations/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
B/L番号を指定して、帳票:船腹予約確認書を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、帳票:船腹予約確認書を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/Report/BookingConfirmations/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId} |
ブッキング番号を指定して、帳票:船腹予約確認書を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:船腹予約確認書を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/Report/BookingConfirmations/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
取引管理番号を指定して、帳票:船腹予約確認書を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:船腹予約確認書を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/Report/BookingConfirmations/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
社内管理番号を指定して、帳票:船腹予約確認書を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:船腹予約確認書を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/Report/BookingConfirmations/Get/{dealReportId} |
帳票:船腹予約確認書を取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/Report/BookingConfirmations/GetAttachFileMetaList/{dealReportId} |
添付ファイル情報一覧を取得します。 |
|
GET | /API/v1/Report/BookingConfirmations/GetByDealNo/{dealNo} |
取引管理番号を指定して、帳票:船腹予約確認書を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:船腹予約確認書を取得します。 |
|
GET | /API/v1/Report/BookingConfirmations/GetListByBlNo/{blNo} |
B/L番号を指定して、帳票:船腹予約確認書を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、船腹予約確認書を取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が付番されている全ての取引から、帳票:船腹予約確認書を取得します。 |
|
GET | /API/v1/Report/BookingConfirmations/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo} |
ブッキング番号を指定して、帳票:船腹予約確認書を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:船腹予約確認書を取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が付番されている全ての取引から、帳票:船腹予約確認書を取得します。 |
|
GET | /API/v1/Report/BookingConfirmations/GetListByDomesticNo/{domesticNo} |
社内管理番号を指定して、帳票:船腹予約確認書を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:船腹予約確認書を取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:船腹予約確認書を取得します。 |
|
POST | /API/v1/Report/BookingConfirmations/Register |
帳票:船腹予約確認書を保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
BookingListFeederVessels
内航ブッキングリスト
API | Description | ||
---|---|---|---|
POST | /API/v1/Report/BookingListFeederVessels/Create |
帳票:内航ブッキングリストを作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 |
|
POST | /API/v1/Report/BookingListFeederVessels/CreateAttachFileMeta |
添付ファイルメタ情報を登録します。 |
|
POST | /API/v1/Report/BookingListFeederVessels/CreateByDomesticNo |
社内管理番号を指定して、帳票:内航ブッキングリストを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:内航ブッキングリストを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 カスタムID(***customId***)は作成数に制限がない帳票を特定できるように任意に設定できる項目です。 カスタムID(***customId***)に値が設定されていなくても帳票:内航ブッキングリストは作成可能です。同じカスタムID(***customId***)の帳票:内航ブッキングリストが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/Report/BookingListFeederVessels/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:内航ブッキングリストを削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/Report/BookingListFeederVessels/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId}&customId={customId} |
取引管理番号を指定して、帳票:内航ブッキングリストを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:内航ブッキングリストを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/Report/BookingListFeederVessels/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId}&customId={customId} |
社内管理番号を指定して、帳票:内航ブッキングリストを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:内航ブッキングリストを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/Report/BookingListFeederVessels/Get/{dealReportId} |
帳票:内航ブッキングリストを取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/Report/BookingListFeederVessels/GetAttachFileMetaList/{dealReportId} |
添付ファイル情報一覧を取得します。 |
|
GET | /API/v1/Report/BookingListFeederVessels/GetListByDealNo/{dealNo} |
取引管理番号を指定して、帳票:内航ブッキングリストを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:内航ブッキングリストを取得します。 |
|
GET | /API/v1/Report/BookingListFeederVessels/GetListByDomesticNo/{domesticNo}?customId={customId} |
社内管理番号を指定して、帳票:内航ブッキングリストを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:内航ブッキングリストを取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:内航ブッキングリストを取得します。 |
|
POST | /API/v1/Report/BookingListFeederVessels/Register |
帳票:内航ブッキングリストを保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
BookingListOceanVessels
外航ブッキングリスト
API | Description | ||
---|---|---|---|
POST | /API/v1/Report/BookingListOceanVessels/Create |
帳票:外航ブッキングリストを作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 |
|
POST | /API/v1/Report/BookingListOceanVessels/CreateAttachFileMeta |
添付ファイルメタ情報を登録します。 |
|
POST | /API/v1/Report/BookingListOceanVessels/CreateByDomesticNo |
社内管理番号を指定して、帳票:外航ブッキングリストを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:外航ブッキングリストを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 カスタムID(***customId***)は作成数に制限がない帳票を特定できるように任意に設定できる項目です。 カスタムID(***customId***)に値が設定されていなくても帳票:外航ブッキングリストは作成可能です。同じカスタムID(***customId***)の帳票:外航ブッキングリストが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/Report/BookingListOceanVessels/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:外航ブッキングリストを削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/Report/BookingListOceanVessels/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId}&customId={customId} |
取引管理番号を指定して、帳票:外航ブッキングリストを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:外航ブッキングリストを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/Report/BookingListOceanVessels/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId}&customId={customId} |
社内管理番号を指定して、帳票:外航ブッキングリストを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:外航ブッキングリストを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/Report/BookingListOceanVessels/Get/{dealReportId} |
帳票:外航ブッキングリストを取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/Report/BookingListOceanVessels/GetAttachFileMetaList/{dealReportId} |
添付ファイル情報一覧を取得します。 |
|
GET | /API/v1/Report/BookingListOceanVessels/GetListByDealNo/{dealNo} |
取引管理番号を指定して、帳票:外航ブッキングリストを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:外航ブッキングリストを取得します。 |
|
GET | /API/v1/Report/BookingListOceanVessels/GetListByDomesticNo/{domesticNo}?customId={customId} |
社内管理番号を指定して、帳票:外航ブッキングリストを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:外航ブッキングリストを取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:外航ブッキングリストを取得します。 |
|
POST | /API/v1/Report/BookingListOceanVessels/Register |
帳票:外航ブッキングリストを保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
BookingRegistrations
BKR
API | Description | ||
---|---|---|---|
POST | /API/v1/NaccsReport/BookingRegistrations/Create |
帳票:BKRを作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 帳票:BKRが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/BookingRegistrations/CreateByBlNo |
B/L番号を指定して、帳票:BKRを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定されたB/L番号(***blNo***)に該当する取引に対して、帳票:BKRを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定されたB/L番号(***blNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:BKRが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/BookingRegistrations/CreateByBookingNo |
ブッキング番号を指定して、帳票:BKRを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:BKRを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:BKRが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/BookingRegistrations/CreateByDomesticNo |
社内管理番号を指定して、帳票:BKRを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:BKRを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:BKRが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/NaccsReport/BookingRegistrations/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:BKRを削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/NaccsReport/BookingRegistrations/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
B/L番号を指定して、帳票:BKRを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、帳票:BKRを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/BookingRegistrations/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId} |
ブッキング番号を指定して、帳票:BKRを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:BKRを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/BookingRegistrations/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
取引管理番号を指定して、帳票:BKRを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:BKRを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/BookingRegistrations/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
社内管理番号を指定して、帳票:BKRを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:BKRを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/NaccsReport/BookingRegistrations/Get/{dealReportId} |
帳票:BKRを取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/NaccsReport/BookingRegistrations/GetByDealNo/{dealNo} |
取引管理番号を指定して、帳票:BKRを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:BKRを取得します。 |
|
GET | /API/v1/NaccsReport/BookingRegistrations/GetListByBlNo/{blNo} |
B/L番号を指定して、帳票:BKRを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、BKRを取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が付番されている全ての取引から、帳票:BKRを取得します。 |
|
GET | /API/v1/NaccsReport/BookingRegistrations/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo} |
ブッキング番号を指定して、帳票:BKRを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:BKRを取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が付番されている全ての取引から、帳票:BKRを取得します。 |
|
GET | /API/v1/NaccsReport/BookingRegistrations/GetListByDomesticNo/{domesticNo} |
社内管理番号を指定して、帳票:BKRを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:BKRを取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:BKRを取得します。 |
|
POST | /API/v1/NaccsReport/BookingRegistrations/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/BookingRegistrations/Register |
帳票:BKRを保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
BookingRequestDangerousGoods
危険品ブッキング依頼書
API | Description | ||
---|---|---|---|
POST | /API/v1/Report/BookingRequestDangerousGoods/Create |
帳票:危険品ブッキング依頼書を作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 帳票:危険品ブッキング依頼書が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/Report/BookingRequestDangerousGoods/CreateAttachFileMeta |
添付ファイルメタ情報を登録します。 |
|
POST | /API/v1/Report/BookingRequestDangerousGoods/CreateByBlNo |
B/L番号を指定して、帳票:危険品ブッキング依頼書を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定されたB/L番号(***blNo***)に該当する取引に対して、帳票:危険品ブッキング依頼書を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定されたB/L番号(***blNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:危険品ブッキング依頼書が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/Report/BookingRequestDangerousGoods/CreateByBookingNo |
ブッキング番号を指定して、帳票:危険品ブッキング依頼書を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:危険品ブッキング依頼書を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:危険品ブッキング依頼書が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/Report/BookingRequestDangerousGoods/CreateByDomesticNo |
社内管理番号を指定して、帳票:危険品ブッキング依頼書を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:危険品ブッキング依頼書を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:危険品ブッキング依頼書が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/Report/BookingRequestDangerousGoods/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:危険品ブッキング依頼書を削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/Report/BookingRequestDangerousGoods/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
B/L番号を指定して、帳票:危険品ブッキング依頼書を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、帳票:危険品ブッキング依頼書を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/Report/BookingRequestDangerousGoods/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId} |
ブッキング番号を指定して、帳票:危険品ブッキング依頼書を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:危険品ブッキング依頼書を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/Report/BookingRequestDangerousGoods/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
取引管理番号を指定して、帳票:危険品ブッキング依頼書を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:危険品ブッキング依頼書を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/Report/BookingRequestDangerousGoods/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
社内管理番号を指定して、帳票:危険品ブッキング依頼書を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:危険品ブッキング依頼書を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/Report/BookingRequestDangerousGoods/Get/{dealReportId} |
帳票:危険品ブッキング依頼書を取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/Report/BookingRequestDangerousGoods/GetAttachFileMetaList/{dealReportId} |
添付ファイル情報一覧を取得します。 |
|
GET | /API/v1/Report/BookingRequestDangerousGoods/GetByDealNo/{dealNo} |
取引管理番号を指定して、帳票:危険品ブッキング依頼書を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:危険品ブッキング依頼書を取得します。 |
|
GET | /API/v1/Report/BookingRequestDangerousGoods/GetListByBlNo/{blNo} |
B/L番号を指定して、帳票:危険品ブッキング依頼書を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、危険品ブッキング依頼書を取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が付番されている全ての取引から、帳票:危険品ブッキング依頼書を取得します。 |
|
GET | /API/v1/Report/BookingRequestDangerousGoods/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo} |
ブッキング番号を指定して、帳票:危険品ブッキング依頼書を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:危険品ブッキング依頼書を取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が付番されている全ての取引から、帳票:危険品ブッキング依頼書を取得します。 |
|
GET | /API/v1/Report/BookingRequestDangerousGoods/GetListByDomesticNo/{domesticNo} |
社内管理番号を指定して、帳票:危険品ブッキング依頼書を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:危険品ブッキング依頼書を取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:危険品ブッキング依頼書を取得します。 |
|
POST | /API/v1/Report/BookingRequestDangerousGoods/Register |
帳票:危険品ブッキング依頼書を保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
BookingRequests
ブッキング依頼書
API | Description | ||
---|---|---|---|
POST | /API/v1/Report/BookingRequests/Create |
帳票:ブッキング依頼書を作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 帳票:ブッキング依頼書が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/Report/BookingRequests/CreateAttachFileMeta |
添付ファイルメタ情報を登録します。 |
|
POST | /API/v1/Report/BookingRequests/CreateByBlNo |
B/L番号を指定して、帳票:ブッキング依頼書を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定されたB/L番号(***blNo***)に該当する取引に対して、帳票:ブッキング依頼書を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定されたB/L番号(***blNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:ブッキング依頼書が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/Report/BookingRequests/CreateByBookingNo |
ブッキング番号を指定して、帳票:ブッキング依頼書を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:ブッキング依頼書を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:ブッキング依頼書が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/Report/BookingRequests/CreateByDomesticNo |
社内管理番号を指定して、帳票:ブッキング依頼書を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:ブッキング依頼書を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:ブッキング依頼書が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/Report/BookingRequests/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:ブッキング依頼書を削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/Report/BookingRequests/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
B/L番号を指定して、帳票:ブッキング依頼書を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、帳票:ブッキング依頼書を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/Report/BookingRequests/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId} |
ブッキング番号を指定して、帳票:ブッキング依頼書を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:ブッキング依頼書を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/Report/BookingRequests/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
取引管理番号を指定して、帳票:ブッキング依頼書を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:ブッキング依頼書を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/Report/BookingRequests/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
社内管理番号を指定して、帳票:ブッキング依頼書を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:ブッキング依頼書を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/Report/BookingRequests/Get/{dealReportId} |
帳票:ブッキング依頼書を取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/Report/BookingRequests/GetAttachFileMetaList/{dealReportId} |
添付ファイル情報一覧を取得します。 |
|
GET | /API/v1/Report/BookingRequests/GetByDealNo/{dealNo} |
取引管理番号を指定して、帳票:ブッキング依頼書を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:ブッキング依頼書を取得します。 |
|
GET | /API/v1/Report/BookingRequests/GetListByBlNo/{blNo} |
B/L番号を指定して、帳票:ブッキング依頼書を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、ブッキング依頼書を取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が付番されている全ての取引から、帳票:ブッキング依頼書を取得します。 |
|
GET | /API/v1/Report/BookingRequests/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo} |
ブッキング番号を指定して、帳票:ブッキング依頼書を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:ブッキング依頼書を取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が付番されている全ての取引から、帳票:ブッキング依頼書を取得します。 |
|
GET | /API/v1/Report/BookingRequests/GetListByDomesticNo/{domesticNo} |
社内管理番号を指定して、帳票:ブッキング依頼書を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:ブッキング依頼書を取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:ブッキング依頼書を取得します。 |
|
POST | /API/v1/Report/BookingRequests/Register |
帳票:ブッキング依頼書を保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 ## 申請種別について 申請種別(***applicationType***)は、区分値として、***NEW***(新規)、***AMEND***(訂正)、***CANCEL***(キャンセル)のいずれかの区分値を設定できます。 また、設定できる値には以下の制約があります。 ・当該帳票が未送信のときは、申請種別に***NEW***のみ設定可能。(***AMEND***か***CANCEL***が設定されていたらエラー(***400:BadRequest***)が発生します) ・当該帳票が既に送信済みのときは、申請種別に***AMEND***か***CANCEL***が設定可能。(***NEW***が設定された場合は***AMEND***に自動で置換します) 値が未設定であれば、当該帳票の送信回数によってデフォルト値をセットします。(初回送信時:***NEW*** 2回目以降:***AMEND***) |
BusinessCategories
業務カテゴリマスタ
API | Description | ||
---|---|---|---|
GET | /API/v1/Master/BusinessCategories/Get/{businessCategoryId} |
業務カテゴリ情報を取得します。 ## 概要 業務カテゴリマスタから、業務カテゴリID(***businessCategoryId***)を指定して、業務カテゴリ情報を取得します。 ## 指定するパラメタについて ### 業務カテゴリID 取得する業務カテゴリ情報の業務カテゴリID(***businessCategoryId***)を指定します。 |
BusinessCategoryCodes
種類コードマスタ
API | Description | ||
---|---|---|---|
GET | /API/v1/Master/BusinessCategoryCodes/Get/{categoryCode} |
種類コード情報を取得します。 ## 概要 種類コードマスタから、種類コード(***categoryCode***)を指定して、種類コード情報を取得します。 種類コードとは業務コードを分類化するコードです。 例えば、コンテナ形式や数量単位を表すコード(業務コード)は、種類コードがコンテナ形式や数量単位として分類化されます。 種類コードは以下の通りです。 | 種類コード(***categoryCode***) | 種類名(***categoryName***) | | -------------------------------- | ------------------------------------------ | | 001 | コンテナサイズコード(ISO6346)長さ | | 002 | コンテナサイズコード(ISO6346)高さ | | 003 | コンテナ形式コード | | 004 | 数量単位コード(総重量) | | 005 | 数量単位コード(総容積) | | 006 | 数量単位コード(温度) | | 007 | 申請種別 | | 008 | コンテナ状態(FULL/EMPTY) | | 009 | 機器受渡種別 (IN/OUT) | | 010 | リーファーコンテナの換気用窓 | | 011 | Yes,No | | 012 | 経由有無 via (with/without) | | 013 | 通関状況 | | 014 | 海上運賃の支払条件 | | 015 | サービスタイプ | | 016 | モード、コンテナモード | | 017 | NACCS業務コード名 | | 018 | NACCS出力制御 | | 019 | NACCS取込制御 | | 020 | 重量確定方法 | | 021 | 船会社(SCAC)コード | | 022 | 数量単位コード(コンテナ自重) | | 023 | コンテナターミナルコード | | 024 | 内貿 | | 025 | 電源要否 | ## 指定するパラメタについて ### 種類コード 取得する種類コード情報の種類コード(***categoryCode***)を指定します。 |
BusinessCodes
業務コードマスタ
API | Description | ||
---|---|---|---|
GET | /API/v1/Master/BusinessCodes/Get/{businessCodeId} |
業務コード情報を取得します。 ## 概要 業務コードマスタから、業務コードID(***businessCodeId***)を指定して、業務コード情報を取得します。 ## 指定するパラメタについて ### 業務コードID 取得する業務コード情報の業務コードID(***businessCodeId***)を指定します。 |
BusinessPartners
取引関係先マスタ
API | Description | ||
---|---|---|---|
GET | /API/v1/Master/BusinessPartners/GetList?filter={filter}&orderby={orderby} |
検索条件を指定して、条件に該当する取引関係先を全て取得します。 ## 概要 検索条件を指定して、条件に該当する取引関係先を全て取得します。 検索条件の指定方法については、[こちらを参照ください](https://docs.microsoft.com/ja-jp/graph/query-parameters#filter-parameter)。 |
BusinessTemplates
業務テンプレート
API | Description | ||
---|---|---|---|
POST | /API/v1/Master/BusinessTemplates/Create |
業務テンプレートを作成します。 ## 概要 業務テンプレートとは、その帳票に対して、やるべきことを可視化する機能です。 |
|
DELETE | /API/v1/Master/BusinessTemplates/Delete/{businessTemplateId} |
業務テンプレートを削除します。 ## 概要 業務テンプレートID(***businessTemplateId***)を指定して、業務テンプレートを削除します。 |
|
GET | /API/v1/Master/BusinessTemplates/Get/{businessTemplateId} |
業務テンプレートIDを指定して、業務テンプレート(BusinessTemplate)を取得します。 |
|
POST | /API/v1/Master/BusinessTemplates/Register |
業務テンプレートを登録します。 |
|
POST | /API/v1/Master/BusinessTemplates/UpdateDisplayOrder |
業務テンプレートの表示順を更新します。 |
BusinessTypes
事業種別マスタ
API | Description | ||
---|---|---|---|
GET | /API/v1/Master/BusinessTypes/Get/{businessTypeId} |
事業種別を取得します。 ## 概要 事業種別マスタから、事業種別ID(***businessTypeId***)を指定して、事業種別の情報を取得します。 このマスタは、会社や組織に割り当てる事業種別を管理します。 事業種別は以下のように定義されています。 | 事業種別 | 事業種別(英名) | 事業種別ID(***businessTypeId***) | | -------------------- | -------------------------------------- | ---------------------------------- | | 外航船社 | Ocean Shipping Company | oceanShipping | | 内航船社 | Coastal Feeder Transport Company | coastalFeeder | | 船舶代理店 | Shipping Agent | shippingAgent | | 陸運業者 | Road Transport Operator | roadTransport | | ターミナルオペレータ | Terminal Operator | terminalOperator | | 倉庫業者 | Warehouse Operator | warehouseOperator | | 通関業者 | Customs Broker | customsBroker | | 海貨業者 | Forwarder | forwarder | | NVOCC/フォワーダ | NVOCC/International Freight Forwarder | nvocc | | 荷主 | Shipper/Consignee | shipperOrConsignee | | 届出荷送人 | Vgm Notification Member | vgmNotification | | 登録確定事業者 | Vgm Registration Member | vgmRegistration | ## 指定するパラメタについて ### 事業種別ID 取得する事業種別の事業種別ID(***businessTypeId***)を指定します。 |
CargoClearanceAndDeliveryInstructions
輸入貨物荷捌依頼書
API | Description | ||
---|---|---|---|
POST | /API/v1/Report/CargoClearanceAndDeliveryInstructions/Create |
帳票:輸入貨物荷捌依頼書を作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 帳票:輸入貨物荷捌依頼書が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/Report/CargoClearanceAndDeliveryInstructions/CreateAttachFileMeta |
添付ファイルメタ情報を登録します。 |
|
POST | /API/v1/Report/CargoClearanceAndDeliveryInstructions/CreateByBlNo |
B/L番号を指定して、帳票:輸入貨物荷捌依頼書を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定されたB/L番号(***blNo***)に該当する取引に対して、帳票:輸入貨物荷捌依頼書を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定されたB/L番号(***blNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:輸入貨物荷捌依頼書が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/Report/CargoClearanceAndDeliveryInstructions/CreateByBookingNo |
ブッキング番号を指定して、帳票:輸入貨物荷捌依頼書を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:輸入貨物荷捌依頼書を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:輸入貨物荷捌依頼書が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/Report/CargoClearanceAndDeliveryInstructions/CreateByDomesticNo |
社内管理番号を指定して、帳票:輸入貨物荷捌依頼書を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:輸入貨物荷捌依頼書を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:輸入貨物荷捌依頼書が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/Report/CargoClearanceAndDeliveryInstructions/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:輸入貨物荷捌依頼書を削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/Report/CargoClearanceAndDeliveryInstructions/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
B/L番号を指定して、帳票:輸入貨物荷捌依頼書を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、帳票:輸入貨物荷捌依頼書を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/Report/CargoClearanceAndDeliveryInstructions/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId} |
ブッキング番号を指定して、帳票:輸入貨物荷捌依頼書を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:輸入貨物荷捌依頼書を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/Report/CargoClearanceAndDeliveryInstructions/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
取引管理番号を指定して、帳票:輸入貨物荷捌依頼書を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:輸入貨物荷捌依頼書を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/Report/CargoClearanceAndDeliveryInstructions/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
社内管理番号を指定して、帳票:輸入貨物荷捌依頼書を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:輸入貨物荷捌依頼書を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/Report/CargoClearanceAndDeliveryInstructions/Get/{dealReportId} |
帳票:輸入貨物荷捌依頼書を取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/Report/CargoClearanceAndDeliveryInstructions/GetAttachFileMetaList/{dealReportId} |
添付ファイル情報一覧を取得します。 |
|
GET | /API/v1/Report/CargoClearanceAndDeliveryInstructions/GetByDealNo/{dealNo} |
取引管理番号を指定して、帳票:輸入貨物荷捌依頼書を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:輸入貨物荷捌依頼書を取得します。 |
|
GET | /API/v1/Report/CargoClearanceAndDeliveryInstructions/GetListByBlNo/{blNo} |
B/L番号を指定して、帳票:輸入貨物荷捌依頼書を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、輸入貨物荷捌依頼書を取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が付番されている全ての取引から、帳票:輸入貨物荷捌依頼書を取得します。 |
|
GET | /API/v1/Report/CargoClearanceAndDeliveryInstructions/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo} |
ブッキング番号を指定して、帳票:輸入貨物荷捌依頼書を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:輸入貨物荷捌依頼書を取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が付番されている全ての取引から、帳票:輸入貨物荷捌依頼書を取得します。 |
|
GET | /API/v1/Report/CargoClearanceAndDeliveryInstructions/GetListByDomesticNo/{domesticNo} |
社内管理番号を指定して、帳票:輸入貨物荷捌依頼書を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:輸入貨物荷捌依頼書を取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:輸入貨物荷捌依頼書を取得します。 |
|
POST | /API/v1/Report/CargoClearanceAndDeliveryInstructions/Register |
帳票:輸入貨物荷捌依頼書を保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
CargoInformationInquiries
ICG
API | Description | ||
---|---|---|---|
POST | /API/v1/NaccsReport/CargoInformationInquiries/Create |
帳票:ICGを作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 帳票:ICGが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/CargoInformationInquiries/CreateByBlNo |
B/L番号を指定して、帳票:ICGを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定されたB/L番号(***blNo***)に該当する取引に対して、帳票:ICGを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定されたB/L番号(***blNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:ICGが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/CargoInformationInquiries/CreateByBookingNo |
ブッキング番号を指定して、帳票:ICGを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:ICGを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:ICGが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/CargoInformationInquiries/CreateByDomesticNo |
社内管理番号を指定して、帳票:ICGを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:ICGを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:ICGが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/NaccsReport/CargoInformationInquiries/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:ICGを削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/NaccsReport/CargoInformationInquiries/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
B/L番号を指定して、帳票:ICGを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、帳票:ICGを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/CargoInformationInquiries/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId} |
ブッキング番号を指定して、帳票:ICGを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:ICGを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/CargoInformationInquiries/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
取引管理番号を指定して、帳票:ICGを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:ICGを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/CargoInformationInquiries/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
社内管理番号を指定して、帳票:ICGを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:ICGを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/NaccsReport/CargoInformationInquiries/Get/{dealReportId} |
帳票:ICGを取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/NaccsReport/CargoInformationInquiries/GetByDealNo/{dealNo} |
取引管理番号を指定して、帳票:ICGを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:ICGを取得します。 |
|
GET | /API/v1/NaccsReport/CargoInformationInquiries/GetListByBlNo/{blNo} |
B/L番号を指定して、帳票:ICGを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、ICGを取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が付番されている全ての取引から、帳票:ICGを取得します。 |
|
GET | /API/v1/NaccsReport/CargoInformationInquiries/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo} |
ブッキング番号を指定して、帳票:ICGを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:ICGを取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が付番されている全ての取引から、帳票:ICGを取得します。 |
|
GET | /API/v1/NaccsReport/CargoInformationInquiries/GetListByDomesticNo/{domesticNo} |
社内管理番号を指定して、帳票:ICGを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:ICGを取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:ICGを取得します。 |
|
POST | /API/v1/NaccsReport/CargoInformationInquiries/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/CargoInformationInquiries/Register |
帳票:ICGを保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
CargoInventoryStatusInquiries
IWS
API | Description | ||
---|---|---|---|
POST | /API/v1/NaccsReport/CargoInventoryStatusInquiries/Create |
帳票:IWSを作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 帳票:IWSが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/CargoInventoryStatusInquiries/CreateByBlNo |
B/L番号を指定して、帳票:IWSを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定されたB/L番号(***blNo***)に該当する取引に対して、帳票:IWSを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定されたB/L番号(***blNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:IWSが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/CargoInventoryStatusInquiries/CreateByBookingNo |
ブッキング番号を指定して、帳票:IWSを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:IWSを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:IWSが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/CargoInventoryStatusInquiries/CreateByDomesticNo |
社内管理番号を指定して、帳票:IWSを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:IWSを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:IWSが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/NaccsReport/CargoInventoryStatusInquiries/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:IWSを削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/NaccsReport/CargoInventoryStatusInquiries/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
B/L番号を指定して、帳票:IWSを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、帳票:IWSを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/CargoInventoryStatusInquiries/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId} |
ブッキング番号を指定して、帳票:IWSを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:IWSを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/CargoInventoryStatusInquiries/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
取引管理番号を指定して、帳票:IWSを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:IWSを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/CargoInventoryStatusInquiries/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
社内管理番号を指定して、帳票:IWSを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:IWSを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/NaccsReport/CargoInventoryStatusInquiries/Get/{dealReportId} |
帳票:IWSを取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/NaccsReport/CargoInventoryStatusInquiries/GetByDealNo/{dealNo} |
取引管理番号を指定して、帳票:IWSを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:IWSを取得します。 |
|
GET | /API/v1/NaccsReport/CargoInventoryStatusInquiries/GetListByBlNo/{blNo} |
B/L番号を指定して、帳票:IWSを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、IWSを取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が付番されている全ての取引から、帳票:IWSを取得します。 |
|
GET | /API/v1/NaccsReport/CargoInventoryStatusInquiries/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo} |
ブッキング番号を指定して、帳票:IWSを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:IWSを取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が付番されている全ての取引から、帳票:IWSを取得します。 |
|
GET | /API/v1/NaccsReport/CargoInventoryStatusInquiries/GetListByDomesticNo/{domesticNo} |
社内管理番号を指定して、帳票:IWSを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:IWSを取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:IWSを取得します。 |
|
POST | /API/v1/NaccsReport/CargoInventoryStatusInquiries/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/CargoInventoryStatusInquiries/Register |
帳票:IWSを保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
CargoManifests
積荷目録
API | Description | ||
---|---|---|---|
POST | /API/v1/Report/CargoManifests/Create |
帳票:積荷目録を作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 |
|
POST | /API/v1/Report/CargoManifests/CreateAttachFileMeta |
添付ファイルメタ情報を登録します。 |
|
POST | /API/v1/Report/CargoManifests/CreateByDomesticNo |
社内管理番号を指定して、帳票:積荷目録を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:積荷目録を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 カスタムID(***customId***)は作成数に制限がない帳票を特定できるように任意に設定できる項目です。 カスタムID(***customId***)に値が設定されていなくても帳票:積荷目録は作成可能です。同じカスタムID(***customId***)の帳票:積荷目録が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/Report/CargoManifests/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:積荷目録を削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/Report/CargoManifests/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId}&customId={customId} |
取引管理番号を指定して、帳票:積荷目録を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:積荷目録を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/Report/CargoManifests/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId}&customId={customId} |
社内管理番号を指定して、帳票:積荷目録を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:積荷目録を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/Report/CargoManifests/Get/{dealReportId} |
帳票:積荷目録を取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/Report/CargoManifests/GetAttachFileMetaList/{dealReportId} |
添付ファイル情報一覧を取得します。 |
|
GET | /API/v1/Report/CargoManifests/GetListByDealNo/{dealNo} |
取引管理番号を指定して、帳票:積荷目録を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:積荷目録を取得します。 |
|
GET | /API/v1/Report/CargoManifests/GetListByDomesticNo/{domesticNo}?customId={customId} |
社内管理番号を指定して、帳票:積荷目録を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:積荷目録を取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:積荷目録を取得します。 |
|
POST | /API/v1/Report/CargoManifests/Register |
帳票:積荷目録を保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
CargoManifestsStatusInquiries
IMI
API | Description | ||
---|---|---|---|
POST | /API/v1/NaccsReport/CargoManifestsStatusInquiries/Create |
帳票:IMIを作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 帳票:IMIが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/CargoManifestsStatusInquiries/CreateByBlNo |
B/L番号を指定して、帳票:IMIを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定されたB/L番号(***blNo***)に該当する取引に対して、帳票:IMIを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定されたB/L番号(***blNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:IMIが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/CargoManifestsStatusInquiries/CreateByBookingNo |
ブッキング番号を指定して、帳票:IMIを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:IMIを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:IMIが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/CargoManifestsStatusInquiries/CreateByDomesticNo |
社内管理番号を指定して、帳票:IMIを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:IMIを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:IMIが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/NaccsReport/CargoManifestsStatusInquiries/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:IMIを削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/NaccsReport/CargoManifestsStatusInquiries/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
B/L番号を指定して、帳票:IMIを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、帳票:IMIを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/CargoManifestsStatusInquiries/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId} |
ブッキング番号を指定して、帳票:IMIを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:IMIを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/CargoManifestsStatusInquiries/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
取引管理番号を指定して、帳票:IMIを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:IMIを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/CargoManifestsStatusInquiries/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
社内管理番号を指定して、帳票:IMIを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:IMIを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/NaccsReport/CargoManifestsStatusInquiries/Get/{dealReportId} |
帳票:IMIを取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/NaccsReport/CargoManifestsStatusInquiries/GetByDealNo/{dealNo} |
取引管理番号を指定して、帳票:IMIを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:IMIを取得します。 |
|
GET | /API/v1/NaccsReport/CargoManifestsStatusInquiries/GetListByBlNo/{blNo} |
B/L番号を指定して、帳票:IMIを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、IMIを取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が付番されている全ての取引から、帳票:IMIを取得します。 |
|
GET | /API/v1/NaccsReport/CargoManifestsStatusInquiries/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo} |
ブッキング番号を指定して、帳票:IMIを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:IMIを取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が付番されている全ての取引から、帳票:IMIを取得します。 |
|
GET | /API/v1/NaccsReport/CargoManifestsStatusInquiries/GetListByDomesticNo/{domesticNo} |
社内管理番号を指定して、帳票:IMIを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:IMIを取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:IMIを取得します。 |
|
POST | /API/v1/NaccsReport/CargoManifestsStatusInquiries/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/CargoManifestsStatusInquiries/Register |
帳票:IMIを保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
CarryInConfirmRegistrationCustomsTransportCargoes
BIA
API | Description | ||
---|---|---|---|
POST | /API/v1/NaccsReport/CarryInConfirmRegistrationCustomsTransportCargoes/Create |
帳票:BIAを作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 帳票:BIAが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/CarryInConfirmRegistrationCustomsTransportCargoes/CreateByBlNo |
B/L番号を指定して、帳票:BIAを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定されたB/L番号(***blNo***)に該当する取引に対して、帳票:BIAを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定されたB/L番号(***blNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:BIAが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/CarryInConfirmRegistrationCustomsTransportCargoes/CreateByBookingNo |
ブッキング番号を指定して、帳票:BIAを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:BIAを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:BIAが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/CarryInConfirmRegistrationCustomsTransportCargoes/CreateByDomesticNo |
社内管理番号を指定して、帳票:BIAを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:BIAを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:BIAが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/NaccsReport/CarryInConfirmRegistrationCustomsTransportCargoes/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:BIAを削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/NaccsReport/CarryInConfirmRegistrationCustomsTransportCargoes/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
B/L番号を指定して、帳票:BIAを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、帳票:BIAを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/CarryInConfirmRegistrationCustomsTransportCargoes/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId} |
ブッキング番号を指定して、帳票:BIAを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:BIAを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/CarryInConfirmRegistrationCustomsTransportCargoes/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
取引管理番号を指定して、帳票:BIAを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:BIAを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/CarryInConfirmRegistrationCustomsTransportCargoes/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
社内管理番号を指定して、帳票:BIAを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:BIAを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/NaccsReport/CarryInConfirmRegistrationCustomsTransportCargoes/Get/{dealReportId} |
帳票:BIAを取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/NaccsReport/CarryInConfirmRegistrationCustomsTransportCargoes/GetByDealNo/{dealNo} |
取引管理番号を指定して、帳票:BIAを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:BIAを取得します。 |
|
GET | /API/v1/NaccsReport/CarryInConfirmRegistrationCustomsTransportCargoes/GetListByBlNo/{blNo} |
B/L番号を指定して、帳票:BIAを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、BIAを取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が付番されている全ての取引から、帳票:BIAを取得します。 |
|
GET | /API/v1/NaccsReport/CarryInConfirmRegistrationCustomsTransportCargoes/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo} |
ブッキング番号を指定して、帳票:BIAを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:BIAを取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が付番されている全ての取引から、帳票:BIAを取得します。 |
|
GET | /API/v1/NaccsReport/CarryInConfirmRegistrationCustomsTransportCargoes/GetListByDomesticNo/{domesticNo} |
社内管理番号を指定して、帳票:BIAを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:BIAを取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:BIAを取得します。 |
|
POST | /API/v1/NaccsReport/CarryInConfirmRegistrationCustomsTransportCargoes/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/CarryInConfirmRegistrationCustomsTransportCargoes/Register |
帳票:BIAを保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
CarryInConfirmRegistrationExportPermitteds
BID
API | Description | ||
---|---|---|---|
POST | /API/v1/NaccsReport/CarryInConfirmRegistrationExportPermitteds/Create |
帳票:BIDを作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 |
|
POST | /API/v1/NaccsReport/CarryInConfirmRegistrationExportPermitteds/CreateByBlNo |
B/L番号を指定して、帳票:BIDを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定されたB/L番号(***blNo***)に該当する取引に対して、帳票:BIDを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定されたB/L番号(***blNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 カスタムID(***customId***)は作成数に制限がない帳票を特定できるように任意に設定できる項目です。 カスタムID(***customId***)に値が設定されていなくても帳票:BIDは作成可能です。同じカスタムID(***customId***)の帳票:BIDが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/CarryInConfirmRegistrationExportPermitteds/CreateByBookingNo |
ブッキング番号を指定して、帳票:BIDを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:BIDを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 カスタムID(***customId***)は作成数に制限がない帳票を特定できるように任意に設定できる項目です。 カスタムID(***customId***)に値が設定されていなくても帳票:BIDは作成可能です。同じカスタムID(***customId***)の帳票:BIDが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/CarryInConfirmRegistrationExportPermitteds/CreateByDomesticNo |
社内管理番号を指定して、帳票:BIDを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:BIDを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 カスタムID(***customId***)は作成数に制限がない帳票を特定できるように任意に設定できる項目です。 カスタムID(***customId***)に値が設定されていなくても帳票:BIDは作成可能です。同じカスタムID(***customId***)の帳票:BIDが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/NaccsReport/CarryInConfirmRegistrationExportPermitteds/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:BIDを削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/NaccsReport/CarryInConfirmRegistrationExportPermitteds/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId}&customId={customId} |
B/L番号を指定して、帳票:BIDを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、帳票:BIDを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/CarryInConfirmRegistrationExportPermitteds/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId}&customId={customId} |
ブッキング番号を指定して、帳票:BIDを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:BIDを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/CarryInConfirmRegistrationExportPermitteds/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId}&customId={customId} |
取引管理番号を指定して、帳票:BIDを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:BIDを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/CarryInConfirmRegistrationExportPermitteds/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId}&customId={customId} |
社内管理番号を指定して、帳票:BIDを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:BIDを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/NaccsReport/CarryInConfirmRegistrationExportPermitteds/Get/{dealReportId} |
帳票:BIDを取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/NaccsReport/CarryInConfirmRegistrationExportPermitteds/GetListByBlNo/{blNo}?customId={customId} |
B/L番号を指定して、帳票:BIDを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、BIDを取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が付番されている全ての取引から、帳票:BIDを取得します。 |
|
GET | /API/v1/NaccsReport/CarryInConfirmRegistrationExportPermitteds/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&customId={customId} |
ブッキング番号を指定して、帳票:BIDを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:BIDを取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が付番されている全ての取引から、帳票:BIDを取得します。 |
|
GET | /API/v1/NaccsReport/CarryInConfirmRegistrationExportPermitteds/GetListByDealNo/{dealNo} |
取引管理番号を指定して、帳票:BIDを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:BIDを取得します。 |
|
GET | /API/v1/NaccsReport/CarryInConfirmRegistrationExportPermitteds/GetListByDomesticNo/{domesticNo}?customId={customId} |
社内管理番号を指定して、帳票:BIDを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:BIDを取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:BIDを取得します。 |
|
POST | /API/v1/NaccsReport/CarryInConfirmRegistrationExportPermitteds/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/CarryInConfirmRegistrationExportPermitteds/Register |
帳票:BIDを保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
CarryInRegistrationExportUnclearedCustoms
BIC
API | Description | ||
---|---|---|---|
POST | /API/v1/NaccsReport/CarryInRegistrationExportUnclearedCustoms/Create |
帳票:BICを作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 |
|
POST | /API/v1/NaccsReport/CarryInRegistrationExportUnclearedCustoms/CreateByBlNo |
B/L番号を指定して、帳票:BICを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定されたB/L番号(***blNo***)に該当する取引に対して、帳票:BICを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定されたB/L番号(***blNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 カスタムID(***customId***)は作成数に制限がない帳票を特定できるように任意に設定できる項目です。 カスタムID(***customId***)に値が設定されていなくても帳票:BICは作成可能です。同じカスタムID(***customId***)の帳票:BICが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/CarryInRegistrationExportUnclearedCustoms/CreateByBookingNo |
ブッキング番号を指定して、帳票:BICを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:BICを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 カスタムID(***customId***)は作成数に制限がない帳票を特定できるように任意に設定できる項目です。 カスタムID(***customId***)に値が設定されていなくても帳票:BICは作成可能です。同じカスタムID(***customId***)の帳票:BICが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/CarryInRegistrationExportUnclearedCustoms/CreateByDomesticNo |
社内管理番号を指定して、帳票:BICを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:BICを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 カスタムID(***customId***)は作成数に制限がない帳票を特定できるように任意に設定できる項目です。 カスタムID(***customId***)に値が設定されていなくても帳票:BICは作成可能です。同じカスタムID(***customId***)の帳票:BICが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/NaccsReport/CarryInRegistrationExportUnclearedCustoms/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:BICを削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/NaccsReport/CarryInRegistrationExportUnclearedCustoms/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId}&customId={customId} |
B/L番号を指定して、帳票:BICを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、帳票:BICを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/CarryInRegistrationExportUnclearedCustoms/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId}&customId={customId} |
ブッキング番号を指定して、帳票:BICを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:BICを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/CarryInRegistrationExportUnclearedCustoms/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId}&customId={customId} |
取引管理番号を指定して、帳票:BICを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:BICを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/CarryInRegistrationExportUnclearedCustoms/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId}&customId={customId} |
社内管理番号を指定して、帳票:BICを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:BICを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/NaccsReport/CarryInRegistrationExportUnclearedCustoms/Get/{dealReportId} |
帳票:BICを取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/NaccsReport/CarryInRegistrationExportUnclearedCustoms/GetListByBlNo/{blNo}?customId={customId} |
B/L番号を指定して、帳票:BICを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、BICを取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が付番されている全ての取引から、帳票:BICを取得します。 |
|
GET | /API/v1/NaccsReport/CarryInRegistrationExportUnclearedCustoms/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&customId={customId} |
ブッキング番号を指定して、帳票:BICを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:BICを取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が付番されている全ての取引から、帳票:BICを取得します。 |
|
GET | /API/v1/NaccsReport/CarryInRegistrationExportUnclearedCustoms/GetListByDealNo/{dealNo} |
取引管理番号を指定して、帳票:BICを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:BICを取得します。 |
|
GET | /API/v1/NaccsReport/CarryInRegistrationExportUnclearedCustoms/GetListByDomesticNo/{domesticNo}?customId={customId} |
社内管理番号を指定して、帳票:BICを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:BICを取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:BICを取得します。 |
|
POST | /API/v1/NaccsReport/CarryInRegistrationExportUnclearedCustoms/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/CarryInRegistrationExportUnclearedCustoms/Register |
帳票:BICを保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
CfsDispatchOrders
CFS搬出票
API | Description | ||
---|---|---|---|
POST | /API/v1/Report/CfsDispatchOrders/Create |
帳票:CFS搬出票を作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 帳票:CFS搬出票が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/Report/CfsDispatchOrders/CreateAttachFileMeta |
添付ファイルメタ情報を登録します。 |
|
POST | /API/v1/Report/CfsDispatchOrders/CreateByBlNo |
B/L番号を指定して、帳票:CFS搬出票を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定されたB/L番号(***blNo***)に該当する取引に対して、帳票:CFS搬出票を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定されたB/L番号(***blNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:CFS搬出票が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/Report/CfsDispatchOrders/CreateByBookingNo |
ブッキング番号を指定して、帳票:CFS搬出票を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:CFS搬出票を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:CFS搬出票が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/Report/CfsDispatchOrders/CreateByDomesticNo |
社内管理番号を指定して、帳票:CFS搬出票を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:CFS搬出票を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:CFS搬出票が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/Report/CfsDispatchOrders/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:CFS搬出票を削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/Report/CfsDispatchOrders/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
B/L番号を指定して、帳票:CFS搬出票を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、帳票:CFS搬出票を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/Report/CfsDispatchOrders/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId} |
ブッキング番号を指定して、帳票:CFS搬出票を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:CFS搬出票を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/Report/CfsDispatchOrders/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
取引管理番号を指定して、帳票:CFS搬出票を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:CFS搬出票を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/Report/CfsDispatchOrders/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
社内管理番号を指定して、帳票:CFS搬出票を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:CFS搬出票を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/Report/CfsDispatchOrders/Get/{dealReportId} |
帳票:CFS搬出票を取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/Report/CfsDispatchOrders/GetAttachFileMetaList/{dealReportId} |
添付ファイル情報一覧を取得します。 |
|
GET | /API/v1/Report/CfsDispatchOrders/GetByDealNo/{dealNo} |
取引管理番号を指定して、帳票:CFS搬出票を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:CFS搬出票を取得します。 |
|
GET | /API/v1/Report/CfsDispatchOrders/GetListByBlNo/{blNo} |
B/L番号を指定して、帳票:CFS搬出票を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、CFS搬出票を取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が付番されている全ての取引から、帳票:CFS搬出票を取得します。 |
|
GET | /API/v1/Report/CfsDispatchOrders/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo} |
ブッキング番号を指定して、帳票:CFS搬出票を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:CFS搬出票を取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が付番されている全ての取引から、帳票:CFS搬出票を取得します。 |
|
GET | /API/v1/Report/CfsDispatchOrders/GetListByDomesticNo/{domesticNo} |
社内管理番号を指定して、帳票:CFS搬出票を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:CFS搬出票を取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:CFS搬出票を取得します。 |
|
POST | /API/v1/Report/CfsDispatchOrders/Register |
帳票:CFS搬出票を保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
ChangeHistories
マスタ更新履歴
API | Description | ||
---|---|---|---|
GET | /API/v1/Master/ChangeHistories/GetListByDatetime?startDatetime={startDatetime} |
指定したstartDatetime以降のマスタ変更履歴リストを取得します。 ## 概要 マスタデータの更新リストを取得します。取得対象は指定した日時(***startDatetime***) 以降のデータとなります。 ## 指定するパラメタについて ### 日時 日時(***startDatetime***)は、マスタ更新履歴作成時の日時が設定されています |
|
GET | /API/v1/Master/ChangeHistories/GetListBySeqNo/{startSeqNo} |
指定したseqNo以降のマスタ変更履歴リストを取得します。 ## 概要 マスタデータの更新リストを取得します。取得対象は指定したシーケンス番号(***seqNo***) 以降のデータとなります。 ## 指定するパラメタについて ### シーケンス番号 シーケンス番号(***seqNo***)は、マスタ更新履歴作成時に昇順で連番が振られます |
CLR
CLR_船積情報登録
API | Description | ||
---|---|---|---|
POST | /API/v1/NACCS/CLR/Create |
帳票:CLR_船積情報登録を作成します。 帳票:CLR_船積情報登録を作成します。帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対して、Write権限が必要です。また、取引内に帳票:CLR_船積情報登録が存在する場合は、ステータスコード:200となり、Getメソッドと同じ動作となります。 |
|
DELETE | /API/v1/NACCS/CLR/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:CLR_船積情報登録を削除します。 帳票:CLR_船積情報登録を削除します。帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
GET | /API/v1/NACCS/CLR/Get/{dealReportId} |
帳票:CLR_船積情報登録を取得します。 帳票:CLR_船積情報登録を取得します。帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対して、Read権限が必要です。 |
ColinsViewers
Colins連携
API | Description | ||
---|---|---|---|
GET | /API/v1/ColinsViewers/ExportContainer/GetListByBookingNo/{bookingNo} |
ブッキング番号を指定して、Colinsの輸出コンテナを取得します。 ## 概要 Colinsに登録されている輸出のコンテナ情報の中から、ブッキング番号(***bookingNo***)に該当するコンテナ情報を取得します。 指定されたパラメタに該当するデータが存在しない場合もステータスコード:500となります。 ## 指定するパラメタについて ### ブッキング番号 ブッキング番号(***bookingNo***)を指定します。 |
|
GET | /API/v1/ColinsViewers/ExportContainer/GetListByBookingNoList/{bookingNo} |
ブッキング番号を複数指定して、Colinsの輸出コンテナを取得します。 ## 概要 Colinsに登録されている輸出のコンテナ情報の中から、ブッキング番号(***bookingNo***)に該当するコンテナ情報を取得します。 指定されたパラメタに該当するデータが存在しない場合もステータスコード:500となります。 ## 指定するパラメタについて ### ブッキング番号 ブッキング番号(***bookingNo***)を指定します。カンマ区切りで複数指定可能です。例:「BkNo001,BkNo002,BkNo003」 |
|
GET | /API/v1/ColinsViewers/ExportContainer/GetListByContainerNo/{containerNo}?bookingNo={bookingNo} |
コンテナ番号を指定して、Colinsの輸出コンテナを取得します。 ## 概要 Colinsに登録されている輸出のコンテナ情報の中から、コンテナ番号(***containerNo***)とブッキング番号(***bookingNo***)に該当するコンテナ情報を取得します。 指定されたパラメタに該当するデータが存在しない場合もステータスコード:500となります。 ## 指定するパラメタについて ### コンテナ番号 コンテナ番号(***containerNo***)を指定します。 ### ブッキング番号 ブッキング番号(***bookingNo***)を指定します。 |
|
GET | /API/v1/ColinsViewers/ExportVessel/GetListByCallSign/{callSign}?voyageNo={voyageNo}&scacCode={scacCode} |
コールサインを指定して、Colinsの輸出本船情報を取得します。 ## 概要 Colinsに登録されている輸出の本船情報の中から、コールサイン(***callSign***)と航海番号(***voyageNo***)、船社コード(***scacCode***)に該当する本船情報を取得します。 指定されたパラメタに該当するデータが存在しない場合もステータスコード:500となります。 ## 指定するパラメタについて ### コールサイン コールサイン(***callSign***)を指定します。 ### 航海番号 航海番号(***voyageNo***)を指定します。 ### 船社コード 船社コード(***scacCode***)を指定します。 |
|
GET | /API/v1/ColinsViewers/ExportVessel/GetListByVesselName/{vesselName}?voyageNo={voyageNo}&scacCode={scacCode} |
本船名を指定して、Colinsの輸出本船情報を取得します。 ## 概要 Colinsに登録されている輸出の本船情報の中から、本船名(***vesselName***)と航海番号(***voyageNo***)、船社コード(***scacCode***)に該当する本船情報を取得します。 指定されたパラメタに該当するデータが存在しない場合もステータスコード:500となります。 ## 指定するパラメタについて ### 本船名 本船名(***vesselName***)を指定します。 ### 航海番号 航海番号(***voyageNo***)を指定します。 ### 船社コード 船社コード(***scacCode***)を指定します。 |
|
GET | /API/v1/ColinsViewers/ImportContainer/GetListByBlNo/{blNo} |
B/L番号を指定して、Colinsの輸入コンテナを取得します。 ## 概要 Colinsに登録されている輸入のコンテナ情報(CY搬出可否情報)の中から、B/L番号(***blNo***)に該当するコンテナ情報を取得します。 指定されたパラメタに該当するデータが存在しない場合もステータスコード:500となります。 ## 指定するパラメタについて ### B/L番号 B/L番号(***blNo***)を指定します。 |
|
GET | /API/v1/ColinsViewers/ImportContainer/GetListByBlNoList/{blNo} |
B/L番号を複数指定して、Colinsの輸入コンテナを取得します。 ## 概要 Colinsに登録されている輸入のコンテナ情報(CY搬出可否情報)の中から、B/L番号(***blNo***)に該当するコンテナ情報を取得します。 指定されたパラメタに該当するデータが存在しない場合もステータスコード:500となります。 ## 指定するパラメタについて ### B/L番号 B/L番号(***blNo***)を指定します。カンマ区切りで複数指定可能です。例:「BlNo001,BlNo002,BlNo003」 |
|
GET | /API/v1/ColinsViewers/ImportContainer/GetListByContainerNo/{containerNo}?blNo={blNo} |
コンテナ番号を指定して、Colinsの輸入コンテナを取得します。 ## 概要 Colinsに登録されている輸入のコンテナ情報(CY搬出可否情報)の中から、コンテナ番号(***containerNo***)とB/L番号(***blNo***)に該当するコンテナ情報を取得します。 指定されたパラメタに該当するデータが存在しない場合もステータスコード:500となります。 ## 指定するパラメタについて ### コンテナ番号 コンテナ番号(***containerNo***)を指定します。 ### B/L番号 B/L番号(***blNo***)を指定します。 |
|
GET | /API/v1/ColinsViewers/ImportVessel/GetListByCallSign/{callSign}?voyageNo={voyageNo}&scacCode={scacCode} |
コールサインを指定して、Colinsの輸入本船情報を取得します。 ## 概要 Colinsに登録されている輸入の本船情報の中から、コールサイン(***callSign***)と航海番号(***voyageNo***)、船社コード(***scacCode***)に該当する本船情報を取得します。 指定されたパラメタに該当するデータが存在しない場合もステータスコード:500となります。 ## 指定するパラメタについて ### コールサイン コールサイン(***callSign***)を指定します。 ### 航海番号 航海番号(***voyageNo***)を指定します。 ### 船社コード 船社コード(***scacCode***)を指定します。 |
|
GET | /API/v1/ColinsViewers/ImportVessel/GetListByVesselName/{vesselName}?voyageNo={voyageNo}&scacCode={scacCode} |
本船名を指定して、Colinsの輸入本船情報を取得します。 ## 概要 Colinsに登録されている輸入の本船情報の中から、本船名(***vesselName***)と航海番号(***voyageNo***)、船社コード(***scacCode***)に該当する本船情報を取得します。 指定されたパラメタに該当するデータが存在しない場合もステータスコード:500となります。 ## 指定するパラメタについて ### 本船名 本船名(***vesselName***)を指定します。 ### 航海番号 航海番号(***voyageNo***)を指定します。 ### 船社コード 船社コード(***scacCode***)を指定します。 |
CollateralInquiries
IAS
API | Description | ||
---|---|---|---|
POST | /API/v1/NaccsReport/CollateralInquiries/Create |
帳票:IASを作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 帳票:IASが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/CollateralInquiries/CreateByBlNo |
B/L番号を指定して、帳票:IASを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定されたB/L番号(***blNo***)に該当する取引に対して、帳票:IASを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定されたB/L番号(***blNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:IASが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/CollateralInquiries/CreateByBookingNo |
ブッキング番号を指定して、帳票:IASを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:IASを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:IASが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/CollateralInquiries/CreateByDomesticNo |
社内管理番号を指定して、帳票:IASを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:IASを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:IASが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/NaccsReport/CollateralInquiries/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:IASを削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/NaccsReport/CollateralInquiries/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
B/L番号を指定して、帳票:IASを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、帳票:IASを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/CollateralInquiries/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId} |
ブッキング番号を指定して、帳票:IASを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:IASを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/CollateralInquiries/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
取引管理番号を指定して、帳票:IASを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:IASを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/CollateralInquiries/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
社内管理番号を指定して、帳票:IASを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:IASを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/NaccsReport/CollateralInquiries/Get/{dealReportId} |
帳票:IASを取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/NaccsReport/CollateralInquiries/GetByDealNo/{dealNo} |
取引管理番号を指定して、帳票:IASを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:IASを取得します。 |
|
GET | /API/v1/NaccsReport/CollateralInquiries/GetListByBlNo/{blNo} |
B/L番号を指定して、帳票:IASを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、IASを取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が付番されている全ての取引から、帳票:IASを取得します。 |
|
GET | /API/v1/NaccsReport/CollateralInquiries/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo} |
ブッキング番号を指定して、帳票:IASを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:IASを取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が付番されている全ての取引から、帳票:IASを取得します。 |
|
GET | /API/v1/NaccsReport/CollateralInquiries/GetListByDomesticNo/{domesticNo} |
社内管理番号を指定して、帳票:IASを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:IASを取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:IASを取得します。 |
|
POST | /API/v1/NaccsReport/CollateralInquiries/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/CollateralInquiries/Register |
帳票:IASを保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
CommercialInvoices
商業送り状
API | Description | ||
---|---|---|---|
POST | /API/v1/Report/CommercialInvoices/Create |
帳票:商業送り状を作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 帳票:商業送り状が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/Report/CommercialInvoices/CreateAttachFileMeta |
添付ファイルメタ情報を登録します。 |
|
POST | /API/v1/Report/CommercialInvoices/CreateByBlNo |
B/L番号を指定して、帳票:商業送り状を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定されたB/L番号(***blNo***)に該当する取引に対して、帳票:商業送り状を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定されたB/L番号(***blNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:商業送り状が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/Report/CommercialInvoices/CreateByBookingNo |
ブッキング番号を指定して、帳票:商業送り状を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:商業送り状を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:商業送り状が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/Report/CommercialInvoices/CreateByDomesticNo |
社内管理番号を指定して、帳票:商業送り状を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:商業送り状を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:商業送り状が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/Report/CommercialInvoices/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:商業送り状を削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/Report/CommercialInvoices/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
B/L番号を指定して、帳票:商業送り状を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、帳票:商業送り状を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/Report/CommercialInvoices/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId} |
ブッキング番号を指定して、帳票:商業送り状を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:商業送り状を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/Report/CommercialInvoices/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
取引管理番号を指定して、帳票:商業送り状を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:商業送り状を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/Report/CommercialInvoices/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
社内管理番号を指定して、帳票:商業送り状を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:商業送り状を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/Report/CommercialInvoices/Get/{dealReportId} |
帳票:商業送り状を取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/Report/CommercialInvoices/GetAttachFileMetaList/{dealReportId} |
添付ファイル情報一覧を取得します。 |
|
GET | /API/v1/Report/CommercialInvoices/GetByDealNo/{dealNo} |
取引管理番号を指定して、帳票:商業送り状を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:商業送り状を取得します。 |
|
GET | /API/v1/Report/CommercialInvoices/GetListByBlNo/{blNo} |
B/L番号を指定して、帳票:商業送り状を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、商業送り状を取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が付番されている全ての取引から、帳票:商業送り状を取得します。 |
|
GET | /API/v1/Report/CommercialInvoices/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo} |
ブッキング番号を指定して、帳票:商業送り状を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:商業送り状を取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が付番されている全ての取引から、帳票:商業送り状を取得します。 |
|
GET | /API/v1/Report/CommercialInvoices/GetListByDomesticNo/{domesticNo} |
社内管理番号を指定して、帳票:商業送り状を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:商業送り状を取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:商業送り状を取得します。 |
|
POST | /API/v1/Report/CommercialInvoices/Register |
帳票:商業送り状を保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
Common
ルートドキュメント共通
API | Description | ||
---|---|---|---|
GET | /API/v1/Common/GetContainerList/{dealNo}?reportCode={reportCode} |
コンテナ一覧を取得します。 |
|
GET | /API/v1/Common/GetNaccsInformation/{dealNo}?naccsBusinessCode={naccsBusinessCode} |
NACCS情報を取得します。 |
|
GET | /API/v1/Common/GetNaccsPartialDealInformation/{dealNo} |
NACCS用の初期値参照用取引情報を取得します。 |
|
GET | /API/v1/Common/GetNaccsPartialInvoice/{dealNo} |
NACCS用の初期値参照用インボイスを取得します。 |
|
GET | /API/v1/Common/GetPartialContainer/{dealNo} |
初期値参照用コンテナ情報を取得します。 |
|
GET | /API/v1/Common/GetPartialContainerRequest/{dealNo} |
初期値参照用コンテナ要求情報を取得します。 |
|
GET | /API/v1/Common/GetPartialDealInformation/{dealNo} |
初期値参照用取引情報を取得します。 |
|
GET | /API/v1/Common/GetPartialInvoice/{dealNo} |
初期値参照用インボイスを取得します。 |
|
GET | /API/v1/Common/GetPartialPackingListCommodity/{dealNo} |
初期値参照用パッキングリスト商品明細情報を取得します。 |
|
GET | /API/v1/Common/GetPartialRepresentativeCommodity/{dealNo} |
初期値参照用代表商品明細情報を取得します。 |
Companies
会社マスタ
API | Description | ||
---|---|---|---|
GET | /API/v1/Master/Companies/Get/{companyId} |
会社情報を取得します。 ## 概要 会社マスタから、会社ID(***companyId***)を指定して、会社の情報を取得します。 参照できる項目は、APIを呼び出すユーザが所属している会社情報により制限されます。 APIを呼び出すユーザが所属していない他社の情報の場合、参照できる項目は以下だけとなります。 会社ID(***companyId***) 会社名(***companyName***) ## 指定するパラメタについて ### 会社ID 取得する会社情報の会社ID(***companyId***)を指定します。 |
|
GET | /API/v1/Master/Companies/GetCount?filter={filter} |
検索条件を指定して、条件に該当する会社の件数を取得します。 ## 概要 検索条件を指定して、条件に該当する会社の件数を取得します。 検索条件の指定方法については、[こちらを参照ください](https://docs.microsoft.com/ja-jp/graph/query-parameters#filter-parameter)。 |
|
GET | /API/v1/Master/Companies/GetList?filter={filter}&orderby={orderby} |
検索条件を指定して、条件に該当する会社情報を全て取得します。 ## 概要 検索条件を指定して、条件に該当する会社情報を全て取得します。 ***/API/v1/Master/Companies/Get*** と同じく、APIを呼び出すユーザが所属していない他社の情報の場合、参照できる項目は制限されます。 検索条件の指定方法については、[こちらを参照ください](https://docs.microsoft.com/ja-jp/graph/query-parameters#filter-parameter) |
|
GET | /API/v1/Master/Companies/GetList?filter={filter}&orderby={orderby}&top={top} |
検索条件を指定して、条件に該当する会社情報を全て取得します。 ## 概要 検索条件を指定して、条件に該当する会社情報を全て取得します。 ***/API/v1/Master/Companies/Get*** と同じく、APIを呼び出すユーザが所属していない他社の情報の場合、参照できる項目は制限されます。 検索条件の指定方法については、[こちらを参照ください](https://docs.microsoft.com/ja-jp/graph/query-parameters#filter-parameter) |
ContactInformations
問合せ先マスタ
API | Description | ||
---|---|---|---|
GET | /API/v1/Master/ContactInformations/Get/{contactInformationId} |
問合せ先マスタを取得します。 |
|
GET | /API/v1/Master/ContactInformations/GetList?filter={filter}&orderby={orderby} |
問合せ先マスタを取得します。 |
ContainerDeliveryReceipts
コンテナ貨物受領書
API | Description | ||
---|---|---|---|
POST | /API/v1/Report/ContainerDeliveryReceipts/Create |
帳票:コンテナ貨物受領書を作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 |
|
POST | /API/v1/Report/ContainerDeliveryReceipts/CreateAttachFileMeta |
添付ファイルメタ情報を登録します。 |
|
POST | /API/v1/Report/ContainerDeliveryReceipts/CreateByBlNo |
B/L番号を指定して、帳票:コンテナ貨物受領書を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定されたB/L番号(***blNo***)に該当する取引に対して、帳票:コンテナ貨物受領書を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定されたB/L番号(***blNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 カスタムID(***customId***)は作成数に制限がない帳票を特定できるように任意に設定できる項目です。 カスタムID(***customId***)に値が設定されていなくても帳票:コンテナ貨物受領書は作成可能です。同じカスタムID(***customId***)の帳票:コンテナ貨物受領書が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/Report/ContainerDeliveryReceipts/CreateByBookingNo |
ブッキング番号を指定して、帳票:コンテナ貨物受領書を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:コンテナ貨物受領書を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 カスタムID(***customId***)は作成数に制限がない帳票を特定できるように任意に設定できる項目です。 カスタムID(***customId***)に値が設定されていなくても帳票:コンテナ貨物受領書は作成可能です。同じカスタムID(***customId***)の帳票:コンテナ貨物受領書が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/Report/ContainerDeliveryReceipts/CreateByDomesticNo |
社内管理番号を指定して、帳票:コンテナ貨物受領書を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:コンテナ貨物受領書を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 カスタムID(***customId***)は作成数に制限がない帳票を特定できるように任意に設定できる項目です。 カスタムID(***customId***)に値が設定されていなくても帳票:コンテナ貨物受領書は作成可能です。同じカスタムID(***customId***)の帳票:コンテナ貨物受領書が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/Report/ContainerDeliveryReceipts/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:コンテナ貨物受領書を削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/Report/ContainerDeliveryReceipts/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId}&customId={customId} |
B/L番号を指定して、帳票:コンテナ貨物受領書を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、帳票:コンテナ貨物受領書を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/Report/ContainerDeliveryReceipts/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId}&customId={customId} |
ブッキング番号を指定して、帳票:コンテナ貨物受領書を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:コンテナ貨物受領書を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/Report/ContainerDeliveryReceipts/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId}&customId={customId} |
取引管理番号を指定して、帳票:コンテナ貨物受領書を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:コンテナ貨物受領書を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/Report/ContainerDeliveryReceipts/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId}&customId={customId} |
社内管理番号を指定して、帳票:コンテナ貨物受領書を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:コンテナ貨物受領書を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/Report/ContainerDeliveryReceipts/Get/{dealReportId} |
帳票:コンテナ貨物受領書を取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/Report/ContainerDeliveryReceipts/GetAttachFileMetaList/{dealReportId} |
添付ファイル情報一覧を取得します。 |
|
GET | /API/v1/Report/ContainerDeliveryReceipts/GetListByBlNo/{blNo}?customId={customId} |
B/L番号を指定して、帳票:コンテナ貨物受領書を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、コンテナ貨物受領書を取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が付番されている全ての取引から、帳票:コンテナ貨物受領書を取得します。 |
|
GET | /API/v1/Report/ContainerDeliveryReceipts/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&customId={customId} |
ブッキング番号を指定して、帳票:コンテナ貨物受領書を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:コンテナ貨物受領書を取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が付番されている全ての取引から、帳票:コンテナ貨物受領書を取得します。 |
|
GET | /API/v1/Report/ContainerDeliveryReceipts/GetListByDealNo/{dealNo} |
取引管理番号を指定して、帳票:コンテナ貨物受領書を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:コンテナ貨物受領書を取得します。 |
|
GET | /API/v1/Report/ContainerDeliveryReceipts/GetListByDomesticNo/{domesticNo}?customId={customId} |
社内管理番号を指定して、帳票:コンテナ貨物受領書を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:コンテナ貨物受領書を取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:コンテナ貨物受領書を取得します。 |
|
POST | /API/v1/Report/ContainerDeliveryReceipts/Register |
帳票:コンテナ貨物受領書を保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
ContainerGateInSlips
コンテナ貨物搬入票
API | Description | ||
---|---|---|---|
POST | /API/v1/Report/ContainerGateInSlips/Create |
帳票:コンテナ貨物搬入票を作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ## 帳票の作成単位 帳票:コンテナ貨物搬入票を取引内にコンテナ番号(***containerNo***)の単位で作成します。 同じコンテナ番号(***containerNo***)の帳票:コンテナ貨物搬入票が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/Report/ContainerGateInSlips/CreateAttachFileMeta |
添付ファイルメタ情報を登録します。 |
|
POST | /API/v1/Report/ContainerGateInSlips/CreateByBlNo |
B/L番号を指定して、帳票:コンテナ貨物搬入票を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定されたB/L番号(***blNo***)に該当する取引に対して、帳票:コンテナ貨物搬入票を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定されたB/L番号(***blNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 ## 帳票の作成単位 帳票:コンテナ貨物搬入票を取引内にコンテナ番号(***containerNo***)の単位で作成します。 同じコンテナ番号(***containerNo***)の帳票:コンテナ貨物搬入票が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/Report/ContainerGateInSlips/CreateByBookingNo |
ブッキング番号を指定して、帳票:コンテナ貨物搬入票を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:コンテナ貨物搬入票を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 ## 帳票の作成単位 帳票:コンテナ貨物搬入票を取引内にコンテナ番号(***containerNo***)の単位で作成します。 同じコンテナ番号(***containerNo***)の帳票:コンテナ貨物搬入票が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/Report/ContainerGateInSlips/CreateByDomesticNo |
社内管理番号を指定して、帳票:コンテナ貨物搬入票を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:コンテナ貨物搬入票を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 ## 帳票の作成単位 帳票:コンテナ貨物搬入票を取引内にコンテナ番号(***containerNo***)の単位で作成します。 同じコンテナ番号(***containerNo***)の帳票:コンテナ貨物搬入票が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/Report/ContainerGateInSlips/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:コンテナ貨物搬入票を削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/Report/ContainerGateInSlips/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId}&containerNo={containerNo} |
B/L番号を指定して、帳票:コンテナ貨物搬入票を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、帳票:コンテナ貨物搬入票を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/Report/ContainerGateInSlips/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId}&containerNo={containerNo} |
ブッキング番号を指定して、帳票:コンテナ貨物搬入票を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:コンテナ貨物搬入票を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/Report/ContainerGateInSlips/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId}&containerNo={containerNo} |
取引管理番号を指定して、帳票:コンテナ貨物搬入票を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:コンテナ貨物搬入票を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/Report/ContainerGateInSlips/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId}&containerNo={containerNo} |
社内管理番号を指定して、帳票:コンテナ貨物搬入票を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:コンテナ貨物搬入票を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/Report/ContainerGateInSlips/Get/{dealReportId} |
帳票:コンテナ貨物搬入票を取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/Report/ContainerGateInSlips/GetAttachFileMetaList/{dealReportId} |
添付ファイル情報一覧を取得します。 |
|
GET | /API/v1/Report/ContainerGateInSlips/GetListByBlNo/{blNo}?containerNo={containerNo} |
B/L番号を指定して、帳票:コンテナ貨物搬入票を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、コンテナ貨物搬入票を取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が付番されている全ての取引から、帳票:コンテナ貨物搬入票を取得します。 |
|
GET | /API/v1/Report/ContainerGateInSlips/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&containerNo={containerNo} |
ブッキング番号を指定して、帳票:コンテナ貨物搬入票を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:コンテナ貨物搬入票を取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が付番されている全ての取引から、帳票:コンテナ貨物搬入票を取得します。 |
|
GET | /API/v1/Report/ContainerGateInSlips/GetListByDealNo/{dealNo} |
取引管理番号を指定して、帳票:コンテナ貨物搬入票を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:コンテナ貨物搬入票を取得します。 |
|
GET | /API/v1/Report/ContainerGateInSlips/GetListByDomesticNo/{domesticNo}?containerNo={containerNo} |
社内管理番号を指定して、帳票:コンテナ貨物搬入票を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:コンテナ貨物搬入票を取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:コンテナ貨物搬入票を取得します。 |
|
POST | /API/v1/Report/ContainerGateInSlips/Register |
帳票:コンテナ貨物搬入票を保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
ContainerInformationInquiries
ICN
API | Description | ||
---|---|---|---|
POST | /API/v1/NaccsReport/ContainerInformationInquiries/Create |
帳票:ICNを作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 帳票:ICNが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/ContainerInformationInquiries/CreateByBlNo |
B/L番号を指定して、帳票:ICNを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定されたB/L番号(***blNo***)に該当する取引に対して、帳票:ICNを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定されたB/L番号(***blNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:ICNが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/ContainerInformationInquiries/CreateByBookingNo |
ブッキング番号を指定して、帳票:ICNを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:ICNを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:ICNが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/ContainerInformationInquiries/CreateByDomesticNo |
社内管理番号を指定して、帳票:ICNを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:ICNを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:ICNが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/NaccsReport/ContainerInformationInquiries/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:ICNを削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/NaccsReport/ContainerInformationInquiries/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
B/L番号を指定して、帳票:ICNを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、帳票:ICNを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/ContainerInformationInquiries/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId} |
ブッキング番号を指定して、帳票:ICNを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:ICNを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/ContainerInformationInquiries/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
取引管理番号を指定して、帳票:ICNを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:ICNを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/ContainerInformationInquiries/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
社内管理番号を指定して、帳票:ICNを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:ICNを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/NaccsReport/ContainerInformationInquiries/Get/{dealReportId} |
帳票:ICNを取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/NaccsReport/ContainerInformationInquiries/GetByDealNo/{dealNo} |
取引管理番号を指定して、帳票:ICNを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:ICNを取得します。 |
|
GET | /API/v1/NaccsReport/ContainerInformationInquiries/GetListByBlNo/{blNo} |
B/L番号を指定して、帳票:ICNを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、ICNを取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が付番されている全ての取引から、帳票:ICNを取得します。 |
|
GET | /API/v1/NaccsReport/ContainerInformationInquiries/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo} |
ブッキング番号を指定して、帳票:ICNを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:ICNを取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が付番されている全ての取引から、帳票:ICNを取得します。 |
|
GET | /API/v1/NaccsReport/ContainerInformationInquiries/GetListByDomesticNo/{domesticNo} |
社内管理番号を指定して、帳票:ICNを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:ICNを取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:ICNを取得します。 |
|
POST | /API/v1/NaccsReport/ContainerInformationInquiries/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/ContainerInformationInquiries/Register |
帳票:ICNを保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
ContainerLists
コンテナリスト
API | Description | ||
---|---|---|---|
POST | /API/v1/Report/ContainerLists/Create |
帳票:コンテナリストを作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 |
|
POST | /API/v1/Report/ContainerLists/CreateAttachFileMeta |
添付ファイルメタ情報を登録します。 |
|
POST | /API/v1/Report/ContainerLists/CreateByDomesticNo |
社内管理番号を指定して、帳票:コンテナリストを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:コンテナリストを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 カスタムID(***customId***)は作成数に制限がない帳票を特定できるように任意に設定できる項目です。 カスタムID(***customId***)に値が設定されていなくても帳票:コンテナリストは作成可能です。同じカスタムID(***customId***)の帳票:コンテナリストが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/Report/ContainerLists/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:コンテナリストを削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/Report/ContainerLists/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId}&customId={customId} |
取引管理番号を指定して、帳票:コンテナリストを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:コンテナリストを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/Report/ContainerLists/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId}&customId={customId} |
社内管理番号を指定して、帳票:コンテナリストを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:コンテナリストを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/Report/ContainerLists/Get/{dealReportId} |
帳票:コンテナリストを取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/Report/ContainerLists/GetAttachFileMetaList/{dealReportId} |
添付ファイル情報一覧を取得します。 |
|
GET | /API/v1/Report/ContainerLists/GetListByDealNo/{dealNo} |
取引管理番号を指定して、帳票:コンテナリストを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:コンテナリストを取得します。 |
|
GET | /API/v1/Report/ContainerLists/GetListByDomesticNo/{domesticNo}?customId={customId} |
社内管理番号を指定して、帳票:コンテナリストを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:コンテナリストを取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:コンテナリストを取得します。 |
|
POST | /API/v1/Report/ContainerLists/Register |
帳票:コンテナリストを保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
ContainerLoadPlans
コンテナ内積付書
API | Description | ||
---|---|---|---|
POST | /API/v1/Report/ContainerLoadPlans/Create |
帳票:コンテナ内積付書を作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 帳票:コンテナ内積付書が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/Report/ContainerLoadPlans/CreateAttachFileMeta |
添付ファイルメタ情報を登録します。 |
|
POST | /API/v1/Report/ContainerLoadPlans/CreateByBlNo |
B/L番号を指定して、帳票:コンテナ内積付書を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定されたB/L番号(***blNo***)に該当する取引に対して、帳票:コンテナ内積付書を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定されたB/L番号(***blNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:コンテナ内積付書が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/Report/ContainerLoadPlans/CreateByBookingNo |
ブッキング番号を指定して、帳票:コンテナ内積付書を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:コンテナ内積付書を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:コンテナ内積付書が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/Report/ContainerLoadPlans/CreateByDomesticNo |
社内管理番号を指定して、帳票:コンテナ内積付書を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:コンテナ内積付書を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:コンテナ内積付書が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/Report/ContainerLoadPlans/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:コンテナ内積付書を削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/Report/ContainerLoadPlans/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
B/L番号を指定して、帳票:コンテナ内積付書を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、帳票:コンテナ内積付書を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/Report/ContainerLoadPlans/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId} |
ブッキング番号を指定して、帳票:コンテナ内積付書を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:コンテナ内積付書を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/Report/ContainerLoadPlans/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
取引管理番号を指定して、帳票:コンテナ内積付書を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:コンテナ内積付書を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/Report/ContainerLoadPlans/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
社内管理番号を指定して、帳票:コンテナ内積付書を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:コンテナ内積付書を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/Report/ContainerLoadPlans/Get/{dealReportId} |
帳票:コンテナ内積付書を取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/Report/ContainerLoadPlans/GetAttachFileMetaList/{dealReportId} |
添付ファイル情報一覧を取得します。 |
|
GET | /API/v1/Report/ContainerLoadPlans/GetByDealNo/{dealNo} |
取引管理番号を指定して、帳票:コンテナ内積付書を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:コンテナ内積付書を取得します。 |
|
GET | /API/v1/Report/ContainerLoadPlans/GetListByBlNo/{blNo} |
B/L番号を指定して、帳票:コンテナ内積付書を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、コンテナ内積付書を取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が付番されている全ての取引から、帳票:コンテナ内積付書を取得します。 |
|
GET | /API/v1/Report/ContainerLoadPlans/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo} |
ブッキング番号を指定して、帳票:コンテナ内積付書を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:コンテナ内積付書を取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が付番されている全ての取引から、帳票:コンテナ内積付書を取得します。 |
|
GET | /API/v1/Report/ContainerLoadPlans/GetListByDomesticNo/{domesticNo} |
社内管理番号を指定して、帳票:コンテナ内積付書を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:コンテナ内積付書を取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:コンテナ内積付書を取得します。 |
|
POST | /API/v1/Report/ContainerLoadPlans/Register |
帳票:コンテナ内積付書を保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
CorporateNumberInquiries
IIE01
API | Description | ||
---|---|---|---|
POST | /API/v1/NaccsReport/CorporateNumberInquiries/Create |
帳票:IIE01を作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 帳票:IIE01が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/CorporateNumberInquiries/CreateByBlNo |
B/L番号を指定して、帳票:IIE01を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定されたB/L番号(***blNo***)に該当する取引に対して、帳票:IIE01を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定されたB/L番号(***blNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:IIE01が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/CorporateNumberInquiries/CreateByBookingNo |
ブッキング番号を指定して、帳票:IIE01を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:IIE01を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:IIE01が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/CorporateNumberInquiries/CreateByDomesticNo |
社内管理番号を指定して、帳票:IIE01を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:IIE01を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:IIE01が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/NaccsReport/CorporateNumberInquiries/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:IIE01を削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/NaccsReport/CorporateNumberInquiries/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
B/L番号を指定して、帳票:IIE01を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、帳票:IIE01を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/CorporateNumberInquiries/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId} |
ブッキング番号を指定して、帳票:IIE01を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:IIE01を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/CorporateNumberInquiries/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
取引管理番号を指定して、帳票:IIE01を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:IIE01を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/CorporateNumberInquiries/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
社内管理番号を指定して、帳票:IIE01を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:IIE01を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/NaccsReport/CorporateNumberInquiries/Get/{dealReportId} |
帳票:IIE01を取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/NaccsReport/CorporateNumberInquiries/GetByDealNo/{dealNo} |
取引管理番号を指定して、帳票:IIE01を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:IIE01を取得します。 |
|
GET | /API/v1/NaccsReport/CorporateNumberInquiries/GetListByBlNo/{blNo} |
B/L番号を指定して、帳票:IIE01を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、IIE01を取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が付番されている全ての取引から、帳票:IIE01を取得します。 |
|
GET | /API/v1/NaccsReport/CorporateNumberInquiries/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo} |
ブッキング番号を指定して、帳票:IIE01を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:IIE01を取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が付番されている全ての取引から、帳票:IIE01を取得します。 |
|
GET | /API/v1/NaccsReport/CorporateNumberInquiries/GetListByDomesticNo/{domesticNo} |
社内管理番号を指定して、帳票:IIE01を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:IIE01を取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:IIE01を取得します。 |
|
POST | /API/v1/NaccsReport/CorporateNumberInquiries/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/CorporateNumberInquiries/Register |
帳票:IIE01を保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
CustomsTransportDeclarationCalls
OLC11
API | Description | ||
---|---|---|---|
POST | /API/v1/NaccsReport/CustomsTransportDeclarationCalls/Create |
帳票:OLC11を作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 帳票:OLC11が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/CustomsTransportDeclarationCalls/CreateByBlNo |
B/L番号を指定して、帳票:OLC11を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定されたB/L番号(***blNo***)に該当する取引に対して、帳票:OLC11を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定されたB/L番号(***blNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:OLC11が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/CustomsTransportDeclarationCalls/CreateByBookingNo |
ブッキング番号を指定して、帳票:OLC11を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:OLC11を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:OLC11が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/CustomsTransportDeclarationCalls/CreateByDomesticNo |
社内管理番号を指定して、帳票:OLC11を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:OLC11を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:OLC11が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/NaccsReport/CustomsTransportDeclarationCalls/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:OLC11を削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/NaccsReport/CustomsTransportDeclarationCalls/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
B/L番号を指定して、帳票:OLC11を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、帳票:OLC11を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/CustomsTransportDeclarationCalls/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId} |
ブッキング番号を指定して、帳票:OLC11を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:OLC11を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/CustomsTransportDeclarationCalls/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
取引管理番号を指定して、帳票:OLC11を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:OLC11を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/CustomsTransportDeclarationCalls/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
社内管理番号を指定して、帳票:OLC11を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:OLC11を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/NaccsReport/CustomsTransportDeclarationCalls/Get/{dealReportId} |
帳票:OLC11を取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/NaccsReport/CustomsTransportDeclarationCalls/GetByDealNo/{dealNo} |
取引管理番号を指定して、帳票:OLC11を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:OLC11を取得します。 |
|
GET | /API/v1/NaccsReport/CustomsTransportDeclarationCalls/GetListByBlNo/{blNo} |
B/L番号を指定して、帳票:OLC11を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、OLC11を取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が付番されている全ての取引から、帳票:OLC11を取得します。 |
|
GET | /API/v1/NaccsReport/CustomsTransportDeclarationCalls/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo} |
ブッキング番号を指定して、帳票:OLC11を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:OLC11を取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が付番されている全ての取引から、帳票:OLC11を取得します。 |
|
GET | /API/v1/NaccsReport/CustomsTransportDeclarationCalls/GetListByDomesticNo/{domesticNo} |
社内管理番号を指定して、帳票:OLC11を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:OLC11を取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:OLC11を取得します。 |
|
POST | /API/v1/NaccsReport/CustomsTransportDeclarationCalls/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/CustomsTransportDeclarationCalls/Register |
帳票:OLC11を保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
CustomsTransportDeclarationPreRegistereds
OLC20
API | Description | ||
---|---|---|---|
POST | /API/v1/NaccsReport/CustomsTransportDeclarationPreRegistereds/Create |
帳票:OLC20を作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 帳票:OLC20が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/CustomsTransportDeclarationPreRegistereds/CreateByBlNo |
B/L番号を指定して、帳票:OLC20を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定されたB/L番号(***blNo***)に該当する取引に対して、帳票:OLC20を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定されたB/L番号(***blNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:OLC20が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/CustomsTransportDeclarationPreRegistereds/CreateByBookingNo |
ブッキング番号を指定して、帳票:OLC20を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:OLC20を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:OLC20が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/CustomsTransportDeclarationPreRegistereds/CreateByDomesticNo |
社内管理番号を指定して、帳票:OLC20を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:OLC20を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:OLC20が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/NaccsReport/CustomsTransportDeclarationPreRegistereds/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:OLC20を削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/NaccsReport/CustomsTransportDeclarationPreRegistereds/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
B/L番号を指定して、帳票:OLC20を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、帳票:OLC20を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/CustomsTransportDeclarationPreRegistereds/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId} |
ブッキング番号を指定して、帳票:OLC20を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:OLC20を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/CustomsTransportDeclarationPreRegistereds/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
取引管理番号を指定して、帳票:OLC20を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:OLC20を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/CustomsTransportDeclarationPreRegistereds/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
社内管理番号を指定して、帳票:OLC20を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:OLC20を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/NaccsReport/CustomsTransportDeclarationPreRegistereds/Get/{dealReportId} |
帳票:OLC20を取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/NaccsReport/CustomsTransportDeclarationPreRegistereds/GetByDealNo/{dealNo} |
取引管理番号を指定して、帳票:OLC20を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:OLC20を取得します。 |
|
GET | /API/v1/NaccsReport/CustomsTransportDeclarationPreRegistereds/GetListByBlNo/{blNo} |
B/L番号を指定して、帳票:OLC20を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、OLC20を取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が付番されている全ての取引から、帳票:OLC20を取得します。 |
|
GET | /API/v1/NaccsReport/CustomsTransportDeclarationPreRegistereds/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo} |
ブッキング番号を指定して、帳票:OLC20を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:OLC20を取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が付番されている全ての取引から、帳票:OLC20を取得します。 |
|
GET | /API/v1/NaccsReport/CustomsTransportDeclarationPreRegistereds/GetListByDomesticNo/{domesticNo} |
社内管理番号を指定して、帳票:OLC20を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:OLC20を取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:OLC20を取得します。 |
|
POST | /API/v1/NaccsReport/CustomsTransportDeclarationPreRegistereds/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/CustomsTransportDeclarationPreRegistereds/Register |
帳票:OLC20を保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
CustomsTransportDeclarationRegistrationCalls
OLA11
API | Description | ||
---|---|---|---|
POST | /API/v1/NaccsReport/CustomsTransportDeclarationRegistrationCalls/Create |
帳票:OLA11を作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 帳票:OLA11が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/CustomsTransportDeclarationRegistrationCalls/CreateByBlNo |
B/L番号を指定して、帳票:OLA11を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定されたB/L番号(***blNo***)に該当する取引に対して、帳票:OLA11を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定されたB/L番号(***blNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:OLA11が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/CustomsTransportDeclarationRegistrationCalls/CreateByBookingNo |
ブッキング番号を指定して、帳票:OLA11を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:OLA11を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:OLA11が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/CustomsTransportDeclarationRegistrationCalls/CreateByDomesticNo |
社内管理番号を指定して、帳票:OLA11を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:OLA11を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:OLA11が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/NaccsReport/CustomsTransportDeclarationRegistrationCalls/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:OLA11を削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/NaccsReport/CustomsTransportDeclarationRegistrationCalls/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
B/L番号を指定して、帳票:OLA11を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、帳票:OLA11を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/CustomsTransportDeclarationRegistrationCalls/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId} |
ブッキング番号を指定して、帳票:OLA11を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:OLA11を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/CustomsTransportDeclarationRegistrationCalls/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
取引管理番号を指定して、帳票:OLA11を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:OLA11を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/CustomsTransportDeclarationRegistrationCalls/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
社内管理番号を指定して、帳票:OLA11を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:OLA11を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/NaccsReport/CustomsTransportDeclarationRegistrationCalls/Get/{dealReportId} |
帳票:OLA11を取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/NaccsReport/CustomsTransportDeclarationRegistrationCalls/GetByDealNo/{dealNo} |
取引管理番号を指定して、帳票:OLA11を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:OLA11を取得します。 |
|
GET | /API/v1/NaccsReport/CustomsTransportDeclarationRegistrationCalls/GetListByBlNo/{blNo} |
B/L番号を指定して、帳票:OLA11を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、OLA11を取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が付番されている全ての取引から、帳票:OLA11を取得します。 |
|
GET | /API/v1/NaccsReport/CustomsTransportDeclarationRegistrationCalls/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo} |
ブッキング番号を指定して、帳票:OLA11を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:OLA11を取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が付番されている全ての取引から、帳票:OLA11を取得します。 |
|
GET | /API/v1/NaccsReport/CustomsTransportDeclarationRegistrationCalls/GetListByDomesticNo/{domesticNo} |
社内管理番号を指定して、帳票:OLA11を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:OLA11を取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:OLA11を取得します。 |
|
POST | /API/v1/NaccsReport/CustomsTransportDeclarationRegistrationCalls/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/CustomsTransportDeclarationRegistrationCalls/Register |
帳票:OLA11を保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
CustomsTransportDeclarationRegistrations
OLA
API | Description | ||
---|---|---|---|
POST | /API/v1/NaccsReport/CustomsTransportDeclarationRegistrations/Create |
帳票:OLAを作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 帳票:OLAが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/CustomsTransportDeclarationRegistrations/CreateByBlNo |
B/L番号を指定して、帳票:OLAを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定されたB/L番号(***blNo***)に該当する取引に対して、帳票:OLAを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定されたB/L番号(***blNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:OLAが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/CustomsTransportDeclarationRegistrations/CreateByBookingNo |
ブッキング番号を指定して、帳票:OLAを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:OLAを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:OLAが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/CustomsTransportDeclarationRegistrations/CreateByDomesticNo |
社内管理番号を指定して、帳票:OLAを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:OLAを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:OLAが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/NaccsReport/CustomsTransportDeclarationRegistrations/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:OLAを削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/NaccsReport/CustomsTransportDeclarationRegistrations/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
B/L番号を指定して、帳票:OLAを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、帳票:OLAを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/CustomsTransportDeclarationRegistrations/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId} |
ブッキング番号を指定して、帳票:OLAを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:OLAを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/CustomsTransportDeclarationRegistrations/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
取引管理番号を指定して、帳票:OLAを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:OLAを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/CustomsTransportDeclarationRegistrations/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
社内管理番号を指定して、帳票:OLAを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:OLAを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/NaccsReport/CustomsTransportDeclarationRegistrations/Get/{dealReportId} |
帳票:OLAを取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/NaccsReport/CustomsTransportDeclarationRegistrations/GetByDealNo/{dealNo} |
取引管理番号を指定して、帳票:OLAを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:OLAを取得します。 |
|
GET | /API/v1/NaccsReport/CustomsTransportDeclarationRegistrations/GetListByBlNo/{blNo} |
B/L番号を指定して、帳票:OLAを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、OLAを取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が付番されている全ての取引から、帳票:OLAを取得します。 |
|
GET | /API/v1/NaccsReport/CustomsTransportDeclarationRegistrations/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo} |
ブッキング番号を指定して、帳票:OLAを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:OLAを取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が付番されている全ての取引から、帳票:OLAを取得します。 |
|
GET | /API/v1/NaccsReport/CustomsTransportDeclarationRegistrations/GetListByDomesticNo/{domesticNo} |
社内管理番号を指定して、帳票:OLAを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:OLAを取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:OLAを取得します。 |
|
POST | /API/v1/NaccsReport/CustomsTransportDeclarationRegistrations/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/CustomsTransportDeclarationRegistrations/Register |
帳票:OLAを保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
CustomsTransportDeclarations
OLC
API | Description | ||
---|---|---|---|
POST | /API/v1/NaccsReport/CustomsTransportDeclarations/Create |
帳票:OLCを作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 帳票:OLCが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/CustomsTransportDeclarations/CreateByBlNo |
B/L番号を指定して、帳票:OLCを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定されたB/L番号(***blNo***)に該当する取引に対して、帳票:OLCを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定されたB/L番号(***blNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:OLCが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/CustomsTransportDeclarations/CreateByBookingNo |
ブッキング番号を指定して、帳票:OLCを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:OLCを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:OLCが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/CustomsTransportDeclarations/CreateByDomesticNo |
社内管理番号を指定して、帳票:OLCを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:OLCを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:OLCが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/NaccsReport/CustomsTransportDeclarations/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:OLCを削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/NaccsReport/CustomsTransportDeclarations/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
B/L番号を指定して、帳票:OLCを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、帳票:OLCを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/CustomsTransportDeclarations/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId} |
ブッキング番号を指定して、帳票:OLCを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:OLCを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/CustomsTransportDeclarations/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
取引管理番号を指定して、帳票:OLCを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:OLCを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/CustomsTransportDeclarations/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
社内管理番号を指定して、帳票:OLCを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:OLCを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/NaccsReport/CustomsTransportDeclarations/Get/{dealReportId} |
帳票:OLCを取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/NaccsReport/CustomsTransportDeclarations/GetByDealNo/{dealNo} |
取引管理番号を指定して、帳票:OLCを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:OLCを取得します。 |
|
GET | /API/v1/NaccsReport/CustomsTransportDeclarations/GetListByBlNo/{blNo} |
B/L番号を指定して、帳票:OLCを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、OLCを取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が付番されている全ての取引から、帳票:OLCを取得します。 |
|
GET | /API/v1/NaccsReport/CustomsTransportDeclarations/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo} |
ブッキング番号を指定して、帳票:OLCを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:OLCを取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が付番されている全ての取引から、帳票:OLCを取得します。 |
|
GET | /API/v1/NaccsReport/CustomsTransportDeclarations/GetListByDomesticNo/{domesticNo} |
社内管理番号を指定して、帳票:OLCを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:OLCを取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:OLCを取得します。 |
|
POST | /API/v1/NaccsReport/CustomsTransportDeclarations/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/CustomsTransportDeclarations/Register |
帳票:OLCを保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
CyCarryInConfirmRegistrations
CYA
API | Description | ||
---|---|---|---|
POST | /API/v1/NaccsReport/CyCarryInConfirmRegistrations/Create |
帳票:CYAを作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ## 帳票の作成単位 帳票:CYAを取引内にコンテナ番号(***containerNo***)の単位で作成します。 同じコンテナ番号(***containerNo***)の帳票:CYAが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/CyCarryInConfirmRegistrations/CreateByBlNo |
B/L番号を指定して、帳票:CYAを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定されたB/L番号(***blNo***)に該当する取引に対して、帳票:CYAを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定されたB/L番号(***blNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 ## 帳票の作成単位 帳票:CYAを取引内にコンテナ番号(***containerNo***)の単位で作成します。 同じコンテナ番号(***containerNo***)の帳票:CYAが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/CyCarryInConfirmRegistrations/CreateByBookingNo |
ブッキング番号を指定して、帳票:CYAを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:CYAを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 ## 帳票の作成単位 帳票:CYAを取引内にコンテナ番号(***containerNo***)の単位で作成します。 同じコンテナ番号(***containerNo***)の帳票:CYAが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/CyCarryInConfirmRegistrations/CreateByDomesticNo |
社内管理番号を指定して、帳票:CYAを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:CYAを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 ## 帳票の作成単位 帳票:CYAを取引内にコンテナ番号(***containerNo***)の単位で作成します。 同じコンテナ番号(***containerNo***)の帳票:CYAが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/NaccsReport/CyCarryInConfirmRegistrations/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:CYAを削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/NaccsReport/CyCarryInConfirmRegistrations/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId}&containerNo={containerNo} |
B/L番号を指定して、帳票:CYAを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、帳票:CYAを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/CyCarryInConfirmRegistrations/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId}&containerNo={containerNo} |
ブッキング番号を指定して、帳票:CYAを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:CYAを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/CyCarryInConfirmRegistrations/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId}&containerNo={containerNo} |
取引管理番号を指定して、帳票:CYAを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:CYAを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/CyCarryInConfirmRegistrations/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId}&containerNo={containerNo} |
社内管理番号を指定して、帳票:CYAを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:CYAを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/NaccsReport/CyCarryInConfirmRegistrations/Get/{dealReportId} |
帳票:CYAを取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/NaccsReport/CyCarryInConfirmRegistrations/GetListByBlNo/{blNo}?containerNo={containerNo} |
B/L番号を指定して、帳票:CYAを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、CYAを取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が付番されている全ての取引から、帳票:CYAを取得します。 |
|
GET | /API/v1/NaccsReport/CyCarryInConfirmRegistrations/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&containerNo={containerNo} |
ブッキング番号を指定して、帳票:CYAを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:CYAを取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が付番されている全ての取引から、帳票:CYAを取得します。 |
|
GET | /API/v1/NaccsReport/CyCarryInConfirmRegistrations/GetListByDealNo/{dealNo} |
取引管理番号を指定して、帳票:CYAを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:CYAを取得します。 |
|
GET | /API/v1/NaccsReport/CyCarryInConfirmRegistrations/GetListByDomesticNo/{domesticNo}?containerNo={containerNo} |
社内管理番号を指定して、帳票:CYAを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:CYAを取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:CYAを取得します。 |
|
POST | /API/v1/NaccsReport/CyCarryInConfirmRegistrations/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/CyCarryInConfirmRegistrations/Register |
帳票:CYAを保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
CyDispatchConfirmRegistrations
CYO
API | Description | ||
---|---|---|---|
POST | /API/v1/NaccsReport/CyDispatchConfirmRegistrations/Create |
帳票:CYOを作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ## 帳票の作成単位 帳票:CYOを取引内にコンテナ番号(***containerNo***)の単位で作成します。 同じコンテナ番号(***containerNo***)の帳票:CYOが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/CyDispatchConfirmRegistrations/CreateByBlNo |
B/L番号を指定して、帳票:CYOを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定されたB/L番号(***blNo***)に該当する取引に対して、帳票:CYOを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定されたB/L番号(***blNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 ## 帳票の作成単位 帳票:CYOを取引内にコンテナ番号(***containerNo***)の単位で作成します。 同じコンテナ番号(***containerNo***)の帳票:CYOが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/CyDispatchConfirmRegistrations/CreateByBookingNo |
ブッキング番号を指定して、帳票:CYOを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:CYOを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 ## 帳票の作成単位 帳票:CYOを取引内にコンテナ番号(***containerNo***)の単位で作成します。 同じコンテナ番号(***containerNo***)の帳票:CYOが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/CyDispatchConfirmRegistrations/CreateByDomesticNo |
社内管理番号を指定して、帳票:CYOを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:CYOを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 ## 帳票の作成単位 帳票:CYOを取引内にコンテナ番号(***containerNo***)の単位で作成します。 同じコンテナ番号(***containerNo***)の帳票:CYOが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/NaccsReport/CyDispatchConfirmRegistrations/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:CYOを削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/NaccsReport/CyDispatchConfirmRegistrations/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId}&containerNo={containerNo} |
B/L番号を指定して、帳票:CYOを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、帳票:CYOを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/CyDispatchConfirmRegistrations/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId}&containerNo={containerNo} |
ブッキング番号を指定して、帳票:CYOを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:CYOを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/CyDispatchConfirmRegistrations/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId}&containerNo={containerNo} |
取引管理番号を指定して、帳票:CYOを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:CYOを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/CyDispatchConfirmRegistrations/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId}&containerNo={containerNo} |
社内管理番号を指定して、帳票:CYOを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:CYOを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/NaccsReport/CyDispatchConfirmRegistrations/Get/{dealReportId} |
帳票:CYOを取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/NaccsReport/CyDispatchConfirmRegistrations/GetListByBlNo/{blNo}?containerNo={containerNo} |
B/L番号を指定して、帳票:CYOを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、CYOを取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が付番されている全ての取引から、帳票:CYOを取得します。 |
|
GET | /API/v1/NaccsReport/CyDispatchConfirmRegistrations/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&containerNo={containerNo} |
ブッキング番号を指定して、帳票:CYOを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:CYOを取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が付番されている全ての取引から、帳票:CYOを取得します。 |
|
GET | /API/v1/NaccsReport/CyDispatchConfirmRegistrations/GetListByDealNo/{dealNo} |
取引管理番号を指定して、帳票:CYOを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:CYOを取得します。 |
|
GET | /API/v1/NaccsReport/CyDispatchConfirmRegistrations/GetListByDomesticNo/{domesticNo}?containerNo={containerNo} |
社内管理番号を指定して、帳票:CYOを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:CYOを取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:CYOを取得します。 |
|
POST | /API/v1/NaccsReport/CyDispatchConfirmRegistrations/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/CyDispatchConfirmRegistrations/Register |
帳票:CYOを保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
CyDispatchOrders
コンテナ貨物搬出票
API | Description | ||
---|---|---|---|
POST | /API/v1/Report/CyDispatchOrders/Create |
帳票:コンテナ貨物搬出票を作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 |
|
POST | /API/v1/Report/CyDispatchOrders/CreateAttachFileMeta |
添付ファイルメタ情報を登録します。 |
|
POST | /API/v1/Report/CyDispatchOrders/CreateByBlNo |
B/L番号を指定して、帳票:コンテナ貨物搬出票を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定されたB/L番号(***blNo***)に該当する取引に対して、帳票:コンテナ貨物搬出票を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定されたB/L番号(***blNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 カスタムID(***customId***)は作成数に制限がない帳票を特定できるように任意に設定できる項目です。 カスタムID(***customId***)に値が設定されていなくても帳票:コンテナ貨物搬出票は作成可能です。同じカスタムID(***customId***)の帳票:コンテナ貨物搬出票が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/Report/CyDispatchOrders/CreateByBookingNo |
ブッキング番号を指定して、帳票:コンテナ貨物搬出票を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:コンテナ貨物搬出票を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 カスタムID(***customId***)は作成数に制限がない帳票を特定できるように任意に設定できる項目です。 カスタムID(***customId***)に値が設定されていなくても帳票:コンテナ貨物搬出票は作成可能です。同じカスタムID(***customId***)の帳票:コンテナ貨物搬出票が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/Report/CyDispatchOrders/CreateByDomesticNo |
社内管理番号を指定して、帳票:コンテナ貨物搬出票を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:コンテナ貨物搬出票を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 カスタムID(***customId***)は作成数に制限がない帳票を特定できるように任意に設定できる項目です。 カスタムID(***customId***)に値が設定されていなくても帳票:コンテナ貨物搬出票は作成可能です。同じカスタムID(***customId***)の帳票:コンテナ貨物搬出票が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/Report/CyDispatchOrders/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:コンテナ貨物搬出票を削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/Report/CyDispatchOrders/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId}&customId={customId} |
B/L番号を指定して、帳票:コンテナ貨物搬出票を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、帳票:コンテナ貨物搬出票を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/Report/CyDispatchOrders/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId}&customId={customId} |
ブッキング番号を指定して、帳票:コンテナ貨物搬出票を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:コンテナ貨物搬出票を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/Report/CyDispatchOrders/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId}&customId={customId} |
取引管理番号を指定して、帳票:コンテナ貨物搬出票を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:コンテナ貨物搬出票を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/Report/CyDispatchOrders/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId}&customId={customId} |
社内管理番号を指定して、帳票:コンテナ貨物搬出票を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:コンテナ貨物搬出票を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/Report/CyDispatchOrders/Get/{dealReportId} |
帳票:コンテナ貨物搬出票を取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/Report/CyDispatchOrders/GetAttachFileMetaList/{dealReportId} |
添付ファイル情報一覧を取得します。 |
|
GET | /API/v1/Report/CyDispatchOrders/GetListByBlNo/{blNo}?customId={customId} |
B/L番号を指定して、帳票:コンテナ貨物搬出票を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、コンテナ貨物搬出票を取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が付番されている全ての取引から、帳票:コンテナ貨物搬出票を取得します。 |
|
GET | /API/v1/Report/CyDispatchOrders/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&customId={customId} |
ブッキング番号を指定して、帳票:コンテナ貨物搬出票を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:コンテナ貨物搬出票を取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が付番されている全ての取引から、帳票:コンテナ貨物搬出票を取得します。 |
|
GET | /API/v1/Report/CyDispatchOrders/GetListByDealNo/{dealNo} |
取引管理番号を指定して、帳票:コンテナ貨物搬出票を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:コンテナ貨物搬出票を取得します。 |
|
GET | /API/v1/Report/CyDispatchOrders/GetListByDomesticNo/{domesticNo}?customId={customId} |
社内管理番号を指定して、帳票:コンテナ貨物搬出票を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:コンテナ貨物搬出票を取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:コンテナ貨物搬出票を取得します。 |
|
POST | /API/v1/Report/CyDispatchOrders/Register |
帳票:コンテナ貨物搬出票を保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
CYH
CYH_CY搬入情報登録
API | Description | ||
---|---|---|---|
POST | /API/v1/NACCS/CYH/Create |
帳票:CYH_CY搬入情報登録を作成します。 帳票:CYH_CY搬入情報登録を作成します。帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対して、Write権限が必要です。また、取引内に帳票:CYH_CY搬入情報登録が存在する場合は、ステータスコード:200となり、Getメソッドと同じ動作となります。 |
|
DELETE | /API/v1/NACCS/CYH/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:CYH_CY搬入情報登録を削除します。 帳票:CYH_CY搬入情報登録を削除します。帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
GET | /API/v1/NACCS/CYH/Get/{dealReportId} |
帳票:CYH_CY搬入情報登録を取得します。 帳票:CYH_CY搬入情報登録を取得します。帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対して、Read権限が必要です。 |
DangerousGoodsDescriptions
危険物明細書
API | Description | ||
---|---|---|---|
POST | /API/v1/Report/DangerousGoodsDescriptions/Create |
帳票:危険物明細書を作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 帳票:危険物明細書が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/Report/DangerousGoodsDescriptions/CreateAttachFileMeta |
添付ファイルメタ情報を登録します。 |
|
POST | /API/v1/Report/DangerousGoodsDescriptions/CreateByBlNo |
B/L番号を指定して、帳票:危険物明細書を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定されたB/L番号(***blNo***)に該当する取引に対して、帳票:危険物明細書を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定されたB/L番号(***blNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:危険物明細書が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/Report/DangerousGoodsDescriptions/CreateByBookingNo |
ブッキング番号を指定して、帳票:危険物明細書を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:危険物明細書を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:危険物明細書が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/Report/DangerousGoodsDescriptions/CreateByDomesticNo |
社内管理番号を指定して、帳票:危険物明細書を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:危険物明細書を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:危険物明細書が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/Report/DangerousGoodsDescriptions/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:危険物明細書を削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/Report/DangerousGoodsDescriptions/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
B/L番号を指定して、帳票:危険物明細書を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、帳票:危険物明細書を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/Report/DangerousGoodsDescriptions/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId} |
ブッキング番号を指定して、帳票:危険物明細書を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:危険物明細書を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/Report/DangerousGoodsDescriptions/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
取引管理番号を指定して、帳票:危険物明細書を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:危険物明細書を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/Report/DangerousGoodsDescriptions/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
社内管理番号を指定して、帳票:危険物明細書を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:危険物明細書を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/Report/DangerousGoodsDescriptions/Get/{dealReportId} |
帳票:危険物明細書を取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/Report/DangerousGoodsDescriptions/GetAttachFileMetaList/{dealReportId} |
添付ファイル情報一覧を取得します。 |
|
GET | /API/v1/Report/DangerousGoodsDescriptions/GetByDealNo/{dealNo} |
取引管理番号を指定して、帳票:危険物明細書を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:危険物明細書を取得します。 |
|
GET | /API/v1/Report/DangerousGoodsDescriptions/GetListByBlNo/{blNo} |
B/L番号を指定して、帳票:危険物明細書を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、危険物明細書を取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が付番されている全ての取引から、帳票:危険物明細書を取得します。 |
|
GET | /API/v1/Report/DangerousGoodsDescriptions/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo} |
ブッキング番号を指定して、帳票:危険物明細書を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:危険物明細書を取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が付番されている全ての取引から、帳票:危険物明細書を取得します。 |
|
GET | /API/v1/Report/DangerousGoodsDescriptions/GetListByDomesticNo/{domesticNo} |
社内管理番号を指定して、帳票:危険物明細書を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:危険物明細書を取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:危険物明細書を取得します。 |
|
POST | /API/v1/Report/DangerousGoodsDescriptions/Register |
帳票:危険物明細書を保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
DCL01
DCL01_卸コンテナ情報登録(事項登録)
API | Description | ||
---|---|---|---|
POST | /API/v1/NACCS/DCL01/Create |
帳票:DCL01_卸コンテナ情報登録(事項登録)を作成します。 帳票:DCL01_卸コンテナ情報登録(事項登録)を作成します。帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対して、Write権限が必要です。また、取引内に帳票:DCL01_卸コンテナ情報登録(事項登録)が存在する場合は、ステータスコード:200となり、Getメソッドと同じ動作となります。 |
|
DELETE | /API/v1/NACCS/DCL01/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:DCL01_卸コンテナ情報登録(事項登録)を削除します。 帳票:DCL01_卸コンテナ情報登録(事項登録)を削除します。帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
GET | /API/v1/NACCS/DCL01/Get/{dealReportId} |
帳票:DCL01_卸コンテナ情報登録(事項登録)を取得します。 帳票:DCL01_卸コンテナ情報登録(事項登録)を取得します。帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対して、Read権限が必要です。 |
DDR
DDR_危険物明細情報登録
API | Description | ||
---|---|---|---|
POST | /API/v1/NACCS/DDR/Create |
帳票:DDR_危険物明細情報登録を作成します。 帳票:DDR_危険物明細情報登録を作成します。帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対して、Write権限が必要です。また、取引内に帳票:DDR_危険物明細情報登録が存在する場合は、ステータスコード:200となり、Getメソッドと同じ動作となります。 |
|
DELETE | /API/v1/NACCS/DDR/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:DDR_危険物明細情報登録を削除します。 帳票:DDR_危険物明細情報登録を削除します。帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
GET | /API/v1/NACCS/DDR/Get/{dealReportId} |
帳票:DDR_危険物明細情報登録を取得します。 帳票:DDR_危険物明細情報登録を取得します。帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対して、Read権限が必要です。 |
DealReportHistories
取引・帳票履歴
API | Description | ||
---|---|---|---|
GET | /API/v1/DealReportHistories/Compare/{dealReportHistoryId} |
取引・帳票履歴から、その時点での帳票データと、更新前の帳票データとの差分を取得します。 ## 概要 取引と帳票は、作成や更新の履歴(履歴情報)を管理しており、その履歴情報には取引・帳票履歴ID(***dealReportHistoryId***)が設定されます。 履歴情報の操作種別が更新(***register***)の場合、その履歴(その時点)で更新された帳票データと、その更新前の帳票データとの差分を取得します。 例えば、ある取引内で以下の操作を行った場合、 1. 帳票:ブッキング依頼書(***BookingRequest***)の作成 2. 帳票:ブッキング依頼書(***BookingRequest***)の更新 *publisherCompanyName*に"あいうえお"を入力。 3. 帳票:ブッキング依頼書(***BookingRequest***)の更新 *publisherCompanyName*を"かきくけこ"に変更。 4. 帳票:ブッキング依頼書(***BookingRequest***)の更新 *publisherAddress*に"東京都千代田区"を入力 2.の時点の履歴情報の取引・帳票履歴ID(***dealReportHistoryId***)を指定して取得できる差分データは、1.との差分となります。(*publisherCompanyName*が"あいうえお"に変更) 3.の時点の履歴情報の取引・帳票履歴ID(***dealReportHistoryId***)を指定して取得できる差分データは、2.との差分となります。(*publisherCompanyName*が"かきくけこ"から"あいうえお"に変更) 4.の時点の履歴情報の取引・帳票履歴ID(***dealReportHistoryId***)を指定して取得できる差分データは、以下の通りです。(*publisherAddress*が"東京都千代田区"に変更) ## 指定するパラメタについて ### 取引・帳票履歴ID 差分データを取得する取引・帳票履歴の取引・帳票履歴ID(***dealReportHistoryId***)を指定します。 |
|
GET | /API/v1/DealReportHistories/Get/{dealReportHistoryId} |
取引・帳票履歴を取得します。 ## 概要 取引内の帳票は、更新前の状態を管理しており、その履歴には取引・帳票履歴ID(***dealReportHistoryId***)が設定されます。 このAPIでは、取引・帳票履歴IDを指定して、取引・帳票の更新履歴を取得します。 ## 指定するパラメタについて ### 取引・帳票履歴ID 取得する取引・帳票履歴の取引・帳票履歴ID(***dealReportHistoryId***)を指定します。 |
|
GET | /API/v1/DealReportHistories/GetCount?filter={filter} |
検索条件を指定して、条件に該当する取引・帳票履歴の件数を取得します。 ## 概要 検索条件を指定して、条件に取引・帳票履歴する取引の件数を取得します。 検索条件の指定方法については、[こちらを参照ください](https://docs.microsoft.com/ja-jp/graph/query-parameters#filter-parameter)。 |
|
GET | /API/v1/DealReportHistories/GetList?filter={filter}&orderby={orderby}&top={top} |
検索条件を指定して、条件に該当する取引・帳票履歴を全て取得します。 ## 概要 検索条件を指定して、条件に該当する取引・帳票履歴を全て取得します。 検索条件の指定方法については、[こちらを参照ください](https://docs.microsoft.com/ja-jp/graph/query-parameters#filter-parameter)。 |
|
GET | /API/v1/DealReportHistories/GetReportHistory/{dealReportHistoryId}?dealReportId={dealReportId} |
取引・帳票履歴から、その時点での過去の帳票データを取得します。 ## 概要 取引・帳票履歴から、その時点での過去の帳票データを取得します。 ## 指定するパラメタについて ### 取引・帳票履歴ID 取得する取引・帳票履歴の取引・帳票履歴ID(***dealReportHistoryId***)を指定します。 ### 取引・帳票ID 過去のデータを取得する帳票の取引・帳票ID(***dealReportId***)を指定します。 |
Deals
取引
API | Description | ||
---|---|---|---|
POST | /API/v1/Deals/AddMessage |
帳票を送信します。 |
|
DELETE | /API/v1/Deals/CancelBusinessProcess/{dealNo}/{businessProcessId} |
業務プロセスをキャンセルします。 ## 概要 取引管理番号(***dealNo***)と業務プロセスID(***businessProcessId***)を指定して、業務プロセスをキャンセルします。 |
|
POST | /API/v1/Deals/Create |
取引を作成します。 ## 概要 港湾関連データ連携基盤を通して、複数の事業者間で帳票のやり取りを行うには、まずはこのAPIで取引を作成します。取引は、複数の事業者間と港湾・貿易業務を行う上での共有空間として機能します。 作成された取引情報には、取引管理番号(***dealNo***)という一意の番号が附番され、空のルートドキュメントが作成されます。以降、取引情報は、取引管理番号(***dealNo***)で一意に識別できます。 取引が作成された時点では、取引のオーナー情報として指定した組織と事業種別が割り当てられたユーザーしかアクセス出来ません。他の事業者を取引に参加させ、帳票のやり取りを行うには、作成した取引に対し、取引参加組織の登録(***/API/v1/Deals/RegisterOrganization***)を行う必要があります。 取引のオーナー情報は、取引内に作成する帳票の項目についての書き込み権限を決定する際に使用されます。取引のオーナーとして指定された組織ID(***organizationId***)と事業種別ID(***businessTypeId***)は、帳票の一部項目について、書き込み権限が設定されます。 ## 指定するパラメタについて ### 取引のオーナー情報 取引を作成する際は、その取引のオーナー情報として、組織ID(***organizationId***)と事業種別ID(***businessTypeId***)を指定する必要があります。 この組織(***organizationId***)と事業種別(***businessTypeId***)は、APIを呼び出すユーザーが所属している組織とその組織に割り当てられた事業種別から選択します。 例えば、 - 事業種別として、荷主(*Sipper/Consignee*)と海貨業者(*Forarder*)が割り当てられた組織A - 事業種別として、NVOCC(*NVOCC/International Freight Forwarder*)が割り当てられた組織B の両方の所属するユーザが取引を作成する場合、取引のオーナー情報として指定する組織(***organizationId***)と事業種別(***businessTypeId***)の組み合わせは以下の3通りとなります。 1. 組織=組織A、事業種別=荷主(*Sipper/Consignee*) 2. 組織=組織A、事業種別=海貨業者(*Forarder*) 3. 組織=組織B、事業種別=NVOCC(*NVOCC/International Freight Forwarder*) ### 業務パターン 取引の属性情報となる業務パターン(***businessPattern***,***businessPatternDetail***)は、取引内に作成できる帳票や事業種別毎の帳票へのRead/Write権限を決定します。このデフォルトの設定は、帳票アクセス権限マスタ(***/API/v1/Master/ReportPermissions/***)に設定されています。 取引の作成以降、業務パターンは変更出来ません。 業務パターンの内容は以下の通りです。 | № | 項目 | 意味 | 説明 | | :--- | -------------------------------------- | -------------- | :----------------------------------------------------------- | | 1 | ***businessPattern*** | 輸出・輸入 | 取引が輸出向けのものなのか、輸入向けのものなのかを決定します。 | | 2 | ***businessPatternDetail/fclOrLcl*** | FCL・LCL | 取引の輸送形態、FCL(Full Container Load)・LCL(Less Than Container Load)のどちらかを決定します。 | | 3 | ***businessPatternDetail/hasCoastal*** | 仲介なし・あり | 取引に事業種別:海貨やフォワーダー等の仲介業者が参加するのか否かを示す識別です。この識別は取引の検索条件などに使用します。 | | 4 | ***businessPatternDetail/withBroker*** | 内航なし・あり | 取引に事業種別:内航船社が参加する場合は、内航ありとします。 | ### 社内管理番号 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号は取引に参加している組織・事業種別毎に附番できるので、各組織で任意の文字列による取引の特定が可能になります。社内管理番号(***domesticNo***)は、取引の作成後でも設定や変更が可能です(***/API/v1/Deals/SetDomesticNo***)。 社内管理番号(***domesticNo***)は、1つの取引に対して、取引のオーナーや取引参加組織毎に設定できます。社内管理番号(***domesticNo***)で取引を特定する場合は、***/API/v1/Deals/GetListByDomesticNo/{domesticNo}*** を使用します。 ### 取引名 取引名(***dealName***)は、取引に任意の名称をつける場合に指定します。取引の作成後でも設定や変更が可能です(***/API/v1/Deals/SetDealName***)。 |
|
POST | /API/v1/Deals/CreateInquiryDeal |
問合せ専用の取引を作成および取得します。 ## 概要 「問合せ元」と「問合せ先」のみが参加する問合せ専用の取引を作成および取得、また既に存在する場合は取得のみを行います。 ## 指定するパラメタについて ### 問合せ元の組織の組織ID・事業種別ID 問合せ元(=親)の組織ID(***parentOrganizationId***)と事業種別ID(***parentBusinessTypeId***)をセットで指定します。 ### 問合せ先の組織の組織ID・事業種別ID 問合せ先の組織(***organizationId***)と事業種別(***businessTypeId***)をセットで指定します。 |
|
DELETE | /API/v1/Deals/Delete |
取引を削除します。 |
|
DELETE | /API/v1/Deals/DeleteOrganization/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
取引に参加している組織を取引から削除します。 ## 概要 取引に参加している組織を削除できるのは、その組織を取引に招待した組織(に所属するユーザ)のみです。 このAPIの呼び出しに成功すると、その組織が取引内で作成した帳票も全て削除されます。 ## 指定するパラメタについて ### 取引管理番号 取引参加組織を削除する取引の取引管理番号(***dealNo***)を指定します。 ### 組織の組織ID・事業種別ID 削除する取引参加組織の組織ID(***organizationId***)と事業種別ID(***businessTypeId***)をセットで指定します。 |
|
POST | /API/v1/Deals/Duplicate |
取引を複製します。 ## 概要 複製できる取引は、ユーザが所属する組織と事業種別が参加する取引のみとなります。取引を複製すると、複製元の取引から、取引参加組織を引き継いだ形で、取引が作成されます。 但し、複製範囲(***organizationScope***)で、追加した組織のみとした場合、複製元でユーザが所属する組織(と事業種別)が追加した組織が複製対象となります。複製元の取引内に存在している帳票は複製対象とはなりません。 ## 指定するパラメタについて ### 取引管理番号 複製する取引の取引管理番号(***dealNo***)を指定します。 ### 組織ID・事業種別ID 取引を作成する際の取引のオーナー情報として、組織ID(***organizationId***)と事業種別ID(***businessTypeId***)を指定します。 ### 複製範囲 複製範囲(***organizationScope***)には、以下を指定します。 | パラメタ | 意味 | | ------------- | ------------------------------------------------------------ | | ***all*** | 複製元の取引に参加している全ての組織を含めて複製します。ただし、非公開組織は除きます。 | | ***selfAdd*** | 複製元の取引に追加した組織のみ複製します。ただし、非公開組織は除きます。 | ### 社内管理番号 作成する取引に社内管理番号(***domesticNo***)を附番する場合は指定します。 ### 取引名 作成する取引に取引名(***dealName***)をつける場合は指定します。 |
|
GET | /API/v1/Deals/Get/{dealNo} |
取引管理番号を指定して、取引を取得します。 ## 概要 ユーザが所属している組織が作成、または参加している取引について、取引管理番号(***dealNo***)を指定して、取引を取得します。 ## 指定するパラメタについて ### 取引管理番号 複製する取引の取引管理番号(***dealNo***)を指定します。 |
|
GET | /API/v1/Deals/GetCount?filter={filter} |
検索条件を指定して、条件に該当する取引の件数を取得します。 ## 概要 ユーザが所属している組織が作成、または参加している取引について、検索条件を指定して、条件に該当する取引の件数を取得します。 検索条件の指定方法については、[こちらを参照ください](https://docs.microsoft.com/ja-jp/graph/query-parameters#filter-parameter)。 |
|
GET | /API/v1/Deals/GetCount?searchConditionId={searchConditionId} |
検索条件を指定して、条件に該当する取引の件数を取得します。 |
|
GET | /API/v1/Deals/GetList?filter={filter}&orderby={orderby}&top={top} |
検索条件を指定して、条件に該当する取引を全て取得します。 ## 概要 ユーザが所属している組織が作成、または参加している取引について、検索条件を指定して、条件に該当する取引を全て取得します。 検索条件の指定方法については、[こちらを参照ください](https://docs.microsoft.com/ja-jp/graph/query-parameters#filter-parameter)。 |
|
GET | /API/v1/Deals/GetList?searchConditionId={searchConditionId}&orderby={orderby}&top={top} |
検索条件を指定して、条件に該当する取引を全て取得します。 |
|
GET | /API/v1/Deals/GetListByBlNo/{blNo} |
B/L番号を指定して、取引を取得します。 ## 概要 ユーザが所属している組織が作成、または参加している取引について、B/L番号(***blNo***)を指定して、取引を取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が附番されている全ての取引を取得します。 ## 指定するパラメタについて ### B/L番号 B/L番号(***blNo***)は、取引に対して設定するのではなく、帳票を通して(帳票の項目として)設定します。 |
|
GET | /API/v1/Deals/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo} |
ブッキング番号を指定して、取引を取得します。 ## 概要 ユーザが所属している組織が作成、または参加している取引について、船社コード(***scacCode***)とブッキング番号(***bookingNo***)を指定して、取引を取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が附番されている全ての取引を取得します。 ## 指定するパラメタについて ### 船社コード 船社コード(***scacCode***)は、取引に対して設定するのではなく、帳票を通して(帳票の項目として)設定します。 ### ブッキング番号 ブッキング番号(***bookingNo***)は、取引に対して設定するのではなく、帳票を通して(帳票の項目として)設定します。 |
|
GET | /API/v1/Deals/GetListByDomesticNo/{domesticNo} |
社内管理番号を指定して、取引を取得します。 ## 概要 ユーザが所属している組織が作成、または参加している取引について、社内管理番号(***domesticNo***)を指定して、取引を取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号は取引に参加している組織・事業種別毎に附番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が附番されている全ての取引を取得します。 ## 指定するパラメタについて ### 社内管理番号 社内管理番号(***domesticNo***)を指定します。 |
|
GET | /API/v1/Deals/GetReportList/{dealNo} |
取引管理番号を指定して、取引内に作成された帳票の一覧を取得します。 ## 概要 ユーザが所属している組織が作成、または参加している取引について、取引管理番号(***dealNo***)を指定して、取引内に作成された帳票の一覧を取得します。 ## 指定するパラメタについて ### 取引管理番号 複製する取引の取引管理番号(***dealNo***)を指定します。 |
|
POST | /API/v1/Deals/PlanBusinessProcess |
業務プロセスを予定(New)のステータスで登録します。 ## 概要 業務プロセスを予定(New)のステータスで新規作成し、取引に設定します。 ## 指定するパラメタについて ### 取引管理番号 業務プロセスを作成する取引の取引管理番号(***dealNo***)を指定します。 ### 業務テンプレートID 業務プロセス作成に利用する業務テンプレートのID(***businessTemplateId***)を指定します。 ### 組織の組織ID・事業種別ID 業務プロセスの作成者となる組織の組織ID(***organizationId***)と事業種別ID(***businessTypeId***)をセットで指定します。 |
|
POST | /API/v1/Deals/RegisterOrganization |
取引参加組織を登録します。 ## 概要 取引が作成された時点では、取引のオーナー情報として指定した組織と事業種別が割り当てられたユーザーしかアクセス出来ません。このAPIで、取引に他の事業者を参加させます。 取引参加組織を登録すると、取引を他の事業者と共有することになります。 ## 指定するパラメタについて ### 取引管理番号 取引参加組織を登録する取引の取引管理番号(***dealNo***)を指定します。 ### 招待元となる組織の組織ID・事業種別ID 取引に参加する組織の招待元となる組織の組織ID(***parentOrganizationId***)と事業種別ID(***parentBusinessTypeId***)を指定します。 ### 招待先となる組織の組織ID・事業種別ID 取引に参加する組織の組織(***organizationId***)と事業種別(***businessTypeId***)をセットで指定します。 ### 他の組織に公開するか否か 取引参加組織を他の取引参加組織に公開するか否かを指定します。 |
|
POST | /API/v1/Deals/RegisterReportPermission |
取引参加組織の帳票アクセス権限を変更します。 ## 概要 取引参加組織の登録(***/API/v1/Deals/RegisterOrganization***)を行うと、登録した組織の事業種別に従い、システムデフォルトでの帳票のRead/Write権限が設定されていますが、これを変更する場合に、このAPIを使用します。 この変更は、変更を行った取引に対してのみ有効です。 また、システムデフォルトでの帳票のRead/Write権限以上に権限を変更することは出来ません。例えば、システムデフォルトの設定で、ある帳票にRead権限までが設定されている場合、これをWrite権限に変更することは出来ません。 ## 指定するパラメタについて ### 取引管理番号 取引参加組織の帳票アクセス権限を変更する取引の取引管理番号(***dealNo***)を指定します。 ### 組織の組織ID・事業種別ID 帳票アクセス権限を変更する取引参加組織の組織ID(***organizationId***)と事業種別ID(***businessTypeId***)をセットで指定します。 ### 帳票アクセス権限 帳票アクセス権限を帳票毎に帳票コードで指定します。帳票コードについては、帳票マスタ(***/API/v1/Master/Reports***)を参照ください。 |
|
POST | /API/v1/Deals/SendReport |
帳票を送信します。 ## 概要 指定された帳票を取引参加組織に送信します。 帳票の送信は、その帳票が格納された取引に参加している組織のうち、その帳票にRead権限がある組織に対して行われます。 ## 指定するパラメタについて ### 取引管理番号 送信する帳票が格納された取引の取引管理番号(***dealNo***)を指定します。*※ただし、取引管理番号は指定しなくとも構いません。* ### 取引・帳票ID 送信する帳票の取引・帳票ID(***dealReportId***)を指定します。 ### 組織の組織ID・事業種別ID 送信元となる組織の組織ID(***organizationId***)と事業種別ID(***businessTypeId***)をセットで指定します。 ### メッセージ 帳票を送信する際の送信メッセージを指定します。 ### 帳票を担当する組織の組織ID・事業種別ID 取引参加組織の中から、帳票の担当者となる組織を、組織ID(***organizationId***)と事業種別ID(***businessTypeId***)のセットで指定します。 ## 通知を受け取る方法について このAPIで発行された通知を受け取る方法は、メール方式とWebhook方式の2つがあります。 ### メール方式 - 港湾関連データ連携基盤でのデフォルトでの通知受け取り方法です。組織に利用者アカウントを登録することで通知が受けられます。 - 通知について で各アクションで送信対象となる取引参加組織に所属する利用者全てにメールが送信されます。 - この通知を受け取るか否かは、利用者・帳票毎に設定可能です。 ### Webhook方式 - 港湾関連データ連携基盤でのオプションとしての通知受け取り方法です。組織情報にWebhookで使用するURLを設定することで、通知をJSONデータとして受け取ることが可能です。 - 例えば、通知について でのアクションと、貴社システムのアプリケーションをWebhookをトリガーとして自動で連携処理を行いたい場合などは、この方式を利用します。 - 組織に、Webhook通知用のシステムを登録する必要があります。 |
|
POST | /API/v1/Deals/SetDealName |
取引名を設定します。 ## 概要 作成した取引に任意の名称を設定します。 この名称は、取引の作成(***/API/v1/Deals/Create***)でも指定可能です。 取引の作成(***/API/v1/Deals/Create***)で設定した名称を変更する場合にも使用できます。 ## 指定するパラメタについて ### 取引管理番号 取引名を設定する取引の取引管理番号(***dealNo***)を指定します。 ### 取引名 取引名(***dealName***)を指定します。 |
|
POST | /API/v1/Deals/SetDomesticNo |
社内管理番号を設定します。 ## 概要 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号は取引に参加している組織・事業種別毎に附番できるので、各組織で任意の文字列による取引の特定が可能になります。 ## 指定するパラメタについて ### 取引管理番号 社内管理番号を設定する取引の取引管理番号(***dealNo***)を指定します。 ### 社内管理番号 社内管理番号(***domesticNo***)を指定します。 |
|
POST | /API/v1/Deals/SetInCharge |
取引内の帳票について、担当となる組織を設定します。 ## 概要 取引内の帳票について、取引参加組織の中から、帳票の担当者となる組織を設定します。 ## 指定するパラメタについて ### 取引管理番号 担当となる組織を設定する帳票が格納された取引の取引管理番号(***dealNo***)を指定します。 ### 帳票を担当する組織の組織ID・事業種別ID 取引参加組織の中から、帳票の担当者となる組織を、組織ID(***organizationId***)と事業種別ID(***businessTypeId***)のセットで指定します。 ### 取引・帳票ID 担当となる組織を設定する帳票の取引・帳票ID(***dealReportId***)を指定します。 ### 担当状態 担当状態(***inCharge***)には、”担当する"の場合はtrue、"担当しない(解除する)"の場合はfalseを指定します。 |
|
POST | /API/v1/Deals/SetIsCompleted |
取引完了フラグを設定します。 ## 概要 指定された取引の完了フラグを設定します。 ## 指定するパラメタについて ### 取引管理番号 完了フラグを設定する取引の取引管理番号(***dealNo***)を指定します。 ### 完了フラグ 完了フラグ(***isCompleted***)取引を完了にする場合はtrue、しない場合はfalseを指定します。 |
|
POST | /API/v1/Deals/SetParentDealNo |
親の取引管理番号を設定します。 ## 概要 指定された取引に、親となる取引の取引管理番号を設定します。親子関係となった取引では、LCLなどの業務が行えます。 ## 指定するパラメタについて ### 取引管理番号 取引の取引管理番号(***dealNo***)を指定します。 ### 親となる取引の取引管理番号 親となる取引の取引管理番号(***parentDealNo***)を設定します。 |
|
POST | /API/v1/Deals/StartBusinessProcess |
業務プロセス(未処理)を開始します。 ## 概要 ステータスが未処理の業務プロセスを開始し、取引に設定します。 業務プロセスを開始すると、業務テンプレートにて定義されている取り扱う帳票と、その帳票に紐づくタスクが作成されます。作成されたタスクは、業務プロセスに紐づきます。 ## 指定するパラメタについて ### 業務プロセスID 開始する業務プロセスID(***businessProcessId***)を指定します ### 業務プロセス名 開始する業務プロセスの名称を変更する場合、業務プロセスの名称(***businessProcessName***)を指定します ### 組織の組織ID・事業種別ID・利用者ID 業務プロセスの担当者(業務プロセスにて取り扱う帳票の入力者)となる組織の組織ID(***organizationId***)と事業種別ID(***businessTypeId***)をセットで指定します。 利用者ID(***employeeId***)は任意となります。 APIの実行者が所属する組織と業務プロセスの担当者の所属する組織は同一である必要があります。 同様に、業務プロセスにて取り扱う帳票の宛先となる組織の組織ID(***organizationId***)と事業種別ID(***businessTypeId***)も指定します。 利用者ID(***employeeId***)は入力不要となります。 ### 帳票 業務プロセスにて取り扱う帳票に対し、帳票コード、取引・帳票ID、コンテナ番号、機器受渡種別(IN/OUT)、コンテナ状態(FULL/EMPTY)、コンテナターミナルコードのセットを配列方式で指定します。 このパラメタでは同一帳票コードの帳票を複数指定することができます。 また、業務プロセスにて取り扱う帳票に対応する帳票コードは各帳票それぞれ1回以上指定してください。 取引内に既存の帳票を指定する場合は帳票の取引・帳票IDを指定してください。 対象の帳票がコンテナ単位の帳票である場合、コンテナ番号(***containerNo***)を指定します。 対象の帳票が機器受領書(EIR)である場合、機器受渡種別(IN/OUT)(***equipmentInterchangeTypeInOut***)、コンテナ状態(FULL/EMPTY)(***countainerTypeId***)、コンテナターミナルコード(***countainerTerminalCode***)を指定します。 取引内に1つしか作成できない帳票と取引内にコンテナ単位で1つしか作成できない帳票については、取引内に既存の場合は自動的に既存の帳票に紐づく形でタスクが作成されます。 ### メッセージ 業務開始時に付与するメッセージ("***message***)を指定することができます。メッセージは帳票およびタスク作成時のメッセージとなります。 |
|
DELETE | /API/v1/Deals/UnplanBusinessProcess/{dealNo}/{businessProcessId} |
業務プロセス(予定)を削除します。 ## 概要 取引管理番号(***dealNo***)と業務プロセスID(***businessProcessId***)を指定して、業務プロセス(予定)を削除します。 ステータスがNewである業務プロセスに対してのみ有効となります。 ## 指定するパラメタについて ### 取引管理番号 対象の業務プロセスが存在する取引の取引管理番号(***dealNo***)を指定します。 ### 業務プロセスID 対象の業務プロセスID(***businessProcessId***)を指定します。 |
|
POST | /API/v1/Deals/UpdateBusinessProcess |
業務プロセスを更新します。 ## 概要 業務プロセスを更新します。 ## 指定するパラメタについて ### 業務プロセスID 更新する業務プロセスのID(***businessProcessId***)を指定します ### 業務プロセス名 更新後の業務プロセス名(***businessProcessName***)を指定します。 ### ステータス 更新後のステータス(***status***)を指定します。 |
|
POST | /API/v1/Deals/UpdateBusinessProcessDisplayOrder |
業務プロセスの表示順を更新します。 ## 概要 業務プロセスの取引内でのカテゴリ単位の表示順を更新します。 ## 指定するパラメタについて ### 業務プロセスID 更新する業務プロセスのID(***businessProcessId***)を指定します ### 取引管理番号 業務プロセスの表示順を更新する取引の取引管理番号(***dealNo***)を指定します。 ### 表示順 更新後の表示順(***displayOrder***)を指定します。 |
DealSearchConditions
取引検索条件
API | Description | ||
---|---|---|---|
DELETE | /API/v1/DealSearchConditions/Delete/{searchConditionId} |
取引検索条件IDを指定して、保存した検索条件を削除します。 ## 概要 取引検索条件ID(***searchConditionId***)を指定して、ユーザが保存した検索条件を削除します。 ## 指定するパラメタについて ### 取引検索条件ID 保存した検索条件につけられた取引検索条件ID(***searchConditionId***)を指定します。 |
|
GET | /API/v1/DealSearchConditions/Get/{searchConditionId} |
取引検索条件IDを指定して、保存した検索条件を取得します。 ## 概要 取引検索条件ID(***searchConditionId***)を指定して、ユーザが保存した検索条件を取得します。 ## 指定するパラメタについて ### 取引検索条件ID 保存した検索条件につけられた取引検索条件ID(***searchConditionId***)を指定します。 |
|
GET | /API/v1/DealSearchConditions/GetList |
取引検索条件に該当する取引を全て取得します。 |
|
GET | /API/v1/DealSearchConditions/GetList?filter={filter}&orderby={orderby}&top={top} |
検索条件を指定して、条件に該当する保存された検索条件を全て取得します。 ※ただし、検索できる保存された検索条件は、その利用者が作成したものとなります。 ## 概要 検索条件を指定して、条件に該当する保存された検索条件を全て取得します。 検索条件の指定方法については、[こちらを参照ください](https://docs.microsoft.com/ja-jp/graph/query-parameters#filter-parameter)。 |
|
POST | /API/v1/DealSearchConditions/Register |
取引を検索する条件を検索ショートカットとして保存します。 ## 概要 取引を検索する条件を検索ショートカットとして保存します。 保存した取引を検索する条件には、取引検索条件ID(***searchConditionId***)がつけられます。 この取引検索条件ID(***searchConditionId***)を、取引の検索API(***/API/v1/Deals/GetList***)に指定することで、保存した条件での取引の検索が実施できます。 |
|
POST | /API/v1/DealSearchConditions/UpdateDisplayOrder |
取引の検索条件(ショートカット)の表示順を更新します。 ## 概要 取引の検索条件(ショートカット)の表示順を更新します。 ## 指定するパラメタについて ### 取引検索条件ID 更新する取引の検索条件(ショートカット)のID(***searchConditionId***)を指定します ### 表示順 更新後の表示順(***displayOrder***)を指定します。 |
DeclarationAttachmentCorrectionCalls
MSY
API | Description | ||
---|---|---|---|
POST | /API/v1/NaccsReport/DeclarationAttachmentCorrectionCalls/Create |
帳票:MSYを作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 帳票:MSYが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/DeclarationAttachmentCorrectionCalls/CreateByBlNo |
B/L番号を指定して、帳票:MSYを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定されたB/L番号(***blNo***)に該当する取引に対して、帳票:MSYを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定されたB/L番号(***blNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:MSYが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/DeclarationAttachmentCorrectionCalls/CreateByBookingNo |
ブッキング番号を指定して、帳票:MSYを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:MSYを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:MSYが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/DeclarationAttachmentCorrectionCalls/CreateByDomesticNo |
社内管理番号を指定して、帳票:MSYを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:MSYを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:MSYが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/NaccsReport/DeclarationAttachmentCorrectionCalls/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:MSYを削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/NaccsReport/DeclarationAttachmentCorrectionCalls/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
B/L番号を指定して、帳票:MSYを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、帳票:MSYを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/DeclarationAttachmentCorrectionCalls/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId} |
ブッキング番号を指定して、帳票:MSYを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:MSYを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/DeclarationAttachmentCorrectionCalls/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
取引管理番号を指定して、帳票:MSYを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:MSYを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/DeclarationAttachmentCorrectionCalls/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
社内管理番号を指定して、帳票:MSYを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:MSYを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/NaccsReport/DeclarationAttachmentCorrectionCalls/Get/{dealReportId} |
帳票:MSYを取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/NaccsReport/DeclarationAttachmentCorrectionCalls/GetByDealNo/{dealNo} |
取引管理番号を指定して、帳票:MSYを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:MSYを取得します。 |
|
GET | /API/v1/NaccsReport/DeclarationAttachmentCorrectionCalls/GetListByBlNo/{blNo} |
B/L番号を指定して、帳票:MSYを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、MSYを取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が付番されている全ての取引から、帳票:MSYを取得します。 |
|
GET | /API/v1/NaccsReport/DeclarationAttachmentCorrectionCalls/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo} |
ブッキング番号を指定して、帳票:MSYを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:MSYを取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が付番されている全ての取引から、帳票:MSYを取得します。 |
|
GET | /API/v1/NaccsReport/DeclarationAttachmentCorrectionCalls/GetListByDomesticNo/{domesticNo} |
社内管理番号を指定して、帳票:MSYを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:MSYを取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:MSYを取得します。 |
|
POST | /API/v1/NaccsReport/DeclarationAttachmentCorrectionCalls/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/DeclarationAttachmentCorrectionCalls/Register |
帳票:MSYを保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
DeclarationAttachmentCorrections
MSY01
API | Description | ||
---|---|---|---|
POST | /API/v1/NaccsReport/DeclarationAttachmentCorrections/Create |
帳票:MSY01を作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 帳票:MSY01が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/DeclarationAttachmentCorrections/CreateByBlNo |
B/L番号を指定して、帳票:MSY01を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定されたB/L番号(***blNo***)に該当する取引に対して、帳票:MSY01を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定されたB/L番号(***blNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:MSY01が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/DeclarationAttachmentCorrections/CreateByBookingNo |
ブッキング番号を指定して、帳票:MSY01を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:MSY01を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:MSY01が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/DeclarationAttachmentCorrections/CreateByDomesticNo |
社内管理番号を指定して、帳票:MSY01を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:MSY01を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:MSY01が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/NaccsReport/DeclarationAttachmentCorrections/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:MSY01を削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/NaccsReport/DeclarationAttachmentCorrections/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
B/L番号を指定して、帳票:MSY01を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、帳票:MSY01を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/DeclarationAttachmentCorrections/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId} |
ブッキング番号を指定して、帳票:MSY01を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:MSY01を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/DeclarationAttachmentCorrections/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
取引管理番号を指定して、帳票:MSY01を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:MSY01を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/DeclarationAttachmentCorrections/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
社内管理番号を指定して、帳票:MSY01を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:MSY01を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/NaccsReport/DeclarationAttachmentCorrections/Get/{dealReportId} |
帳票:MSY01を取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/NaccsReport/DeclarationAttachmentCorrections/GetByDealNo/{dealNo} |
取引管理番号を指定して、帳票:MSY01を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:MSY01を取得します。 |
|
GET | /API/v1/NaccsReport/DeclarationAttachmentCorrections/GetListByBlNo/{blNo} |
B/L番号を指定して、帳票:MSY01を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、MSY01を取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が付番されている全ての取引から、帳票:MSY01を取得します。 |
|
GET | /API/v1/NaccsReport/DeclarationAttachmentCorrections/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo} |
ブッキング番号を指定して、帳票:MSY01を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:MSY01を取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が付番されている全ての取引から、帳票:MSY01を取得します。 |
|
GET | /API/v1/NaccsReport/DeclarationAttachmentCorrections/GetListByDomesticNo/{domesticNo} |
社内管理番号を指定して、帳票:MSY01を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:MSY01を取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:MSY01を取得します。 |
|
POST | /API/v1/NaccsReport/DeclarationAttachmentCorrections/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/DeclarationAttachmentCorrections/Register |
帳票:MSY01を保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
DeclarationAttachmentListInquiries
IMS
API | Description | ||
---|---|---|---|
POST | /API/v1/NaccsReport/DeclarationAttachmentListInquiries/Create |
帳票:IMSを作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 帳票:IMSが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/DeclarationAttachmentListInquiries/CreateByBlNo |
B/L番号を指定して、帳票:IMSを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定されたB/L番号(***blNo***)に該当する取引に対して、帳票:IMSを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定されたB/L番号(***blNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:IMSが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/DeclarationAttachmentListInquiries/CreateByBookingNo |
ブッキング番号を指定して、帳票:IMSを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:IMSを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:IMSが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/DeclarationAttachmentListInquiries/CreateByDomesticNo |
社内管理番号を指定して、帳票:IMSを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:IMSを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:IMSが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/NaccsReport/DeclarationAttachmentListInquiries/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:IMSを削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/NaccsReport/DeclarationAttachmentListInquiries/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
B/L番号を指定して、帳票:IMSを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、帳票:IMSを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/DeclarationAttachmentListInquiries/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId} |
ブッキング番号を指定して、帳票:IMSを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:IMSを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/DeclarationAttachmentListInquiries/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
取引管理番号を指定して、帳票:IMSを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:IMSを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/DeclarationAttachmentListInquiries/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
社内管理番号を指定して、帳票:IMSを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:IMSを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/NaccsReport/DeclarationAttachmentListInquiries/Get/{dealReportId} |
帳票:IMSを取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/NaccsReport/DeclarationAttachmentListInquiries/GetByDealNo/{dealNo} |
取引管理番号を指定して、帳票:IMSを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:IMSを取得します。 |
|
GET | /API/v1/NaccsReport/DeclarationAttachmentListInquiries/GetListByBlNo/{blNo} |
B/L番号を指定して、帳票:IMSを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、IMSを取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が付番されている全ての取引から、帳票:IMSを取得します。 |
|
GET | /API/v1/NaccsReport/DeclarationAttachmentListInquiries/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo} |
ブッキング番号を指定して、帳票:IMSを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:IMSを取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が付番されている全ての取引から、帳票:IMSを取得します。 |
|
GET | /API/v1/NaccsReport/DeclarationAttachmentListInquiries/GetListByDomesticNo/{domesticNo} |
社内管理番号を指定して、帳票:IMSを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:IMSを取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:IMSを取得します。 |
|
POST | /API/v1/NaccsReport/DeclarationAttachmentListInquiries/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/DeclarationAttachmentListInquiries/Register |
帳票:IMSを保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
DeclarationAttachmentRegistrations
MSX
API | Description | ||
---|---|---|---|
POST | /API/v1/NaccsReport/DeclarationAttachmentRegistrations/Create |
帳票:MSXを作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 帳票:MSXが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/DeclarationAttachmentRegistrations/CreateByBlNo |
B/L番号を指定して、帳票:MSXを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定されたB/L番号(***blNo***)に該当する取引に対して、帳票:MSXを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定されたB/L番号(***blNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:MSXが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/DeclarationAttachmentRegistrations/CreateByBookingNo |
ブッキング番号を指定して、帳票:MSXを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:MSXを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:MSXが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/DeclarationAttachmentRegistrations/CreateByDomesticNo |
社内管理番号を指定して、帳票:MSXを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:MSXを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:MSXが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/NaccsReport/DeclarationAttachmentRegistrations/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:MSXを削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/NaccsReport/DeclarationAttachmentRegistrations/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
B/L番号を指定して、帳票:MSXを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、帳票:MSXを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/DeclarationAttachmentRegistrations/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId} |
ブッキング番号を指定して、帳票:MSXを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:MSXを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/DeclarationAttachmentRegistrations/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
取引管理番号を指定して、帳票:MSXを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:MSXを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/DeclarationAttachmentRegistrations/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
社内管理番号を指定して、帳票:MSXを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:MSXを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/NaccsReport/DeclarationAttachmentRegistrations/Get/{dealReportId} |
帳票:MSXを取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/NaccsReport/DeclarationAttachmentRegistrations/GetByDealNo/{dealNo} |
取引管理番号を指定して、帳票:MSXを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:MSXを取得します。 |
|
GET | /API/v1/NaccsReport/DeclarationAttachmentRegistrations/GetListByBlNo/{blNo} |
B/L番号を指定して、帳票:MSXを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、MSXを取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が付番されている全ての取引から、帳票:MSXを取得します。 |
|
GET | /API/v1/NaccsReport/DeclarationAttachmentRegistrations/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo} |
ブッキング番号を指定して、帳票:MSXを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:MSXを取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が付番されている全ての取引から、帳票:MSXを取得します。 |
|
GET | /API/v1/NaccsReport/DeclarationAttachmentRegistrations/GetListByDomesticNo/{domesticNo} |
社内管理番号を指定して、帳票:MSXを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:MSXを取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:MSXを取得します。 |
|
POST | /API/v1/NaccsReport/DeclarationAttachmentRegistrations/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/DeclarationAttachmentRegistrations/Register |
帳票:MSXを保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
DeliveryDocuments
貨物輸送送り状
API | Description | ||
---|---|---|---|
POST | /API/v1/Report/DeliveryDocuments/Create |
帳票:貨物輸送送り状を作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 |
|
POST | /API/v1/Report/DeliveryDocuments/CreateAttachFileMeta |
添付ファイルメタ情報を登録します。 |
|
POST | /API/v1/Report/DeliveryDocuments/CreateByBlNo |
B/L番号を指定して、帳票:貨物輸送送り状を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定されたB/L番号(***blNo***)に該当する取引に対して、帳票:貨物輸送送り状を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定されたB/L番号(***blNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 カスタムID(***customId***)は作成数に制限がない帳票を特定できるように任意に設定できる項目です。 カスタムID(***customId***)に値が設定されていなくても帳票:貨物輸送送り状は作成可能です。同じカスタムID(***customId***)の帳票:貨物輸送送り状が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/Report/DeliveryDocuments/CreateByBookingNo |
ブッキング番号を指定して、帳票:貨物輸送送り状を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:貨物輸送送り状を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 カスタムID(***customId***)は作成数に制限がない帳票を特定できるように任意に設定できる項目です。 カスタムID(***customId***)に値が設定されていなくても帳票:貨物輸送送り状は作成可能です。同じカスタムID(***customId***)の帳票:貨物輸送送り状が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/Report/DeliveryDocuments/CreateByDomesticNo |
社内管理番号を指定して、帳票:貨物輸送送り状を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:貨物輸送送り状を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 カスタムID(***customId***)は作成数に制限がない帳票を特定できるように任意に設定できる項目です。 カスタムID(***customId***)に値が設定されていなくても帳票:貨物輸送送り状は作成可能です。同じカスタムID(***customId***)の帳票:貨物輸送送り状が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/Report/DeliveryDocuments/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:貨物輸送送り状を削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/Report/DeliveryDocuments/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId}&customId={customId} |
B/L番号を指定して、帳票:貨物輸送送り状を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、帳票:貨物輸送送り状を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/Report/DeliveryDocuments/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId}&customId={customId} |
ブッキング番号を指定して、帳票:貨物輸送送り状を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:貨物輸送送り状を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/Report/DeliveryDocuments/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId}&customId={customId} |
取引管理番号を指定して、帳票:貨物輸送送り状を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:貨物輸送送り状を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/Report/DeliveryDocuments/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId}&customId={customId} |
社内管理番号を指定して、帳票:貨物輸送送り状を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:貨物輸送送り状を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/Report/DeliveryDocuments/Get/{dealReportId} |
帳票:貨物輸送送り状を取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/Report/DeliveryDocuments/GetAttachFileMetaList/{dealReportId} |
添付ファイル情報一覧を取得します。 |
|
GET | /API/v1/Report/DeliveryDocuments/GetListByBlNo/{blNo}?customId={customId} |
B/L番号を指定して、帳票:貨物輸送送り状を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、貨物輸送送り状を取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が付番されている全ての取引から、帳票:貨物輸送送り状を取得します。 |
|
GET | /API/v1/Report/DeliveryDocuments/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&customId={customId} |
ブッキング番号を指定して、帳票:貨物輸送送り状を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:貨物輸送送り状を取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が付番されている全ての取引から、帳票:貨物輸送送り状を取得します。 |
|
GET | /API/v1/Report/DeliveryDocuments/GetListByDealNo/{dealNo} |
取引管理番号を指定して、帳票:貨物輸送送り状を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:貨物輸送送り状を取得します。 |
|
GET | /API/v1/Report/DeliveryDocuments/GetListByDomesticNo/{domesticNo}?customId={customId} |
社内管理番号を指定して、帳票:貨物輸送送り状を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:貨物輸送送り状を取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:貨物輸送送り状を取得します。 |
|
POST | /API/v1/Report/DeliveryDocuments/Register |
帳票:貨物輸送送り状を保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
DeliveryInstructions
運送依頼書
API | Description | ||
---|---|---|---|
POST | /API/v1/Report/DeliveryInstructions/Create |
帳票:運送依頼書を作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 |
|
POST | /API/v1/Report/DeliveryInstructions/CreateAttachFileMeta |
添付ファイルメタ情報を登録します。 |
|
POST | /API/v1/Report/DeliveryInstructions/CreateByBlNo |
B/L番号を指定して、帳票:運送依頼書を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定されたB/L番号(***blNo***)に該当する取引に対して、帳票:運送依頼書を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定されたB/L番号(***blNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 カスタムID(***customId***)は作成数に制限がない帳票を特定できるように任意に設定できる項目です。 カスタムID(***customId***)に値が設定されていなくても帳票:運送依頼書は作成可能です。同じカスタムID(***customId***)の帳票:運送依頼書が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/Report/DeliveryInstructions/CreateByBookingNo |
ブッキング番号を指定して、帳票:運送依頼書を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:運送依頼書を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 カスタムID(***customId***)は作成数に制限がない帳票を特定できるように任意に設定できる項目です。 カスタムID(***customId***)に値が設定されていなくても帳票:運送依頼書は作成可能です。同じカスタムID(***customId***)の帳票:運送依頼書が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/Report/DeliveryInstructions/CreateByDomesticNo |
社内管理番号を指定して、帳票:運送依頼書を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:運送依頼書を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 カスタムID(***customId***)は作成数に制限がない帳票を特定できるように任意に設定できる項目です。 カスタムID(***customId***)に値が設定されていなくても帳票:運送依頼書は作成可能です。同じカスタムID(***customId***)の帳票:運送依頼書が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/Report/DeliveryInstructions/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:運送依頼書を削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/Report/DeliveryInstructions/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId}&customId={customId} |
B/L番号を指定して、帳票:運送依頼書を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、帳票:運送依頼書を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/Report/DeliveryInstructions/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId}&customId={customId} |
ブッキング番号を指定して、帳票:運送依頼書を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:運送依頼書を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/Report/DeliveryInstructions/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId}&customId={customId} |
取引管理番号を指定して、帳票:運送依頼書を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:運送依頼書を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/Report/DeliveryInstructions/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId}&customId={customId} |
社内管理番号を指定して、帳票:運送依頼書を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:運送依頼書を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/Report/DeliveryInstructions/Get/{dealReportId} |
帳票:運送依頼書を取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/Report/DeliveryInstructions/GetAttachFileMetaList/{dealReportId} |
添付ファイル情報一覧を取得します。 |
|
GET | /API/v1/Report/DeliveryInstructions/GetListByBlNo/{blNo}?customId={customId} |
B/L番号を指定して、帳票:運送依頼書を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、運送依頼書を取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が付番されている全ての取引から、帳票:運送依頼書を取得します。 |
|
GET | /API/v1/Report/DeliveryInstructions/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&customId={customId} |
ブッキング番号を指定して、帳票:運送依頼書を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:運送依頼書を取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が付番されている全ての取引から、帳票:運送依頼書を取得します。 |
|
GET | /API/v1/Report/DeliveryInstructions/GetListByDealNo/{dealNo} |
取引管理番号を指定して、帳票:運送依頼書を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:運送依頼書を取得します。 |
|
GET | /API/v1/Report/DeliveryInstructions/GetListByDomesticNo/{domesticNo}?customId={customId} |
社内管理番号を指定して、帳票:運送依頼書を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:運送依頼書を取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:運送依頼書を取得します。 |
|
POST | /API/v1/Report/DeliveryInstructions/Register |
帳票:運送依頼書を保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
DeliveryNotes
納品書
API | Description | ||
---|---|---|---|
POST | /API/v1/Report/DeliveryNotes/Create |
帳票:納品書を作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 |
|
POST | /API/v1/Report/DeliveryNotes/CreateAttachFileMeta |
添付ファイルメタ情報を登録します。 |
|
POST | /API/v1/Report/DeliveryNotes/CreateByBlNo |
B/L番号を指定して、帳票:納品書を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定されたB/L番号(***blNo***)に該当する取引に対して、帳票:納品書を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定されたB/L番号(***blNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 カスタムID(***customId***)は作成数に制限がない帳票を特定できるように任意に設定できる項目です。 カスタムID(***customId***)に値が設定されていなくても帳票:納品書は作成可能です。同じカスタムID(***customId***)の帳票:納品書が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/Report/DeliveryNotes/CreateByBookingNo |
ブッキング番号を指定して、帳票:納品書を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:納品書を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 カスタムID(***customId***)は作成数に制限がない帳票を特定できるように任意に設定できる項目です。 カスタムID(***customId***)に値が設定されていなくても帳票:納品書は作成可能です。同じカスタムID(***customId***)の帳票:納品書が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/Report/DeliveryNotes/CreateByDomesticNo |
社内管理番号を指定して、帳票:納品書を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:納品書を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 カスタムID(***customId***)は作成数に制限がない帳票を特定できるように任意に設定できる項目です。 カスタムID(***customId***)に値が設定されていなくても帳票:納品書は作成可能です。同じカスタムID(***customId***)の帳票:納品書が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/Report/DeliveryNotes/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:納品書を削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/Report/DeliveryNotes/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId}&customId={customId} |
B/L番号を指定して、帳票:納品書を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、帳票:納品書を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/Report/DeliveryNotes/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId}&customId={customId} |
ブッキング番号を指定して、帳票:納品書を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:納品書を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/Report/DeliveryNotes/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId}&customId={customId} |
取引管理番号を指定して、帳票:納品書を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:納品書を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/Report/DeliveryNotes/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId}&customId={customId} |
社内管理番号を指定して、帳票:納品書を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:納品書を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/Report/DeliveryNotes/Get/{dealReportId} |
帳票:納品書を取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/Report/DeliveryNotes/GetAttachFileMetaList/{dealReportId} |
添付ファイル情報一覧を取得します。 |
|
GET | /API/v1/Report/DeliveryNotes/GetListByBlNo/{blNo}?customId={customId} |
B/L番号を指定して、帳票:納品書を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、納品書を取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が付番されている全ての取引から、帳票:納品書を取得します。 |
|
GET | /API/v1/Report/DeliveryNotes/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&customId={customId} |
ブッキング番号を指定して、帳票:納品書を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:納品書を取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が付番されている全ての取引から、帳票:納品書を取得します。 |
|
GET | /API/v1/Report/DeliveryNotes/GetListByDealNo/{dealNo} |
取引管理番号を指定して、帳票:納品書を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:納品書を取得します。 |
|
GET | /API/v1/Report/DeliveryNotes/GetListByDomesticNo/{domesticNo}?customId={customId} |
社内管理番号を指定して、帳票:納品書を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:納品書を取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:納品書を取得します。 |
|
POST | /API/v1/Report/DeliveryNotes/Register |
帳票:納品書を保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
DeliveryOrderLessRequests
荷渡指図書レス申込書
API | Description | ||
---|---|---|---|
POST | /API/v1/Report/DeliveryOrderLessRequests/Create |
帳票:荷渡指図書レス申込書を作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 帳票:荷渡指図書レス申込書が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/Report/DeliveryOrderLessRequests/CreateAttachFileMeta |
添付ファイルメタ情報を登録します。 |
|
POST | /API/v1/Report/DeliveryOrderLessRequests/CreateByBlNo |
B/L番号を指定して、帳票:荷渡指図書レス申込書を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定されたB/L番号(***blNo***)に該当する取引に対して、帳票:荷渡指図書レス申込書を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定されたB/L番号(***blNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:荷渡指図書レス申込書が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/Report/DeliveryOrderLessRequests/CreateByBookingNo |
ブッキング番号を指定して、帳票:荷渡指図書レス申込書を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:荷渡指図書レス申込書を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:荷渡指図書レス申込書が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/Report/DeliveryOrderLessRequests/CreateByDomesticNo |
社内管理番号を指定して、帳票:荷渡指図書レス申込書を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:荷渡指図書レス申込書を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:荷渡指図書レス申込書が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/Report/DeliveryOrderLessRequests/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:荷渡指図書レス申込書を削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/Report/DeliveryOrderLessRequests/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
B/L番号を指定して、帳票:荷渡指図書レス申込書を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、帳票:荷渡指図書レス申込書を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/Report/DeliveryOrderLessRequests/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId} |
ブッキング番号を指定して、帳票:荷渡指図書レス申込書を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:荷渡指図書レス申込書を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/Report/DeliveryOrderLessRequests/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
取引管理番号を指定して、帳票:荷渡指図書レス申込書を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:荷渡指図書レス申込書を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/Report/DeliveryOrderLessRequests/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
社内管理番号を指定して、帳票:荷渡指図書レス申込書を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:荷渡指図書レス申込書を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/Report/DeliveryOrderLessRequests/Get/{dealReportId} |
帳票:荷渡指図書レス申込書を取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/Report/DeliveryOrderLessRequests/GetAttachFileMetaList/{dealReportId} |
添付ファイル情報一覧を取得します。 |
|
GET | /API/v1/Report/DeliveryOrderLessRequests/GetByDealNo/{dealNo} |
取引管理番号を指定して、帳票:荷渡指図書レス申込書を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:荷渡指図書レス申込書を取得します。 |
|
GET | /API/v1/Report/DeliveryOrderLessRequests/GetListByBlNo/{blNo} |
B/L番号を指定して、帳票:荷渡指図書レス申込書を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、荷渡指図書レス申込書を取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が付番されている全ての取引から、帳票:荷渡指図書レス申込書を取得します。 |
|
GET | /API/v1/Report/DeliveryOrderLessRequests/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo} |
ブッキング番号を指定して、帳票:荷渡指図書レス申込書を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:荷渡指図書レス申込書を取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が付番されている全ての取引から、帳票:荷渡指図書レス申込書を取得します。 |
|
GET | /API/v1/Report/DeliveryOrderLessRequests/GetListByDomesticNo/{domesticNo} |
社内管理番号を指定して、帳票:荷渡指図書レス申込書を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:荷渡指図書レス申込書を取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:荷渡指図書レス申込書を取得します。 |
|
POST | /API/v1/Report/DeliveryOrderLessRequests/Register |
帳票:荷渡指図書レス申込書を保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
DeliveryOrders
荷渡指図書
API | Description | ||
---|---|---|---|
POST | /API/v1/Report/DeliveryOrders/Create |
帳票:荷渡指図書を作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 帳票:荷渡指図書が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/Report/DeliveryOrders/CreateAttachFileMeta |
添付ファイルメタ情報を登録します。 |
|
POST | /API/v1/Report/DeliveryOrders/CreateByBlNo |
B/L番号を指定して、帳票:荷渡指図書を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定されたB/L番号(***blNo***)に該当する取引に対して、帳票:荷渡指図書を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定されたB/L番号(***blNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:荷渡指図書が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/Report/DeliveryOrders/CreateByBookingNo |
ブッキング番号を指定して、帳票:荷渡指図書を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:荷渡指図書を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:荷渡指図書が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/Report/DeliveryOrders/CreateByDomesticNo |
社内管理番号を指定して、帳票:荷渡指図書を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:荷渡指図書を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:荷渡指図書が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/Report/DeliveryOrders/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:荷渡指図書を削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/Report/DeliveryOrders/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
B/L番号を指定して、帳票:荷渡指図書を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、帳票:荷渡指図書を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/Report/DeliveryOrders/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId} |
ブッキング番号を指定して、帳票:荷渡指図書を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:荷渡指図書を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/Report/DeliveryOrders/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
取引管理番号を指定して、帳票:荷渡指図書を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:荷渡指図書を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/Report/DeliveryOrders/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
社内管理番号を指定して、帳票:荷渡指図書を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:荷渡指図書を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/Report/DeliveryOrders/Get/{dealReportId} |
帳票:荷渡指図書を取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/Report/DeliveryOrders/GetAttachFileMetaList/{dealReportId} |
添付ファイル情報一覧を取得します。 |
|
GET | /API/v1/Report/DeliveryOrders/GetByDealNo/{dealNo} |
取引管理番号を指定して、帳票:荷渡指図書を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:荷渡指図書を取得します。 |
|
GET | /API/v1/Report/DeliveryOrders/GetListByBlNo/{blNo} |
B/L番号を指定して、帳票:荷渡指図書を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、荷渡指図書を取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が付番されている全ての取引から、帳票:荷渡指図書を取得します。 |
|
GET | /API/v1/Report/DeliveryOrders/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo} |
ブッキング番号を指定して、帳票:荷渡指図書を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:荷渡指図書を取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が付番されている全ての取引から、帳票:荷渡指図書を取得します。 |
|
GET | /API/v1/Report/DeliveryOrders/GetListByDomesticNo/{domesticNo} |
社内管理番号を指定して、帳票:荷渡指図書を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:荷渡指図書を取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:荷渡指図書を取得します。 |
|
POST | /API/v1/Report/DeliveryOrders/Register |
帳票:荷渡指図書を保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
DepartureDeclarationListInquiries
IES
API | Description | ||
---|---|---|---|
POST | /API/v1/NaccsReport/DepartureDeclarationListInquiries/Create |
帳票:IESを作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 帳票:IESが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/DepartureDeclarationListInquiries/CreateByBlNo |
B/L番号を指定して、帳票:IESを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定されたB/L番号(***blNo***)に該当する取引に対して、帳票:IESを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定されたB/L番号(***blNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:IESが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/DepartureDeclarationListInquiries/CreateByBookingNo |
ブッキング番号を指定して、帳票:IESを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:IESを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:IESが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/DepartureDeclarationListInquiries/CreateByDomesticNo |
社内管理番号を指定して、帳票:IESを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:IESを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:IESが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/NaccsReport/DepartureDeclarationListInquiries/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:IESを削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/NaccsReport/DepartureDeclarationListInquiries/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
B/L番号を指定して、帳票:IESを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、帳票:IESを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/DepartureDeclarationListInquiries/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId} |
ブッキング番号を指定して、帳票:IESを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:IESを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/DepartureDeclarationListInquiries/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
取引管理番号を指定して、帳票:IESを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:IESを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/DepartureDeclarationListInquiries/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
社内管理番号を指定して、帳票:IESを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:IESを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/NaccsReport/DepartureDeclarationListInquiries/Get/{dealReportId} |
帳票:IESを取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/NaccsReport/DepartureDeclarationListInquiries/GetByDealNo/{dealNo} |
取引管理番号を指定して、帳票:IESを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:IESを取得します。 |
|
GET | /API/v1/NaccsReport/DepartureDeclarationListInquiries/GetListByBlNo/{blNo} |
B/L番号を指定して、帳票:IESを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、IESを取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が付番されている全ての取引から、帳票:IESを取得します。 |
|
GET | /API/v1/NaccsReport/DepartureDeclarationListInquiries/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo} |
ブッキング番号を指定して、帳票:IESを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:IESを取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が付番されている全ての取引から、帳票:IESを取得します。 |
|
GET | /API/v1/NaccsReport/DepartureDeclarationListInquiries/GetListByDomesticNo/{domesticNo} |
社内管理番号を指定して、帳票:IESを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:IESを取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:IESを取得します。 |
|
POST | /API/v1/NaccsReport/DepartureDeclarationListInquiries/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/DepartureDeclarationListInquiries/Register |
帳票:IESを保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
DispatchConfirmRegistrationCargoPickUps
BOB
API | Description | ||
---|---|---|---|
POST | /API/v1/NaccsReport/DispatchConfirmRegistrationCargoPickUps/Create |
帳票:BOBを作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 |
|
POST | /API/v1/NaccsReport/DispatchConfirmRegistrationCargoPickUps/CreateByBlNo |
B/L番号を指定して、帳票:BOBを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定されたB/L番号(***blNo***)に該当する取引に対して、帳票:BOBを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定されたB/L番号(***blNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 カスタムID(***customId***)は作成数に制限がない帳票を特定できるように任意に設定できる項目です。 カスタムID(***customId***)に値が設定されていなくても帳票:BOBは作成可能です。同じカスタムID(***customId***)の帳票:BOBが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/DispatchConfirmRegistrationCargoPickUps/CreateByBookingNo |
ブッキング番号を指定して、帳票:BOBを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:BOBを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 カスタムID(***customId***)は作成数に制限がない帳票を特定できるように任意に設定できる項目です。 カスタムID(***customId***)に値が設定されていなくても帳票:BOBは作成可能です。同じカスタムID(***customId***)の帳票:BOBが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/DispatchConfirmRegistrationCargoPickUps/CreateByDomesticNo |
社内管理番号を指定して、帳票:BOBを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:BOBを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 カスタムID(***customId***)は作成数に制限がない帳票を特定できるように任意に設定できる項目です。 カスタムID(***customId***)に値が設定されていなくても帳票:BOBは作成可能です。同じカスタムID(***customId***)の帳票:BOBが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/NaccsReport/DispatchConfirmRegistrationCargoPickUps/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:BOBを削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/NaccsReport/DispatchConfirmRegistrationCargoPickUps/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId}&customId={customId} |
B/L番号を指定して、帳票:BOBを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、帳票:BOBを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/DispatchConfirmRegistrationCargoPickUps/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId}&customId={customId} |
ブッキング番号を指定して、帳票:BOBを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:BOBを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/DispatchConfirmRegistrationCargoPickUps/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId}&customId={customId} |
取引管理番号を指定して、帳票:BOBを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:BOBを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/DispatchConfirmRegistrationCargoPickUps/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId}&customId={customId} |
社内管理番号を指定して、帳票:BOBを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:BOBを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/NaccsReport/DispatchConfirmRegistrationCargoPickUps/Get/{dealReportId} |
帳票:BOBを取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/NaccsReport/DispatchConfirmRegistrationCargoPickUps/GetListByBlNo/{blNo}?customId={customId} |
B/L番号を指定して、帳票:BOBを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、BOBを取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が付番されている全ての取引から、帳票:BOBを取得します。 |
|
GET | /API/v1/NaccsReport/DispatchConfirmRegistrationCargoPickUps/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&customId={customId} |
ブッキング番号を指定して、帳票:BOBを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:BOBを取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が付番されている全ての取引から、帳票:BOBを取得します。 |
|
GET | /API/v1/NaccsReport/DispatchConfirmRegistrationCargoPickUps/GetListByDealNo/{dealNo} |
取引管理番号を指定して、帳票:BOBを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:BOBを取得します。 |
|
GET | /API/v1/NaccsReport/DispatchConfirmRegistrationCargoPickUps/GetListByDomesticNo/{domesticNo}?customId={customId} |
社内管理番号を指定して、帳票:BOBを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:BOBを取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:BOBを取得します。 |
|
POST | /API/v1/NaccsReport/DispatchConfirmRegistrationCargoPickUps/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/DispatchConfirmRegistrationCargoPickUps/Register |
帳票:BOBを保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
DispatchConfirmRegistrationCustomsTransportCargoes
BOA
API | Description | ||
---|---|---|---|
POST | /API/v1/NaccsReport/DispatchConfirmRegistrationCustomsTransportCargoes/Create |
帳票:BOAを作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 帳票:BOAが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/DispatchConfirmRegistrationCustomsTransportCargoes/CreateByBlNo |
B/L番号を指定して、帳票:BOAを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定されたB/L番号(***blNo***)に該当する取引に対して、帳票:BOAを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定されたB/L番号(***blNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:BOAが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/DispatchConfirmRegistrationCustomsTransportCargoes/CreateByBookingNo |
ブッキング番号を指定して、帳票:BOAを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:BOAを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:BOAが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/DispatchConfirmRegistrationCustomsTransportCargoes/CreateByDomesticNo |
社内管理番号を指定して、帳票:BOAを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:BOAを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:BOAが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/NaccsReport/DispatchConfirmRegistrationCustomsTransportCargoes/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:BOAを削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/NaccsReport/DispatchConfirmRegistrationCustomsTransportCargoes/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
B/L番号を指定して、帳票:BOAを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、帳票:BOAを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/DispatchConfirmRegistrationCustomsTransportCargoes/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId} |
ブッキング番号を指定して、帳票:BOAを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:BOAを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/DispatchConfirmRegistrationCustomsTransportCargoes/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
取引管理番号を指定して、帳票:BOAを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:BOAを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/DispatchConfirmRegistrationCustomsTransportCargoes/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
社内管理番号を指定して、帳票:BOAを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:BOAを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/NaccsReport/DispatchConfirmRegistrationCustomsTransportCargoes/Get/{dealReportId} |
帳票:BOAを取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/NaccsReport/DispatchConfirmRegistrationCustomsTransportCargoes/GetByDealNo/{dealNo} |
取引管理番号を指定して、帳票:BOAを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:BOAを取得します。 |
|
GET | /API/v1/NaccsReport/DispatchConfirmRegistrationCustomsTransportCargoes/GetListByBlNo/{blNo} |
B/L番号を指定して、帳票:BOAを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、BOAを取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が付番されている全ての取引から、帳票:BOAを取得します。 |
|
GET | /API/v1/NaccsReport/DispatchConfirmRegistrationCustomsTransportCargoes/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo} |
ブッキング番号を指定して、帳票:BOAを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:BOAを取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が付番されている全ての取引から、帳票:BOAを取得します。 |
|
GET | /API/v1/NaccsReport/DispatchConfirmRegistrationCustomsTransportCargoes/GetListByDomesticNo/{domesticNo} |
社内管理番号を指定して、帳票:BOAを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:BOAを取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:BOAを取得します。 |
|
POST | /API/v1/NaccsReport/DispatchConfirmRegistrationCustomsTransportCargoes/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/DispatchConfirmRegistrationCustomsTransportCargoes/Register |
帳票:BOAを保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
DispatchConfirmRegistrationExportPermitteds
BOC
API | Description | ||
---|---|---|---|
POST | /API/v1/NaccsReport/DispatchConfirmRegistrationExportPermitteds/Create |
帳票:BOCを作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 |
|
POST | /API/v1/NaccsReport/DispatchConfirmRegistrationExportPermitteds/CreateByBlNo |
B/L番号を指定して、帳票:BOCを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定されたB/L番号(***blNo***)に該当する取引に対して、帳票:BOCを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定されたB/L番号(***blNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 カスタムID(***customId***)は作成数に制限がない帳票を特定できるように任意に設定できる項目です。 カスタムID(***customId***)に値が設定されていなくても帳票:BOCは作成可能です。同じカスタムID(***customId***)の帳票:BOCが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/DispatchConfirmRegistrationExportPermitteds/CreateByBookingNo |
ブッキング番号を指定して、帳票:BOCを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:BOCを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 カスタムID(***customId***)は作成数に制限がない帳票を特定できるように任意に設定できる項目です。 カスタムID(***customId***)に値が設定されていなくても帳票:BOCは作成可能です。同じカスタムID(***customId***)の帳票:BOCが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/DispatchConfirmRegistrationExportPermitteds/CreateByDomesticNo |
社内管理番号を指定して、帳票:BOCを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:BOCを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 カスタムID(***customId***)は作成数に制限がない帳票を特定できるように任意に設定できる項目です。 カスタムID(***customId***)に値が設定されていなくても帳票:BOCは作成可能です。同じカスタムID(***customId***)の帳票:BOCが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/NaccsReport/DispatchConfirmRegistrationExportPermitteds/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:BOCを削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/NaccsReport/DispatchConfirmRegistrationExportPermitteds/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId}&customId={customId} |
B/L番号を指定して、帳票:BOCを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、帳票:BOCを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/DispatchConfirmRegistrationExportPermitteds/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId}&customId={customId} |
ブッキング番号を指定して、帳票:BOCを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:BOCを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/DispatchConfirmRegistrationExportPermitteds/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId}&customId={customId} |
取引管理番号を指定して、帳票:BOCを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:BOCを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/DispatchConfirmRegistrationExportPermitteds/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId}&customId={customId} |
社内管理番号を指定して、帳票:BOCを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:BOCを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/NaccsReport/DispatchConfirmRegistrationExportPermitteds/Get/{dealReportId} |
帳票:BOCを取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/NaccsReport/DispatchConfirmRegistrationExportPermitteds/GetListByBlNo/{blNo}?customId={customId} |
B/L番号を指定して、帳票:BOCを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、BOCを取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が付番されている全ての取引から、帳票:BOCを取得します。 |
|
GET | /API/v1/NaccsReport/DispatchConfirmRegistrationExportPermitteds/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&customId={customId} |
ブッキング番号を指定して、帳票:BOCを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:BOCを取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が付番されている全ての取引から、帳票:BOCを取得します。 |
|
GET | /API/v1/NaccsReport/DispatchConfirmRegistrationExportPermitteds/GetListByDealNo/{dealNo} |
取引管理番号を指定して、帳票:BOCを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:BOCを取得します。 |
|
GET | /API/v1/NaccsReport/DispatchConfirmRegistrationExportPermitteds/GetListByDomesticNo/{domesticNo}?customId={customId} |
社内管理番号を指定して、帳票:BOCを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:BOCを取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:BOCを取得します。 |
|
POST | /API/v1/NaccsReport/DispatchConfirmRegistrationExportPermitteds/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/DispatchConfirmRegistrationExportPermitteds/Register |
帳票:BOCを保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
DockReceipts
ドックレシート
API | Description | ||
---|---|---|---|
POST | /API/v1/Report/DockReceipts/Create |
帳票:ドックレシートを作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 帳票:ドックレシートが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/Report/DockReceipts/CreateAttachFileMeta |
添付ファイルメタ情報を登録します。 |
|
POST | /API/v1/Report/DockReceipts/CreateByBlNo |
B/L番号を指定して、帳票:ドックレシートを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定されたB/L番号(***blNo***)に該当する取引に対して、帳票:ドックレシートを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定されたB/L番号(***blNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:ドックレシートが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/Report/DockReceipts/CreateByBookingNo |
ブッキング番号を指定して、帳票:ドックレシートを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:ドックレシートを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:ドックレシートが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/Report/DockReceipts/CreateByDomesticNo |
社内管理番号を指定して、帳票:ドックレシートを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:ドックレシートを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:ドックレシートが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/Report/DockReceipts/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:ドックレシートを削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/Report/DockReceipts/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
B/L番号を指定して、帳票:ドックレシートを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、帳票:ドックレシートを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/Report/DockReceipts/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId} |
ブッキング番号を指定して、帳票:ドックレシートを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:ドックレシートを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/Report/DockReceipts/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
取引管理番号を指定して、帳票:ドックレシートを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:ドックレシートを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/Report/DockReceipts/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
社内管理番号を指定して、帳票:ドックレシートを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:ドックレシートを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/Report/DockReceipts/Get/{dealReportId} |
帳票:ドックレシートを取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/Report/DockReceipts/GetAttachFileMetaList/{dealReportId} |
添付ファイル情報一覧を取得します。 |
|
GET | /API/v1/Report/DockReceipts/GetByDealNo/{dealNo} |
取引管理番号を指定して、帳票:ドックレシートを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:ドックレシートを取得します。 |
|
GET | /API/v1/Report/DockReceipts/GetListByBlNo/{blNo} |
B/L番号を指定して、帳票:ドックレシートを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、ドックレシートを取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が付番されている全ての取引から、帳票:ドックレシートを取得します。 |
|
GET | /API/v1/Report/DockReceipts/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo} |
ブッキング番号を指定して、帳票:ドックレシートを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:ドックレシートを取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が付番されている全ての取引から、帳票:ドックレシートを取得します。 |
|
GET | /API/v1/Report/DockReceipts/GetListByDomesticNo/{domesticNo} |
社内管理番号を指定して、帳票:ドックレシートを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:ドックレシートを取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:ドックレシートを取得します。 |
|
POST | /API/v1/Report/DockReceipts/Register |
帳票:ドックレシートを保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
ECR
ECR_輸出貨物情報登録
API | Description | ||
---|---|---|---|
POST | /API/v1/NACCS/ECR/Create |
帳票:ECR_輸出貨物情報登録を作成します。 帳票:ECR_輸出貨物情報登録を作成します。帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対して、Write権限が必要です。また、取引内に帳票:ECR_輸出貨物情報登録が存在する場合は、ステータスコード:200となり、Getメソッドと同じ動作となります。 |
|
DELETE | /API/v1/NACCS/ECR/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:ECR_輸出貨物情報登録を削除します。 帳票:ECR_輸出貨物情報登録を削除します。帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
GET | /API/v1/NACCS/ECR/Get/{dealReportId} |
帳票:ECR_輸出貨物情報登録を取得します。 帳票:ECR_輸出貨物情報登録を取得します。帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対して、Read権限が必要です。 |
EDA
EDA_輸出申告事項登録
API | Description | ||
---|---|---|---|
POST | /API/v1/NACCS/EDA/Create |
帳票:EDA_輸出申告事項登録を作成します。 帳票:EDA_輸出申告事項登録を作成します。帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対して、Write権限が必要です。また、取引内に帳票:EDA_輸出申告事項登録が存在する場合は、ステータスコード:200となり、Getメソッドと同じ動作となります。 |
|
DELETE | /API/v1/NACCS/EDA/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:EDA_輸出申告事項登録を削除します。 帳票:EDA_輸出申告事項登録を削除します。帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
GET | /API/v1/NACCS/EDA/Get/{dealReportId} |
帳票:EDA_輸出申告事項登録を取得します。 帳票:EDA_輸出申告事項登録を取得します。帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対して、Read権限が必要です。 |
EDA01
EDA01_輸出申告変更事項登録
API | Description | ||
---|---|---|---|
POST | /API/v1/NACCS/EDA01/Create |
帳票:EDA01_輸出申告変更事項登録を作成します。 帳票:EDA01_輸出申告変更事項登録を作成します。帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対して、Write権限が必要です。また、取引内に帳票:EDA01_輸出申告変更事項登録が存在する場合は、ステータスコード:200となり、Getメソッドと同じ動作となります。 |
|
DELETE | /API/v1/NACCS/EDA01/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:EDA01_輸出申告変更事項登録を削除します。 帳票:EDA01_輸出申告変更事項登録を削除します。帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
GET | /API/v1/NACCS/EDA01/Get/{dealReportId} |
帳票:EDA01_輸出申告変更事項登録を取得します。 帳票:EDA01_輸出申告変更事項登録を取得します。帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対して、Read権限が必要です。 |
EmptyContainerPickUpOrders
空コンテナピックアップオーダー
API | Description | ||
---|---|---|---|
POST | /API/v1/Report/EmptyContainerPickUpOrders/Create |
帳票:空コンテナピックアップオーダーを作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 |
|
POST | /API/v1/Report/EmptyContainerPickUpOrders/CreateAttachFileMeta |
添付ファイルメタ情報を登録します。 |
|
POST | /API/v1/Report/EmptyContainerPickUpOrders/CreateByBlNo |
B/L番号を指定して、帳票:空コンテナピックアップオーダーを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定されたB/L番号(***blNo***)に該当する取引に対して、帳票:空コンテナピックアップオーダーを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定されたB/L番号(***blNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 カスタムID(***customId***)は作成数に制限がない帳票を特定できるように任意に設定できる項目です。 カスタムID(***customId***)に値が設定されていなくても帳票:空コンテナピックアップオーダーは作成可能です。同じカスタムID(***customId***)の帳票:空コンテナピックアップオーダーが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/Report/EmptyContainerPickUpOrders/CreateByBookingNo |
ブッキング番号を指定して、帳票:空コンテナピックアップオーダーを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:空コンテナピックアップオーダーを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 カスタムID(***customId***)は作成数に制限がない帳票を特定できるように任意に設定できる項目です。 カスタムID(***customId***)に値が設定されていなくても帳票:空コンテナピックアップオーダーは作成可能です。同じカスタムID(***customId***)の帳票:空コンテナピックアップオーダーが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/Report/EmptyContainerPickUpOrders/CreateByDomesticNo |
社内管理番号を指定して、帳票:空コンテナピックアップオーダーを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:空コンテナピックアップオーダーを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 カスタムID(***customId***)は作成数に制限がない帳票を特定できるように任意に設定できる項目です。 カスタムID(***customId***)に値が設定されていなくても帳票:空コンテナピックアップオーダーは作成可能です。同じカスタムID(***customId***)の帳票:空コンテナピックアップオーダーが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/Report/EmptyContainerPickUpOrders/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:空コンテナピックアップオーダーを削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/Report/EmptyContainerPickUpOrders/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId}&customId={customId} |
B/L番号を指定して、帳票:空コンテナピックアップオーダーを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、帳票:空コンテナピックアップオーダーを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/Report/EmptyContainerPickUpOrders/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId}&customId={customId} |
ブッキング番号を指定して、帳票:空コンテナピックアップオーダーを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:空コンテナピックアップオーダーを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/Report/EmptyContainerPickUpOrders/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId}&customId={customId} |
取引管理番号を指定して、帳票:空コンテナピックアップオーダーを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:空コンテナピックアップオーダーを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/Report/EmptyContainerPickUpOrders/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId}&customId={customId} |
社内管理番号を指定して、帳票:空コンテナピックアップオーダーを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:空コンテナピックアップオーダーを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/Report/EmptyContainerPickUpOrders/Get/{dealReportId} |
帳票:空コンテナピックアップオーダーを取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/Report/EmptyContainerPickUpOrders/GetAttachFileMetaList/{dealReportId} |
添付ファイル情報一覧を取得します。 |
|
GET | /API/v1/Report/EmptyContainerPickUpOrders/GetListByBlNo/{blNo}?customId={customId} |
B/L番号を指定して、帳票:空コンテナピックアップオーダーを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、空コンテナピックアップオーダーを取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が付番されている全ての取引から、帳票:空コンテナピックアップオーダーを取得します。 |
|
GET | /API/v1/Report/EmptyContainerPickUpOrders/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&customId={customId} |
ブッキング番号を指定して、帳票:空コンテナピックアップオーダーを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:空コンテナピックアップオーダーを取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が付番されている全ての取引から、帳票:空コンテナピックアップオーダーを取得します。 |
|
GET | /API/v1/Report/EmptyContainerPickUpOrders/GetListByDealNo/{dealNo} |
取引管理番号を指定して、帳票:空コンテナピックアップオーダーを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:空コンテナピックアップオーダーを取得します。 |
|
GET | /API/v1/Report/EmptyContainerPickUpOrders/GetListByDomesticNo/{domesticNo}?customId={customId} |
社内管理番号を指定して、帳票:空コンテナピックアップオーダーを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:空コンテナピックアップオーダーを取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:空コンテナピックアップオーダーを取得します。 |
|
POST | /API/v1/Report/EmptyContainerPickUpOrders/Register |
帳票:空コンテナピックアップオーダーを保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
EquipmentInterchangeReceipts
機器受領書
API | Description | ||
---|---|---|---|
POST | /API/v1/Report/EquipmentInterchangeReceipts/Create |
帳票:機器受領書を作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ## 帳票の作成単位 帳票:機器受領書を取引内に以下の単位で作成します。 コンテナ番号(***containerNo***)・機器受渡種別(IN/OUT)(***equipmentInterchangeTypeInOut***)・コンテナ状態(FULL/EMPTY)(***fullOrEmpty***)・コンテナターミナルコード(***containerTerminalCode***) 同じ作成単位の帳票:機器受領書が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/Report/EquipmentInterchangeReceipts/CreateAttachFileMeta |
添付ファイルメタ情報を登録します。 |
|
POST | /API/v1/Report/EquipmentInterchangeReceipts/CreateByBlNo |
B/L番号を指定して、帳票:機器受領書を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定されたB/L番号(***blNo***)に該当する取引に対して、帳票:機器受領書を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定されたB/L番号(***blNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 ## 帳票の作成単位 帳票:機器受領書を取引内に以下の単位で作成します。 コンテナ番号(***containerNo***)・機器受渡種別(IN/OUT)(***equipmentInterchangeTypeInOut***)・コンテナ状態(FULL/EMPTY)(***fullOrEmpty***)・コンテナターミナルコード(***containerTerminalCode***) 同じ作成単位の帳票:機器受領書が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/Report/EquipmentInterchangeReceipts/CreateByBookingNo |
ブッキング番号を指定して、帳票:機器受領書を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:機器受領書を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 ## 帳票の作成単位 帳票:機器受領書を取引内に以下の単位で作成します。 コンテナ番号(***containerNo***)・機器受渡種別(IN/OUT)(***equipmentInterchangeTypeInOut***)・コンテナ状態(FULL/EMPTY)(***fullOrEmpty***)・コンテナターミナルコード(***containerTerminalCode***) 同じ作成単位の帳票:機器受領書が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/Report/EquipmentInterchangeReceipts/CreateByDomesticNo |
社内管理番号を指定して、帳票:機器受領書を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:機器受領書を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 ## 帳票の作成単位 帳票:機器受領書を取引内に以下の単位で作成します。 コンテナ番号(***containerNo***)・機器受渡種別(IN/OUT)(***equipmentInterchangeTypeInOut***)・コンテナ状態(FULL/EMPTY)(***fullOrEmpty***)・コンテナターミナルコード(***containerTerminalCode***) 同じ作成単位の帳票:機器受領書が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/Report/EquipmentInterchangeReceipts/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:機器受領書を削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/Report/EquipmentInterchangeReceipts/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId}&containerNo={containerNo}&equipmentInterchangeTypeInOut={equipmentInterchangeTypeInOut}&fullOrEmpty={fullOrEmpty}&containerTerminalCode={containerTerminalCode} |
B/L番号を指定して、帳票:機器受領書を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、帳票:機器受領書を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/Report/EquipmentInterchangeReceipts/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId}&containerNo={containerNo}&equipmentInterchangeTypeInOut={equipmentInterchangeTypeInOut}&fullOrEmpty={fullOrEmpty}&containerTerminalCode={containerTerminalCode} |
ブッキング番号を指定して、帳票:機器受領書を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:機器受領書を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/Report/EquipmentInterchangeReceipts/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId}&containerNo={containerNo}&equipmentInterchangeTypeInOut={equipmentInterchangeTypeInOut}&fullOrEmpty={fullOrEmpty}&containerTerminalCode={containerTerminalCode} |
取引管理番号を指定して、帳票:機器受領書を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:機器受領書を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/Report/EquipmentInterchangeReceipts/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId}&containerNo={containerNo}&equipmentInterchangeTypeInOut={equipmentInterchangeTypeInOut}&fullOrEmpty={fullOrEmpty}&containerTerminalCode={containerTerminalCode} |
社内管理番号を指定して、帳票:機器受領書を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:機器受領書を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/Report/EquipmentInterchangeReceipts/Get/{dealReportId} |
帳票:機器受領書を取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/Report/EquipmentInterchangeReceipts/Get?dealNo={dealNo}&containerNo={containerNo}&equipmentInterchangeTypeInOut={equipmentInterchangeTypeInOut}&fullOrEmpty={fullOrEmpty}&containerTerminalCode={containerTerminalCode} |
帳票:機器受領書を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:機器受領書を取得します。 |
|
GET | /API/v1/Report/EquipmentInterchangeReceipts/GetAttachFileMetaList/{dealReportId} |
添付ファイル情報一覧を取得します。 |
|
GET | /API/v1/Report/EquipmentInterchangeReceipts/GetListByBlNo/{blNo}?containerNo={containerNo}&equipmentInterchangeTypeInOut={equipmentInterchangeTypeInOut}&fullOrEmpty={fullOrEmpty}&containerTerminalCode={containerTerminalCode} |
B/L番号を指定して、帳票:機器受領書を取得します。 ## 概要 ユーザが所属している組織が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、機器受領書を取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が付番されている全ての取引から、帳票:機器受領書を取得します。 |
|
GET | /API/v1/Report/EquipmentInterchangeReceipts/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&containerNo={containerNo}&equipmentInterchangeTypeInOut={equipmentInterchangeTypeInOut}&fullOrEmpty={fullOrEmpty}&containerTerminalCode={containerTerminalCode} |
ブッキング番号を指定して、帳票:機器受領書を取得します。 ## 概要 ユーザが所属している組織が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:機器受領書を取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が付番されている全ての取引から、帳票:機器受領書を取得します。 |
|
GET | /API/v1/Report/EquipmentInterchangeReceipts/GetListByDealNo/{dealNo} |
取引管理番号を指定して、帳票:機器受領書を取得します。 ## 概要 ユーザが所属している組織が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:機器受領書を取得します。 |
|
GET | /API/v1/Report/EquipmentInterchangeReceipts/GetListByDomesticNo/{domesticNo}?containerNo={containerNo}&equipmentInterchangeTypeInOut={equipmentInterchangeTypeInOut}&fullOrEmpty={fullOrEmpty}&containerTerminalCode={containerTerminalCode} |
社内管理番号を指定して、帳票:機器受領書を取得します。 ## 概要 ユーザが所属している組織が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:機器受領書を取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:機器受領書を取得します。 |
|
POST | /API/v1/Report/EquipmentInterchangeReceipts/Register |
帳票:機器受領書を保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
ExchangeRateInquiries
IER
API | Description | ||
---|---|---|---|
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でのレスポンスデータを編集し、指定するようにしてください。 |
ExportCargoCorrectionCalls
BIF11
API | Description | ||
---|---|---|---|
POST | /API/v1/NaccsReport/ExportCargoCorrectionCalls/Create |
帳票:BIF11を作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 帳票:BIF11が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/ExportCargoCorrectionCalls/CreateByBlNo |
B/L番号を指定して、帳票:BIF11を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定されたB/L番号(***blNo***)に該当する取引に対して、帳票:BIF11を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定されたB/L番号(***blNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:BIF11が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/ExportCargoCorrectionCalls/CreateByBookingNo |
ブッキング番号を指定して、帳票:BIF11を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:BIF11を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:BIF11が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/ExportCargoCorrectionCalls/CreateByDomesticNo |
社内管理番号を指定して、帳票:BIF11を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:BIF11を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:BIF11が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/NaccsReport/ExportCargoCorrectionCalls/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:BIF11を削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/NaccsReport/ExportCargoCorrectionCalls/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
B/L番号を指定して、帳票:BIF11を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、帳票:BIF11を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/ExportCargoCorrectionCalls/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId} |
ブッキング番号を指定して、帳票:BIF11を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:BIF11を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/ExportCargoCorrectionCalls/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
取引管理番号を指定して、帳票:BIF11を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:BIF11を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/ExportCargoCorrectionCalls/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
社内管理番号を指定して、帳票:BIF11を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:BIF11を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/NaccsReport/ExportCargoCorrectionCalls/Get/{dealReportId} |
帳票:BIF11を取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/NaccsReport/ExportCargoCorrectionCalls/GetByDealNo/{dealNo} |
取引管理番号を指定して、帳票:BIF11を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:BIF11を取得します。 |
|
GET | /API/v1/NaccsReport/ExportCargoCorrectionCalls/GetListByBlNo/{blNo} |
B/L番号を指定して、帳票:BIF11を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、BIF11を取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が付番されている全ての取引から、帳票:BIF11を取得します。 |
|
GET | /API/v1/NaccsReport/ExportCargoCorrectionCalls/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo} |
ブッキング番号を指定して、帳票:BIF11を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:BIF11を取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が付番されている全ての取引から、帳票:BIF11を取得します。 |
|
GET | /API/v1/NaccsReport/ExportCargoCorrectionCalls/GetListByDomesticNo/{domesticNo} |
社内管理番号を指定して、帳票:BIF11を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:BIF11を取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:BIF11を取得します。 |
|
POST | /API/v1/NaccsReport/ExportCargoCorrectionCalls/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/ExportCargoCorrectionCalls/Register |
帳票:BIF11を保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
ExportCargoCorrections
BIF
API | Description | ||
---|---|---|---|
POST | /API/v1/NaccsReport/ExportCargoCorrections/Create |
帳票:BIFを作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 |
|
POST | /API/v1/NaccsReport/ExportCargoCorrections/CreateByBlNo |
B/L番号を指定して、帳票:BIFを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定されたB/L番号(***blNo***)に該当する取引に対して、帳票:BIFを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定されたB/L番号(***blNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 カスタムID(***customId***)は作成数に制限がない帳票を特定できるように任意に設定できる項目です。 カスタムID(***customId***)に値が設定されていなくても帳票:BIFは作成可能です。同じカスタムID(***customId***)の帳票:BIFが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/ExportCargoCorrections/CreateByBookingNo |
ブッキング番号を指定して、帳票:BIFを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:BIFを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 カスタムID(***customId***)は作成数に制限がない帳票を特定できるように任意に設定できる項目です。 カスタムID(***customId***)に値が設定されていなくても帳票:BIFは作成可能です。同じカスタムID(***customId***)の帳票:BIFが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/ExportCargoCorrections/CreateByDomesticNo |
社内管理番号を指定して、帳票:BIFを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:BIFを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 カスタムID(***customId***)は作成数に制限がない帳票を特定できるように任意に設定できる項目です。 カスタムID(***customId***)に値が設定されていなくても帳票:BIFは作成可能です。同じカスタムID(***customId***)の帳票:BIFが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/NaccsReport/ExportCargoCorrections/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:BIFを削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/NaccsReport/ExportCargoCorrections/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId}&customId={customId} |
B/L番号を指定して、帳票:BIFを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、帳票:BIFを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/ExportCargoCorrections/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId}&customId={customId} |
ブッキング番号を指定して、帳票:BIFを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:BIFを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/ExportCargoCorrections/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId}&customId={customId} |
取引管理番号を指定して、帳票:BIFを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:BIFを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/ExportCargoCorrections/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId}&customId={customId} |
社内管理番号を指定して、帳票:BIFを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:BIFを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/NaccsReport/ExportCargoCorrections/Get/{dealReportId} |
帳票:BIFを取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/NaccsReport/ExportCargoCorrections/GetListByBlNo/{blNo}?customId={customId} |
B/L番号を指定して、帳票:BIFを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、BIFを取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が付番されている全ての取引から、帳票:BIFを取得します。 |
|
GET | /API/v1/NaccsReport/ExportCargoCorrections/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&customId={customId} |
ブッキング番号を指定して、帳票:BIFを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:BIFを取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が付番されている全ての取引から、帳票:BIFを取得します。 |
|
GET | /API/v1/NaccsReport/ExportCargoCorrections/GetListByDealNo/{dealNo} |
取引管理番号を指定して、帳票:BIFを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:BIFを取得します。 |
|
GET | /API/v1/NaccsReport/ExportCargoCorrections/GetListByDomesticNo/{domesticNo}?customId={customId} |
社内管理番号を指定して、帳票:BIFを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:BIFを取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:BIFを取得します。 |
|
POST | /API/v1/NaccsReport/ExportCargoCorrections/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/ExportCargoCorrections/Register |
帳票:BIFを保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
ExportCargoRegistrationCalls
ECR11
API | Description | ||
---|---|---|---|
POST | /API/v1/NaccsReport/ExportCargoRegistrationCalls/Create |
帳票:ECR11を作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 帳票:ECR11が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/ExportCargoRegistrationCalls/CreateByBlNo |
B/L番号を指定して、帳票:ECR11を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定されたB/L番号(***blNo***)に該当する取引に対して、帳票:ECR11を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定されたB/L番号(***blNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:ECR11が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/ExportCargoRegistrationCalls/CreateByBookingNo |
ブッキング番号を指定して、帳票:ECR11を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:ECR11を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:ECR11が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/ExportCargoRegistrationCalls/CreateByDomesticNo |
社内管理番号を指定して、帳票:ECR11を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:ECR11を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:ECR11が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/NaccsReport/ExportCargoRegistrationCalls/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:ECR11を削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/NaccsReport/ExportCargoRegistrationCalls/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
B/L番号を指定して、帳票:ECR11を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、帳票:ECR11を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/ExportCargoRegistrationCalls/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId} |
ブッキング番号を指定して、帳票:ECR11を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:ECR11を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/ExportCargoRegistrationCalls/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
取引管理番号を指定して、帳票:ECR11を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:ECR11を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/ExportCargoRegistrationCalls/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
社内管理番号を指定して、帳票:ECR11を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:ECR11を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/NaccsReport/ExportCargoRegistrationCalls/Get/{dealReportId} |
帳票:ECR11を取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/NaccsReport/ExportCargoRegistrationCalls/GetByDealNo/{dealNo} |
取引管理番号を指定して、帳票:ECR11を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:ECR11を取得します。 |
|
GET | /API/v1/NaccsReport/ExportCargoRegistrationCalls/GetListByBlNo/{blNo} |
B/L番号を指定して、帳票:ECR11を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、ECR11を取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が付番されている全ての取引から、帳票:ECR11を取得します。 |
|
GET | /API/v1/NaccsReport/ExportCargoRegistrationCalls/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo} |
ブッキング番号を指定して、帳票:ECR11を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:ECR11を取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が付番されている全ての取引から、帳票:ECR11を取得します。 |
|
GET | /API/v1/NaccsReport/ExportCargoRegistrationCalls/GetListByDomesticNo/{domesticNo} |
社内管理番号を指定して、帳票:ECR11を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:ECR11を取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:ECR11を取得します。 |
|
POST | /API/v1/NaccsReport/ExportCargoRegistrationCalls/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/ExportCargoRegistrationCalls/Register |
帳票:ECR11を保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
ExportCargoRegistrations
ECR
API | Description | ||
---|---|---|---|
POST | /API/v1/NaccsReport/ExportCargoRegistrations/Create |
帳票:ECRを作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 |
|
POST | /API/v1/NaccsReport/ExportCargoRegistrations/CreateByBlNo |
B/L番号を指定して、帳票:ECRを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定されたB/L番号(***blNo***)に該当する取引に対して、帳票:ECRを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定されたB/L番号(***blNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 カスタムID(***customId***)は作成数に制限がない帳票を特定できるように任意に設定できる項目です。 カスタムID(***customId***)に値が設定されていなくても帳票:ECRは作成可能です。同じカスタムID(***customId***)の帳票:ECRが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/ExportCargoRegistrations/CreateByBookingNo |
ブッキング番号を指定して、帳票:ECRを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:ECRを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 カスタムID(***customId***)は作成数に制限がない帳票を特定できるように任意に設定できる項目です。 カスタムID(***customId***)に値が設定されていなくても帳票:ECRは作成可能です。同じカスタムID(***customId***)の帳票:ECRが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/ExportCargoRegistrations/CreateByDomesticNo |
社内管理番号を指定して、帳票:ECRを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:ECRを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 カスタムID(***customId***)は作成数に制限がない帳票を特定できるように任意に設定できる項目です。 カスタムID(***customId***)に値が設定されていなくても帳票:ECRは作成可能です。同じカスタムID(***customId***)の帳票:ECRが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/NaccsReport/ExportCargoRegistrations/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:ECRを削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/NaccsReport/ExportCargoRegistrations/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId}&customId={customId} |
B/L番号を指定して、帳票:ECRを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、帳票:ECRを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/ExportCargoRegistrations/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId}&customId={customId} |
ブッキング番号を指定して、帳票:ECRを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:ECRを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/ExportCargoRegistrations/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId}&customId={customId} |
取引管理番号を指定して、帳票:ECRを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:ECRを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/ExportCargoRegistrations/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId}&customId={customId} |
社内管理番号を指定して、帳票:ECRを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:ECRを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/NaccsReport/ExportCargoRegistrations/Get/{dealReportId} |
帳票:ECRを取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/NaccsReport/ExportCargoRegistrations/GetListByBlNo/{blNo}?customId={customId} |
B/L番号を指定して、帳票:ECRを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、ECRを取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が付番されている全ての取引から、帳票:ECRを取得します。 |
|
GET | /API/v1/NaccsReport/ExportCargoRegistrations/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&customId={customId} |
ブッキング番号を指定して、帳票:ECRを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:ECRを取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が付番されている全ての取引から、帳票:ECRを取得します。 |
|
GET | /API/v1/NaccsReport/ExportCargoRegistrations/GetListByDealNo/{dealNo} |
取引管理番号を指定して、帳票:ECRを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:ECRを取得します。 |
|
GET | /API/v1/NaccsReport/ExportCargoRegistrations/GetListByDomesticNo/{domesticNo}?customId={customId} |
社内管理番号を指定して、帳票:ECRを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:ECRを取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:ECRを取得します。 |
|
POST | /API/v1/NaccsReport/ExportCargoRegistrations/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/ExportCargoRegistrations/Register |
帳票:ECRを保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
ExportDeclarationCalls
EDB
API | Description | ||
---|---|---|---|
POST | /API/v1/NaccsReport/ExportDeclarationCalls/Create |
帳票:EDBを作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 帳票:EDBが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/ExportDeclarationCalls/CreateByBlNo |
B/L番号を指定して、帳票:EDBを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定されたB/L番号(***blNo***)に該当する取引に対して、帳票:EDBを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定されたB/L番号(***blNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:EDBが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/ExportDeclarationCalls/CreateByBookingNo |
ブッキング番号を指定して、帳票:EDBを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:EDBを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:EDBが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/ExportDeclarationCalls/CreateByDomesticNo |
社内管理番号を指定して、帳票:EDBを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:EDBを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:EDBが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/NaccsReport/ExportDeclarationCalls/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:EDBを削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/NaccsReport/ExportDeclarationCalls/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
B/L番号を指定して、帳票:EDBを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、帳票:EDBを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/ExportDeclarationCalls/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId} |
ブッキング番号を指定して、帳票:EDBを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:EDBを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/ExportDeclarationCalls/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
取引管理番号を指定して、帳票:EDBを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:EDBを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/ExportDeclarationCalls/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
社内管理番号を指定して、帳票:EDBを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:EDBを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/NaccsReport/ExportDeclarationCalls/Get/{dealReportId} |
帳票:EDBを取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/NaccsReport/ExportDeclarationCalls/GetByDealNo/{dealNo} |
取引管理番号を指定して、帳票:EDBを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:EDBを取得します。 |
|
GET | /API/v1/NaccsReport/ExportDeclarationCalls/GetListByBlNo/{blNo} |
B/L番号を指定して、帳票:EDBを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、EDBを取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が付番されている全ての取引から、帳票:EDBを取得します。 |
|
GET | /API/v1/NaccsReport/ExportDeclarationCalls/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo} |
ブッキング番号を指定して、帳票:EDBを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:EDBを取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が付番されている全ての取引から、帳票:EDBを取得します。 |
|
GET | /API/v1/NaccsReport/ExportDeclarationCalls/GetListByDomesticNo/{domesticNo} |
社内管理番号を指定して、帳票:EDBを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:EDBを取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:EDBを取得します。 |
|
POST | /API/v1/NaccsReport/ExportDeclarationCalls/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/ExportDeclarationCalls/Register |
帳票:EDBを保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
ExportDeclarationInquiries
IEX
API | Description | ||
---|---|---|---|
POST | /API/v1/NaccsReport/ExportDeclarationInquiries/Create |
帳票:IEXを作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 帳票:IEXが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/ExportDeclarationInquiries/CreateByBlNo |
B/L番号を指定して、帳票:IEXを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定されたB/L番号(***blNo***)に該当する取引に対して、帳票:IEXを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定されたB/L番号(***blNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:IEXが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/ExportDeclarationInquiries/CreateByBookingNo |
ブッキング番号を指定して、帳票:IEXを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:IEXを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:IEXが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/ExportDeclarationInquiries/CreateByDomesticNo |
社内管理番号を指定して、帳票:IEXを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:IEXを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:IEXが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/NaccsReport/ExportDeclarationInquiries/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:IEXを削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/NaccsReport/ExportDeclarationInquiries/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
B/L番号を指定して、帳票:IEXを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、帳票:IEXを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/ExportDeclarationInquiries/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId} |
ブッキング番号を指定して、帳票:IEXを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:IEXを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/ExportDeclarationInquiries/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
取引管理番号を指定して、帳票:IEXを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:IEXを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/ExportDeclarationInquiries/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
社内管理番号を指定して、帳票:IEXを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:IEXを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/NaccsReport/ExportDeclarationInquiries/Get/{dealReportId} |
帳票:IEXを取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/NaccsReport/ExportDeclarationInquiries/GetByDealNo/{dealNo} |
取引管理番号を指定して、帳票:IEXを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:IEXを取得します。 |
|
GET | /API/v1/NaccsReport/ExportDeclarationInquiries/GetListByBlNo/{blNo} |
B/L番号を指定して、帳票:IEXを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、IEXを取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が付番されている全ての取引から、帳票:IEXを取得します。 |
|
GET | /API/v1/NaccsReport/ExportDeclarationInquiries/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo} |
ブッキング番号を指定して、帳票:IEXを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:IEXを取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が付番されている全ての取引から、帳票:IEXを取得します。 |
|
GET | /API/v1/NaccsReport/ExportDeclarationInquiries/GetListByDomesticNo/{domesticNo} |
社内管理番号を指定して、帳票:IEXを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:IEXを取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:IEXを取得します。 |
|
POST | /API/v1/NaccsReport/ExportDeclarationInquiries/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/ExportDeclarationInquiries/Register |
帳票:IEXを保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
ExportDeclarationRegistrations
EDA
API | Description | ||
---|---|---|---|
POST | /API/v1/NaccsReport/ExportDeclarationRegistrations/Create |
帳票:EDAを作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 帳票:EDAが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/ExportDeclarationRegistrations/CreateByBlNo |
B/L番号を指定して、帳票:EDAを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定されたB/L番号(***blNo***)に該当する取引に対して、帳票:EDAを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定されたB/L番号(***blNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:EDAが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/ExportDeclarationRegistrations/CreateByBookingNo |
ブッキング番号を指定して、帳票:EDAを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:EDAを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:EDAが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/ExportDeclarationRegistrations/CreateByDomesticNo |
社内管理番号を指定して、帳票:EDAを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:EDAを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:EDAが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/NaccsReport/ExportDeclarationRegistrations/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:EDAを削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/NaccsReport/ExportDeclarationRegistrations/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
B/L番号を指定して、帳票:EDAを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、帳票:EDAを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/ExportDeclarationRegistrations/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId} |
ブッキング番号を指定して、帳票:EDAを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:EDAを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/ExportDeclarationRegistrations/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
取引管理番号を指定して、帳票:EDAを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:EDAを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/ExportDeclarationRegistrations/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
社内管理番号を指定して、帳票:EDAを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:EDAを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/NaccsReport/ExportDeclarationRegistrations/Get/{dealReportId} |
帳票:EDAを取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/NaccsReport/ExportDeclarationRegistrations/GetByDealNo/{dealNo} |
取引管理番号を指定して、帳票:EDAを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:EDAを取得します。 |
|
GET | /API/v1/NaccsReport/ExportDeclarationRegistrations/GetListByBlNo/{blNo} |
B/L番号を指定して、帳票:EDAを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、EDAを取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が付番されている全ての取引から、帳票:EDAを取得します。 |
|
GET | /API/v1/NaccsReport/ExportDeclarationRegistrations/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo} |
ブッキング番号を指定して、帳票:EDAを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:EDAを取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が付番されている全ての取引から、帳票:EDAを取得します。 |
|
GET | /API/v1/NaccsReport/ExportDeclarationRegistrations/GetListByDomesticNo/{domesticNo} |
社内管理番号を指定して、帳票:EDAを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:EDAを取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:EDAを取得します。 |
|
POST | /API/v1/NaccsReport/ExportDeclarationRegistrations/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/ExportDeclarationRegistrations/Register |
帳票:EDAを保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
ExportDeclarations
EDC
API | Description | ||
---|---|---|---|
POST | /API/v1/NaccsReport/ExportDeclarations/Create |
帳票:EDCを作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 帳票:EDCが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/ExportDeclarations/CreateByBlNo |
B/L番号を指定して、帳票:EDCを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定されたB/L番号(***blNo***)に該当する取引に対して、帳票:EDCを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定されたB/L番号(***blNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:EDCが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/ExportDeclarations/CreateByBookingNo |
ブッキング番号を指定して、帳票:EDCを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:EDCを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:EDCが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/ExportDeclarations/CreateByDomesticNo |
社内管理番号を指定して、帳票:EDCを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:EDCを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:EDCが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/NaccsReport/ExportDeclarations/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:EDCを削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/NaccsReport/ExportDeclarations/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
B/L番号を指定して、帳票:EDCを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、帳票:EDCを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/ExportDeclarations/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId} |
ブッキング番号を指定して、帳票:EDCを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:EDCを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/ExportDeclarations/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
取引管理番号を指定して、帳票:EDCを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:EDCを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/ExportDeclarations/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
社内管理番号を指定して、帳票:EDCを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:EDCを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/NaccsReport/ExportDeclarations/Get/{dealReportId} |
帳票:EDCを取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/NaccsReport/ExportDeclarations/GetByDealNo/{dealNo} |
取引管理番号を指定して、帳票:EDCを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:EDCを取得します。 |
|
GET | /API/v1/NaccsReport/ExportDeclarations/GetListByBlNo/{blNo} |
B/L番号を指定して、帳票:EDCを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、EDCを取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が付番されている全ての取引から、帳票:EDCを取得します。 |
|
GET | /API/v1/NaccsReport/ExportDeclarations/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo} |
ブッキング番号を指定して、帳票:EDCを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:EDCを取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が付番されている全ての取引から、帳票:EDCを取得します。 |
|
GET | /API/v1/NaccsReport/ExportDeclarations/GetListByDomesticNo/{domesticNo} |
社内管理番号を指定して、帳票:EDCを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:EDCを取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:EDCを取得します。 |
|
POST | /API/v1/NaccsReport/ExportDeclarations/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/ExportDeclarations/Register |
帳票:EDCを保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
ExporterImporterInquiries
IIE
API | Description | ||
---|---|---|---|
POST | /API/v1/NaccsReport/ExporterImporterInquiries/Create |
帳票:IIEを作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 帳票:IIEが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/ExporterImporterInquiries/CreateByBlNo |
B/L番号を指定して、帳票:IIEを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定されたB/L番号(***blNo***)に該当する取引に対して、帳票:IIEを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定されたB/L番号(***blNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:IIEが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/ExporterImporterInquiries/CreateByBookingNo |
ブッキング番号を指定して、帳票:IIEを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:IIEを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:IIEが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/ExporterImporterInquiries/CreateByDomesticNo |
社内管理番号を指定して、帳票:IIEを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:IIEを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:IIEが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/NaccsReport/ExporterImporterInquiries/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:IIEを削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/NaccsReport/ExporterImporterInquiries/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
B/L番号を指定して、帳票:IIEを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、帳票:IIEを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/ExporterImporterInquiries/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId} |
ブッキング番号を指定して、帳票:IIEを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:IIEを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/ExporterImporterInquiries/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
取引管理番号を指定して、帳票:IIEを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:IIEを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/ExporterImporterInquiries/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
社内管理番号を指定して、帳票:IIEを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:IIEを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/NaccsReport/ExporterImporterInquiries/Get/{dealReportId} |
帳票:IIEを取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/NaccsReport/ExporterImporterInquiries/GetByDealNo/{dealNo} |
取引管理番号を指定して、帳票:IIEを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:IIEを取得します。 |
|
GET | /API/v1/NaccsReport/ExporterImporterInquiries/GetListByBlNo/{blNo} |
B/L番号を指定して、帳票:IIEを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、IIEを取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が付番されている全ての取引から、帳票:IIEを取得します。 |
|
GET | /API/v1/NaccsReport/ExporterImporterInquiries/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo} |
ブッキング番号を指定して、帳票:IIEを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:IIEを取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が付番されている全ての取引から、帳票:IIEを取得します。 |
|
GET | /API/v1/NaccsReport/ExporterImporterInquiries/GetListByDomesticNo/{domesticNo} |
社内管理番号を指定して、帳票:IIEを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:IIEを取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:IIEを取得します。 |
|
POST | /API/v1/NaccsReport/ExporterImporterInquiries/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/ExporterImporterInquiries/Register |
帳票:IIEを保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
ExportPermitDetailsChangeApplicationCalls
EAB
API | Description | ||
---|---|---|---|
POST | /API/v1/NaccsReport/ExportPermitDetailsChangeApplicationCalls/Create |
帳票:EABを作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 帳票:EABが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/ExportPermitDetailsChangeApplicationCalls/CreateByBlNo |
B/L番号を指定して、帳票:EABを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定されたB/L番号(***blNo***)に該当する取引に対して、帳票:EABを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定されたB/L番号(***blNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:EABが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/ExportPermitDetailsChangeApplicationCalls/CreateByBookingNo |
ブッキング番号を指定して、帳票:EABを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:EABを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:EABが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/ExportPermitDetailsChangeApplicationCalls/CreateByDomesticNo |
社内管理番号を指定して、帳票:EABを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:EABを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:EABが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/NaccsReport/ExportPermitDetailsChangeApplicationCalls/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:EABを削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/NaccsReport/ExportPermitDetailsChangeApplicationCalls/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
B/L番号を指定して、帳票:EABを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、帳票:EABを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/ExportPermitDetailsChangeApplicationCalls/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId} |
ブッキング番号を指定して、帳票:EABを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:EABを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/ExportPermitDetailsChangeApplicationCalls/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
取引管理番号を指定して、帳票:EABを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:EABを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/ExportPermitDetailsChangeApplicationCalls/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
社内管理番号を指定して、帳票:EABを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:EABを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/NaccsReport/ExportPermitDetailsChangeApplicationCalls/Get/{dealReportId} |
帳票:EABを取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/NaccsReport/ExportPermitDetailsChangeApplicationCalls/GetByDealNo/{dealNo} |
取引管理番号を指定して、帳票:EABを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:EABを取得します。 |
|
GET | /API/v1/NaccsReport/ExportPermitDetailsChangeApplicationCalls/GetListByBlNo/{blNo} |
B/L番号を指定して、帳票:EABを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、EABを取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が付番されている全ての取引から、帳票:EABを取得します。 |
|
GET | /API/v1/NaccsReport/ExportPermitDetailsChangeApplicationCalls/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo} |
ブッキング番号を指定して、帳票:EABを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:EABを取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が付番されている全ての取引から、帳票:EABを取得します。 |
|
GET | /API/v1/NaccsReport/ExportPermitDetailsChangeApplicationCalls/GetListByDomesticNo/{domesticNo} |
社内管理番号を指定して、帳票:EABを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:EABを取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:EABを取得します。 |
|
POST | /API/v1/NaccsReport/ExportPermitDetailsChangeApplicationCalls/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/ExportPermitDetailsChangeApplicationCalls/Register |
帳票:EABを保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
ExportPermitDetailsChangeApplicationRegistrations
EAA
API | Description | ||
---|---|---|---|
POST | /API/v1/NaccsReport/ExportPermitDetailsChangeApplicationRegistrations/Create |
帳票:EAAを作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 帳票:EAAが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/ExportPermitDetailsChangeApplicationRegistrations/CreateByBlNo |
B/L番号を指定して、帳票:EAAを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定されたB/L番号(***blNo***)に該当する取引に対して、帳票:EAAを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定されたB/L番号(***blNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:EAAが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/ExportPermitDetailsChangeApplicationRegistrations/CreateByBookingNo |
ブッキング番号を指定して、帳票:EAAを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:EAAを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:EAAが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/ExportPermitDetailsChangeApplicationRegistrations/CreateByDomesticNo |
社内管理番号を指定して、帳票:EAAを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:EAAを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:EAAが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/NaccsReport/ExportPermitDetailsChangeApplicationRegistrations/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:EAAを削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/NaccsReport/ExportPermitDetailsChangeApplicationRegistrations/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
B/L番号を指定して、帳票:EAAを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、帳票:EAAを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/ExportPermitDetailsChangeApplicationRegistrations/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId} |
ブッキング番号を指定して、帳票:EAAを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:EAAを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/ExportPermitDetailsChangeApplicationRegistrations/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
取引管理番号を指定して、帳票:EAAを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:EAAを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/ExportPermitDetailsChangeApplicationRegistrations/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
社内管理番号を指定して、帳票:EAAを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:EAAを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/NaccsReport/ExportPermitDetailsChangeApplicationRegistrations/Get/{dealReportId} |
帳票:EAAを取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/NaccsReport/ExportPermitDetailsChangeApplicationRegistrations/GetByDealNo/{dealNo} |
取引管理番号を指定して、帳票:EAAを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:EAAを取得します。 |
|
GET | /API/v1/NaccsReport/ExportPermitDetailsChangeApplicationRegistrations/GetListByBlNo/{blNo} |
B/L番号を指定して、帳票:EAAを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、EAAを取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が付番されている全ての取引から、帳票:EAAを取得します。 |
|
GET | /API/v1/NaccsReport/ExportPermitDetailsChangeApplicationRegistrations/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo} |
ブッキング番号を指定して、帳票:EAAを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:EAAを取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が付番されている全ての取引から、帳票:EAAを取得します。 |
|
GET | /API/v1/NaccsReport/ExportPermitDetailsChangeApplicationRegistrations/GetListByDomesticNo/{domesticNo} |
社内管理番号を指定して、帳票:EAAを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:EAAを取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:EAAを取得します。 |
|
POST | /API/v1/NaccsReport/ExportPermitDetailsChangeApplicationRegistrations/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/ExportPermitDetailsChangeApplicationRegistrations/Register |
帳票:EAAを保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
ExportPermitDetailsChangeApplications
EAC
API | Description | ||
---|---|---|---|
POST | /API/v1/NaccsReport/ExportPermitDetailsChangeApplications/Create |
帳票:EACを作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 帳票:EACが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/ExportPermitDetailsChangeApplications/CreateByBlNo |
B/L番号を指定して、帳票:EACを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定されたB/L番号(***blNo***)に該当する取引に対して、帳票:EACを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定されたB/L番号(***blNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:EACが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/ExportPermitDetailsChangeApplications/CreateByBookingNo |
ブッキング番号を指定して、帳票:EACを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:EACを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:EACが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/ExportPermitDetailsChangeApplications/CreateByDomesticNo |
社内管理番号を指定して、帳票:EACを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:EACを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:EACが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/NaccsReport/ExportPermitDetailsChangeApplications/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:EACを削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/NaccsReport/ExportPermitDetailsChangeApplications/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
B/L番号を指定して、帳票:EACを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、帳票:EACを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/ExportPermitDetailsChangeApplications/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId} |
ブッキング番号を指定して、帳票:EACを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:EACを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/ExportPermitDetailsChangeApplications/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
取引管理番号を指定して、帳票:EACを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:EACを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/ExportPermitDetailsChangeApplications/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
社内管理番号を指定して、帳票:EACを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:EACを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/NaccsReport/ExportPermitDetailsChangeApplications/Get/{dealReportId} |
帳票:EACを取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/NaccsReport/ExportPermitDetailsChangeApplications/GetByDealNo/{dealNo} |
取引管理番号を指定して、帳票:EACを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:EACを取得します。 |
|
GET | /API/v1/NaccsReport/ExportPermitDetailsChangeApplications/GetListByBlNo/{blNo} |
B/L番号を指定して、帳票:EACを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、EACを取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が付番されている全ての取引から、帳票:EACを取得します。 |
|
GET | /API/v1/NaccsReport/ExportPermitDetailsChangeApplications/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo} |
ブッキング番号を指定して、帳票:EACを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:EACを取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が付番されている全ての取引から、帳票:EACを取得します。 |
|
GET | /API/v1/NaccsReport/ExportPermitDetailsChangeApplications/GetListByDomesticNo/{domesticNo} |
社内管理番号を指定して、帳票:EACを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:EACを取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:EACを取得します。 |
|
POST | /API/v1/NaccsReport/ExportPermitDetailsChangeApplications/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/ExportPermitDetailsChangeApplications/Register |
帳票:EACを保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
FreeTimeInformationInquiries
IFR
API | Description | ||
---|---|---|---|
POST | /API/v1/NaccsReport/FreeTimeInformationInquiries/Create |
帳票:IFRを作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 帳票:IFRが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/FreeTimeInformationInquiries/CreateByBlNo |
B/L番号を指定して、帳票:IFRを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定されたB/L番号(***blNo***)に該当する取引に対して、帳票:IFRを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定されたB/L番号(***blNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:IFRが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/FreeTimeInformationInquiries/CreateByBookingNo |
ブッキング番号を指定して、帳票:IFRを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:IFRを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:IFRが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/FreeTimeInformationInquiries/CreateByDomesticNo |
社内管理番号を指定して、帳票:IFRを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:IFRを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:IFRが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/NaccsReport/FreeTimeInformationInquiries/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:IFRを削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/NaccsReport/FreeTimeInformationInquiries/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
B/L番号を指定して、帳票:IFRを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、帳票:IFRを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/FreeTimeInformationInquiries/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId} |
ブッキング番号を指定して、帳票:IFRを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:IFRを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/FreeTimeInformationInquiries/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
取引管理番号を指定して、帳票:IFRを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:IFRを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/FreeTimeInformationInquiries/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
社内管理番号を指定して、帳票:IFRを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:IFRを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/NaccsReport/FreeTimeInformationInquiries/Get/{dealReportId} |
帳票:IFRを取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/NaccsReport/FreeTimeInformationInquiries/GetByDealNo/{dealNo} |
取引管理番号を指定して、帳票:IFRを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:IFRを取得します。 |
|
GET | /API/v1/NaccsReport/FreeTimeInformationInquiries/GetListByBlNo/{blNo} |
B/L番号を指定して、帳票:IFRを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、IFRを取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が付番されている全ての取引から、帳票:IFRを取得します。 |
|
GET | /API/v1/NaccsReport/FreeTimeInformationInquiries/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo} |
ブッキング番号を指定して、帳票:IFRを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:IFRを取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が付番されている全ての取引から、帳票:IFRを取得します。 |
|
GET | /API/v1/NaccsReport/FreeTimeInformationInquiries/GetListByDomesticNo/{domesticNo} |
社内管理番号を指定して、帳票:IFRを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:IFRを取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:IFRを取得します。 |
|
POST | /API/v1/NaccsReport/FreeTimeInformationInquiries/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/FreeTimeInformationInquiries/Register |
帳票:IFRを保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
FreightInformations
フレート情報
API | Description | ||
---|---|---|---|
POST | /API/v1/Report/FreightInformations/Create |
帳票:フレート情報を作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 帳票:フレート情報が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/Report/FreightInformations/CreateAttachFileMeta |
添付ファイルメタ情報を登録します。 |
|
POST | /API/v1/Report/FreightInformations/CreateByBlNo |
B/L番号を指定して、帳票:フレート情報を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定されたB/L番号(***blNo***)に該当する取引に対して、帳票:フレート情報を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定されたB/L番号(***blNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:フレート情報が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/Report/FreightInformations/CreateByBookingNo |
ブッキング番号を指定して、帳票:フレート情報を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:フレート情報を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:フレート情報が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/Report/FreightInformations/CreateByDomesticNo |
社内管理番号を指定して、帳票:フレート情報を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:フレート情報を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:フレート情報が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/Report/FreightInformations/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:フレート情報を削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/Report/FreightInformations/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
B/L番号を指定して、帳票:フレート情報を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、帳票:フレート情報を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/Report/FreightInformations/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId} |
ブッキング番号を指定して、帳票:フレート情報を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:フレート情報を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/Report/FreightInformations/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
取引管理番号を指定して、帳票:フレート情報を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:フレート情報を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/Report/FreightInformations/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
社内管理番号を指定して、帳票:フレート情報を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:フレート情報を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/Report/FreightInformations/Get/{dealReportId} |
帳票:フレート情報を取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/Report/FreightInformations/GetAttachFileMetaList/{dealReportId} |
添付ファイル情報一覧を取得します。 |
|
GET | /API/v1/Report/FreightInformations/GetByDealNo/{dealNo} |
取引管理番号を指定して、帳票:フレート情報を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:フレート情報を取得します。 |
|
GET | /API/v1/Report/FreightInformations/GetListByBlNo/{blNo} |
B/L番号を指定して、帳票:フレート情報を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、フレート情報を取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が付番されている全ての取引から、帳票:フレート情報を取得します。 |
|
GET | /API/v1/Report/FreightInformations/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo} |
ブッキング番号を指定して、帳票:フレート情報を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:フレート情報を取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が付番されている全ての取引から、帳票:フレート情報を取得します。 |
|
GET | /API/v1/Report/FreightInformations/GetListByDomesticNo/{domesticNo} |
社内管理番号を指定して、帳票:フレート情報を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:フレート情報を取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:フレート情報を取得します。 |
|
POST | /API/v1/Report/FreightInformations/Register |
帳票:フレート情報を保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
HouseBlCargoRegistrationAssociations
NVC02
API | Description | ||
---|---|---|---|
POST | /API/v1/NaccsReport/HouseBlCargoRegistrationAssociations/Create |
帳票:NVC02を作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 帳票:NVC02が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/HouseBlCargoRegistrationAssociations/CreateByBlNo |
B/L番号を指定して、帳票:NVC02を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定されたB/L番号(***blNo***)に該当する取引に対して、帳票:NVC02を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定されたB/L番号(***blNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:NVC02が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/HouseBlCargoRegistrationAssociations/CreateByBookingNo |
ブッキング番号を指定して、帳票:NVC02を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:NVC02を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:NVC02が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/HouseBlCargoRegistrationAssociations/CreateByDomesticNo |
社内管理番号を指定して、帳票:NVC02を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:NVC02を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:NVC02が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/NaccsReport/HouseBlCargoRegistrationAssociations/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:NVC02を削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/NaccsReport/HouseBlCargoRegistrationAssociations/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
B/L番号を指定して、帳票:NVC02を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、帳票:NVC02を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/HouseBlCargoRegistrationAssociations/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId} |
ブッキング番号を指定して、帳票:NVC02を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:NVC02を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/HouseBlCargoRegistrationAssociations/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
取引管理番号を指定して、帳票:NVC02を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:NVC02を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/HouseBlCargoRegistrationAssociations/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
社内管理番号を指定して、帳票:NVC02を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:NVC02を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/NaccsReport/HouseBlCargoRegistrationAssociations/Get/{dealReportId} |
帳票:NVC02を取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/NaccsReport/HouseBlCargoRegistrationAssociations/GetByDealNo/{dealNo} |
取引管理番号を指定して、帳票:NVC02を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:NVC02を取得します。 |
|
GET | /API/v1/NaccsReport/HouseBlCargoRegistrationAssociations/GetListByBlNo/{blNo} |
B/L番号を指定して、帳票:NVC02を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、NVC02を取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が付番されている全ての取引から、帳票:NVC02を取得します。 |
|
GET | /API/v1/NaccsReport/HouseBlCargoRegistrationAssociations/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo} |
ブッキング番号を指定して、帳票:NVC02を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:NVC02を取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が付番されている全ての取引から、帳票:NVC02を取得します。 |
|
GET | /API/v1/NaccsReport/HouseBlCargoRegistrationAssociations/GetListByDomesticNo/{domesticNo} |
社内管理番号を指定して、帳票:NVC02を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:NVC02を取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:NVC02を取得します。 |
|
POST | /API/v1/NaccsReport/HouseBlCargoRegistrationAssociations/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/HouseBlCargoRegistrationAssociations/Register |
帳票:NVC02を保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
HouseBlCargoRegistrationCalls
NVC11
API | Description | ||
---|---|---|---|
POST | /API/v1/NaccsReport/HouseBlCargoRegistrationCalls/Create |
帳票:NVC11を作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 帳票:NVC11が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/HouseBlCargoRegistrationCalls/CreateByBlNo |
B/L番号を指定して、帳票:NVC11を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定されたB/L番号(***blNo***)に該当する取引に対して、帳票:NVC11を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定されたB/L番号(***blNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:NVC11が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/HouseBlCargoRegistrationCalls/CreateByBookingNo |
ブッキング番号を指定して、帳票:NVC11を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:NVC11を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:NVC11が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/HouseBlCargoRegistrationCalls/CreateByDomesticNo |
社内管理番号を指定して、帳票:NVC11を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:NVC11を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:NVC11が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/NaccsReport/HouseBlCargoRegistrationCalls/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:NVC11を削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/NaccsReport/HouseBlCargoRegistrationCalls/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
B/L番号を指定して、帳票:NVC11を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、帳票:NVC11を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/HouseBlCargoRegistrationCalls/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId} |
ブッキング番号を指定して、帳票:NVC11を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:NVC11を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/HouseBlCargoRegistrationCalls/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
取引管理番号を指定して、帳票:NVC11を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:NVC11を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/HouseBlCargoRegistrationCalls/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
社内管理番号を指定して、帳票:NVC11を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:NVC11を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/NaccsReport/HouseBlCargoRegistrationCalls/Get/{dealReportId} |
帳票:NVC11を取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/NaccsReport/HouseBlCargoRegistrationCalls/GetByDealNo/{dealNo} |
取引管理番号を指定して、帳票:NVC11を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:NVC11を取得します。 |
|
GET | /API/v1/NaccsReport/HouseBlCargoRegistrationCalls/GetListByBlNo/{blNo} |
B/L番号を指定して、帳票:NVC11を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、NVC11を取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が付番されている全ての取引から、帳票:NVC11を取得します。 |
|
GET | /API/v1/NaccsReport/HouseBlCargoRegistrationCalls/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo} |
ブッキング番号を指定して、帳票:NVC11を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:NVC11を取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が付番されている全ての取引から、帳票:NVC11を取得します。 |
|
GET | /API/v1/NaccsReport/HouseBlCargoRegistrationCalls/GetListByDomesticNo/{domesticNo} |
社内管理番号を指定して、帳票:NVC11を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:NVC11を取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:NVC11を取得します。 |
|
POST | /API/v1/NaccsReport/HouseBlCargoRegistrationCalls/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/HouseBlCargoRegistrationCalls/Register |
帳票:NVC11を保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
HouseBlCargoRegistrationRegisterCorrectDeletes
NVC01
API | Description | ||
---|---|---|---|
POST | /API/v1/NaccsReport/HouseBlCargoRegistrationRegisterCorrectDeletes/Create |
帳票:NVC01を作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 帳票:NVC01が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/HouseBlCargoRegistrationRegisterCorrectDeletes/CreateByBlNo |
B/L番号を指定して、帳票:NVC01を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定されたB/L番号(***blNo***)に該当する取引に対して、帳票:NVC01を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定されたB/L番号(***blNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:NVC01が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/HouseBlCargoRegistrationRegisterCorrectDeletes/CreateByBookingNo |
ブッキング番号を指定して、帳票:NVC01を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:NVC01を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:NVC01が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/HouseBlCargoRegistrationRegisterCorrectDeletes/CreateByDomesticNo |
社内管理番号を指定して、帳票:NVC01を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:NVC01を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:NVC01が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/NaccsReport/HouseBlCargoRegistrationRegisterCorrectDeletes/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:NVC01を削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/NaccsReport/HouseBlCargoRegistrationRegisterCorrectDeletes/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
B/L番号を指定して、帳票:NVC01を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、帳票:NVC01を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/HouseBlCargoRegistrationRegisterCorrectDeletes/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId} |
ブッキング番号を指定して、帳票:NVC01を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:NVC01を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/HouseBlCargoRegistrationRegisterCorrectDeletes/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
取引管理番号を指定して、帳票:NVC01を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:NVC01を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/HouseBlCargoRegistrationRegisterCorrectDeletes/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
社内管理番号を指定して、帳票:NVC01を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:NVC01を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/NaccsReport/HouseBlCargoRegistrationRegisterCorrectDeletes/Get/{dealReportId} |
帳票:NVC01を取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/NaccsReport/HouseBlCargoRegistrationRegisterCorrectDeletes/GetByDealNo/{dealNo} |
取引管理番号を指定して、帳票:NVC01を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:NVC01を取得します。 |
|
GET | /API/v1/NaccsReport/HouseBlCargoRegistrationRegisterCorrectDeletes/GetListByBlNo/{blNo} |
B/L番号を指定して、帳票:NVC01を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、NVC01を取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が付番されている全ての取引から、帳票:NVC01を取得します。 |
|
GET | /API/v1/NaccsReport/HouseBlCargoRegistrationRegisterCorrectDeletes/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo} |
ブッキング番号を指定して、帳票:NVC01を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:NVC01を取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が付番されている全ての取引から、帳票:NVC01を取得します。 |
|
GET | /API/v1/NaccsReport/HouseBlCargoRegistrationRegisterCorrectDeletes/GetListByDomesticNo/{domesticNo} |
社内管理番号を指定して、帳票:NVC01を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:NVC01を取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:NVC01を取得します。 |
|
POST | /API/v1/NaccsReport/HouseBlCargoRegistrationRegisterCorrectDeletes/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/HouseBlCargoRegistrationRegisterCorrectDeletes/Register |
帳票:NVC01を保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
IDA
IDA_輸入申告事項登録
API | Description | ||
---|---|---|---|
POST | /API/v1/NACCS/IDA/Create |
帳票:IDA_輸入申告事項登録を作成します。 帳票:IDA_輸入申告事項登録を作成します。帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対して、Write権限が必要です。また、取引内に帳票:IDA_輸入申告事項登録が存在する場合は、ステータスコード:200となり、Getメソッドと同じ動作となります。 |
|
DELETE | /API/v1/NACCS/IDA/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:IDA_輸入申告事項登録を削除します。 帳票:IDA_輸入申告事項登録を削除します。帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
GET | /API/v1/NACCS/IDA/Get/{dealReportId} |
帳票:IDA_輸入申告事項登録を取得します。 帳票:IDA_輸入申告事項登録を取得します。帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対して、Read権限が必要です。 |
IDA01
IDA01_輸入申告変更事項登録
API | Description | ||
---|---|---|---|
POST | /API/v1/NACCS/IDA01/Create |
帳票:IDA01_輸入申告変更事項登録を作成します。 帳票:IDA01_輸入申告変更事項登録を作成します。帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対して、Write権限が必要です。また、取引内に帳票:IDA01_輸入申告変更事項登録が存在する場合は、ステータスコード:200となり、Getメソッドと同じ動作となります。 |
|
DELETE | /API/v1/NACCS/IDA01/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:IDA01_輸入申告変更事項登録を削除します。 帳票:IDA01_輸入申告変更事項登録を削除します。帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
GET | /API/v1/NACCS/IDA01/Get/{dealReportId} |
帳票:IDA01_輸入申告変更事項登録を取得します。 帳票:IDA01_輸入申告変更事項登録を取得します。帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対して、Read権限が必要です。 |
ImportCargoCorrectionCalls
SAI11
API | Description | ||
---|---|---|---|
POST | /API/v1/NaccsReport/ImportCargoCorrectionCalls/Create |
帳票:SAI11を作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 帳票:SAI11が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/ImportCargoCorrectionCalls/CreateByBlNo |
B/L番号を指定して、帳票:SAI11を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定されたB/L番号(***blNo***)に該当する取引に対して、帳票:SAI11を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定されたB/L番号(***blNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:SAI11が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/ImportCargoCorrectionCalls/CreateByBookingNo |
ブッキング番号を指定して、帳票:SAI11を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:SAI11を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:SAI11が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/ImportCargoCorrectionCalls/CreateByDomesticNo |
社内管理番号を指定して、帳票:SAI11を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:SAI11を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:SAI11が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/NaccsReport/ImportCargoCorrectionCalls/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:SAI11を削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/NaccsReport/ImportCargoCorrectionCalls/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
B/L番号を指定して、帳票:SAI11を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、帳票:SAI11を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/ImportCargoCorrectionCalls/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId} |
ブッキング番号を指定して、帳票:SAI11を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:SAI11を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/ImportCargoCorrectionCalls/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
取引管理番号を指定して、帳票:SAI11を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:SAI11を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/ImportCargoCorrectionCalls/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
社内管理番号を指定して、帳票:SAI11を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:SAI11を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/NaccsReport/ImportCargoCorrectionCalls/Get/{dealReportId} |
帳票:SAI11を取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/NaccsReport/ImportCargoCorrectionCalls/GetByDealNo/{dealNo} |
取引管理番号を指定して、帳票:SAI11を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:SAI11を取得します。 |
|
GET | /API/v1/NaccsReport/ImportCargoCorrectionCalls/GetListByBlNo/{blNo} |
B/L番号を指定して、帳票:SAI11を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、SAI11を取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が付番されている全ての取引から、帳票:SAI11を取得します。 |
|
GET | /API/v1/NaccsReport/ImportCargoCorrectionCalls/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo} |
ブッキング番号を指定して、帳票:SAI11を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:SAI11を取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が付番されている全ての取引から、帳票:SAI11を取得します。 |
|
GET | /API/v1/NaccsReport/ImportCargoCorrectionCalls/GetListByDomesticNo/{domesticNo} |
社内管理番号を指定して、帳票:SAI11を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:SAI11を取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:SAI11を取得します。 |
|
POST | /API/v1/NaccsReport/ImportCargoCorrectionCalls/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/ImportCargoCorrectionCalls/Register |
帳票:SAI11を保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
ImportCargoCorrections
SAI
API | Description | ||
---|---|---|---|
POST | /API/v1/NaccsReport/ImportCargoCorrections/Create |
帳票:SAIを作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 帳票:SAIが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/ImportCargoCorrections/CreateByBlNo |
B/L番号を指定して、帳票:SAIを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定されたB/L番号(***blNo***)に該当する取引に対して、帳票:SAIを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定されたB/L番号(***blNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:SAIが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/ImportCargoCorrections/CreateByBookingNo |
ブッキング番号を指定して、帳票:SAIを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:SAIを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:SAIが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/ImportCargoCorrections/CreateByDomesticNo |
社内管理番号を指定して、帳票:SAIを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:SAIを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:SAIが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/NaccsReport/ImportCargoCorrections/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:SAIを削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/NaccsReport/ImportCargoCorrections/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
B/L番号を指定して、帳票:SAIを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、帳票:SAIを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/ImportCargoCorrections/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId} |
ブッキング番号を指定して、帳票:SAIを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:SAIを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/ImportCargoCorrections/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
取引管理番号を指定して、帳票:SAIを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:SAIを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/ImportCargoCorrections/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
社内管理番号を指定して、帳票:SAIを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:SAIを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/NaccsReport/ImportCargoCorrections/Get/{dealReportId} |
帳票:SAIを取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/NaccsReport/ImportCargoCorrections/GetByDealNo/{dealNo} |
取引管理番号を指定して、帳票:SAIを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:SAIを取得します。 |
|
GET | /API/v1/NaccsReport/ImportCargoCorrections/GetListByBlNo/{blNo} |
B/L番号を指定して、帳票:SAIを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、SAIを取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が付番されている全ての取引から、帳票:SAIを取得します。 |
|
GET | /API/v1/NaccsReport/ImportCargoCorrections/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo} |
ブッキング番号を指定して、帳票:SAIを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:SAIを取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が付番されている全ての取引から、帳票:SAIを取得します。 |
|
GET | /API/v1/NaccsReport/ImportCargoCorrections/GetListByDomesticNo/{domesticNo} |
社内管理番号を指定して、帳票:SAIを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:SAIを取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:SAIを取得します。 |
|
POST | /API/v1/NaccsReport/ImportCargoCorrections/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/ImportCargoCorrections/Register |
帳票:SAIを保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
ImportCargoDeliveryRegistrations
DOR
API | Description | ||
---|---|---|---|
POST | /API/v1/NaccsReport/ImportCargoDeliveryRegistrations/Create |
帳票:DORを作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 帳票:DORが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/ImportCargoDeliveryRegistrations/CreateByBlNo |
B/L番号を指定して、帳票:DORを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定されたB/L番号(***blNo***)に該当する取引に対して、帳票:DORを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定されたB/L番号(***blNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:DORが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/ImportCargoDeliveryRegistrations/CreateByBookingNo |
ブッキング番号を指定して、帳票:DORを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:DORを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:DORが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/ImportCargoDeliveryRegistrations/CreateByDomesticNo |
社内管理番号を指定して、帳票:DORを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:DORを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:DORが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/NaccsReport/ImportCargoDeliveryRegistrations/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:DORを削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/NaccsReport/ImportCargoDeliveryRegistrations/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
B/L番号を指定して、帳票:DORを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、帳票:DORを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/ImportCargoDeliveryRegistrations/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId} |
ブッキング番号を指定して、帳票:DORを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:DORを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/ImportCargoDeliveryRegistrations/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
取引管理番号を指定して、帳票:DORを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:DORを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/ImportCargoDeliveryRegistrations/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
社内管理番号を指定して、帳票:DORを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:DORを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/NaccsReport/ImportCargoDeliveryRegistrations/Get/{dealReportId} |
帳票:DORを取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/NaccsReport/ImportCargoDeliveryRegistrations/GetByDealNo/{dealNo} |
取引管理番号を指定して、帳票:DORを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:DORを取得します。 |
|
GET | /API/v1/NaccsReport/ImportCargoDeliveryRegistrations/GetListByBlNo/{blNo} |
B/L番号を指定して、帳票:DORを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、DORを取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が付番されている全ての取引から、帳票:DORを取得します。 |
|
GET | /API/v1/NaccsReport/ImportCargoDeliveryRegistrations/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo} |
ブッキング番号を指定して、帳票:DORを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:DORを取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が付番されている全ての取引から、帳票:DORを取得します。 |
|
GET | /API/v1/NaccsReport/ImportCargoDeliveryRegistrations/GetListByDomesticNo/{domesticNo} |
社内管理番号を指定して、帳票:DORを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:DORを取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:DORを取得します。 |
|
POST | /API/v1/NaccsReport/ImportCargoDeliveryRegistrations/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/ImportCargoDeliveryRegistrations/Register |
帳票:DORを保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
ImportContainerPickUpScheduleNotificationIdConfirmCalls
RST11
API | Description | ||
---|---|---|---|
POST | /API/v1/NaccsReport/ImportContainerPickUpScheduleNotificationIdConfirmCalls/Create |
帳票:RST11を作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 帳票:RST11が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/ImportContainerPickUpScheduleNotificationIdConfirmCalls/CreateByBlNo |
B/L番号を指定して、帳票:RST11を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定されたB/L番号(***blNo***)に該当する取引に対して、帳票:RST11を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定されたB/L番号(***blNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:RST11が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/ImportContainerPickUpScheduleNotificationIdConfirmCalls/CreateByBookingNo |
ブッキング番号を指定して、帳票:RST11を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:RST11を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:RST11が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/ImportContainerPickUpScheduleNotificationIdConfirmCalls/CreateByDomesticNo |
社内管理番号を指定して、帳票:RST11を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:RST11を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:RST11が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/NaccsReport/ImportContainerPickUpScheduleNotificationIdConfirmCalls/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:RST11を削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/NaccsReport/ImportContainerPickUpScheduleNotificationIdConfirmCalls/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
B/L番号を指定して、帳票:RST11を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、帳票:RST11を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/ImportContainerPickUpScheduleNotificationIdConfirmCalls/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId} |
ブッキング番号を指定して、帳票:RST11を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:RST11を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/ImportContainerPickUpScheduleNotificationIdConfirmCalls/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
取引管理番号を指定して、帳票:RST11を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:RST11を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/ImportContainerPickUpScheduleNotificationIdConfirmCalls/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
社内管理番号を指定して、帳票:RST11を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:RST11を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/NaccsReport/ImportContainerPickUpScheduleNotificationIdConfirmCalls/Get/{dealReportId} |
帳票:RST11を取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/NaccsReport/ImportContainerPickUpScheduleNotificationIdConfirmCalls/GetByDealNo/{dealNo} |
取引管理番号を指定して、帳票:RST11を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:RST11を取得します。 |
|
GET | /API/v1/NaccsReport/ImportContainerPickUpScheduleNotificationIdConfirmCalls/GetListByBlNo/{blNo} |
B/L番号を指定して、帳票:RST11を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、RST11を取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が付番されている全ての取引から、帳票:RST11を取得します。 |
|
GET | /API/v1/NaccsReport/ImportContainerPickUpScheduleNotificationIdConfirmCalls/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo} |
ブッキング番号を指定して、帳票:RST11を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:RST11を取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が付番されている全ての取引から、帳票:RST11を取得します。 |
|
GET | /API/v1/NaccsReport/ImportContainerPickUpScheduleNotificationIdConfirmCalls/GetListByDomesticNo/{domesticNo} |
社内管理番号を指定して、帳票:RST11を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:RST11を取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:RST11を取得します。 |
|
POST | /API/v1/NaccsReport/ImportContainerPickUpScheduleNotificationIdConfirmCalls/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/ImportContainerPickUpScheduleNotificationIdConfirmCalls/Register |
帳票:RST11を保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
ImportContainerPickUpScheduleNotificationIdConfirms
RST01
API | Description | ||
---|---|---|---|
POST | /API/v1/NaccsReport/ImportContainerPickUpScheduleNotificationIdConfirms/Create |
帳票:RST01を作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 帳票:RST01が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/ImportContainerPickUpScheduleNotificationIdConfirms/CreateByBlNo |
B/L番号を指定して、帳票:RST01を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定されたB/L番号(***blNo***)に該当する取引に対して、帳票:RST01を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定されたB/L番号(***blNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:RST01が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/ImportContainerPickUpScheduleNotificationIdConfirms/CreateByBookingNo |
ブッキング番号を指定して、帳票:RST01を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:RST01を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:RST01が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/ImportContainerPickUpScheduleNotificationIdConfirms/CreateByDomesticNo |
社内管理番号を指定して、帳票:RST01を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:RST01を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:RST01が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/NaccsReport/ImportContainerPickUpScheduleNotificationIdConfirms/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:RST01を削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/NaccsReport/ImportContainerPickUpScheduleNotificationIdConfirms/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
B/L番号を指定して、帳票:RST01を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、帳票:RST01を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/ImportContainerPickUpScheduleNotificationIdConfirms/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId} |
ブッキング番号を指定して、帳票:RST01を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:RST01を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/ImportContainerPickUpScheduleNotificationIdConfirms/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
取引管理番号を指定して、帳票:RST01を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:RST01を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/ImportContainerPickUpScheduleNotificationIdConfirms/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
社内管理番号を指定して、帳票:RST01を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:RST01を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/NaccsReport/ImportContainerPickUpScheduleNotificationIdConfirms/Get/{dealReportId} |
帳票:RST01を取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/NaccsReport/ImportContainerPickUpScheduleNotificationIdConfirms/GetByDealNo/{dealNo} |
取引管理番号を指定して、帳票:RST01を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:RST01を取得します。 |
|
GET | /API/v1/NaccsReport/ImportContainerPickUpScheduleNotificationIdConfirms/GetListByBlNo/{blNo} |
B/L番号を指定して、帳票:RST01を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、RST01を取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が付番されている全ての取引から、帳票:RST01を取得します。 |
|
GET | /API/v1/NaccsReport/ImportContainerPickUpScheduleNotificationIdConfirms/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo} |
ブッキング番号を指定して、帳票:RST01を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:RST01を取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が付番されている全ての取引から、帳票:RST01を取得します。 |
|
GET | /API/v1/NaccsReport/ImportContainerPickUpScheduleNotificationIdConfirms/GetListByDomesticNo/{domesticNo} |
社内管理番号を指定して、帳票:RST01を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:RST01を取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:RST01を取得します。 |
|
POST | /API/v1/NaccsReport/ImportContainerPickUpScheduleNotificationIdConfirms/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/ImportContainerPickUpScheduleNotificationIdConfirms/Register |
帳票:RST01を保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
ImportContainerPickUpScheduleNotificationIdNotificationCalls
RSS11
API | Description | ||
---|---|---|---|
POST | /API/v1/NaccsReport/ImportContainerPickUpScheduleNotificationIdNotificationCalls/Create |
帳票:RSS11を作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 帳票:RSS11が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/ImportContainerPickUpScheduleNotificationIdNotificationCalls/CreateByBlNo |
B/L番号を指定して、帳票:RSS11を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定されたB/L番号(***blNo***)に該当する取引に対して、帳票:RSS11を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定されたB/L番号(***blNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:RSS11が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/ImportContainerPickUpScheduleNotificationIdNotificationCalls/CreateByBookingNo |
ブッキング番号を指定して、帳票:RSS11を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:RSS11を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:RSS11が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/ImportContainerPickUpScheduleNotificationIdNotificationCalls/CreateByDomesticNo |
社内管理番号を指定して、帳票:RSS11を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:RSS11を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:RSS11が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/NaccsReport/ImportContainerPickUpScheduleNotificationIdNotificationCalls/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:RSS11を削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/NaccsReport/ImportContainerPickUpScheduleNotificationIdNotificationCalls/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
B/L番号を指定して、帳票:RSS11を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、帳票:RSS11を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/ImportContainerPickUpScheduleNotificationIdNotificationCalls/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId} |
ブッキング番号を指定して、帳票:RSS11を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:RSS11を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/ImportContainerPickUpScheduleNotificationIdNotificationCalls/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
取引管理番号を指定して、帳票:RSS11を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:RSS11を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/ImportContainerPickUpScheduleNotificationIdNotificationCalls/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
社内管理番号を指定して、帳票:RSS11を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:RSS11を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/NaccsReport/ImportContainerPickUpScheduleNotificationIdNotificationCalls/Get/{dealReportId} |
帳票:RSS11を取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/NaccsReport/ImportContainerPickUpScheduleNotificationIdNotificationCalls/GetByDealNo/{dealNo} |
取引管理番号を指定して、帳票:RSS11を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:RSS11を取得します。 |
|
GET | /API/v1/NaccsReport/ImportContainerPickUpScheduleNotificationIdNotificationCalls/GetListByBlNo/{blNo} |
B/L番号を指定して、帳票:RSS11を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、RSS11を取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が付番されている全ての取引から、帳票:RSS11を取得します。 |
|
GET | /API/v1/NaccsReport/ImportContainerPickUpScheduleNotificationIdNotificationCalls/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo} |
ブッキング番号を指定して、帳票:RSS11を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:RSS11を取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が付番されている全ての取引から、帳票:RSS11を取得します。 |
|
GET | /API/v1/NaccsReport/ImportContainerPickUpScheduleNotificationIdNotificationCalls/GetListByDomesticNo/{domesticNo} |
社内管理番号を指定して、帳票:RSS11を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:RSS11を取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:RSS11を取得します。 |
|
POST | /API/v1/NaccsReport/ImportContainerPickUpScheduleNotificationIdNotificationCalls/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/ImportContainerPickUpScheduleNotificationIdNotificationCalls/Register |
帳票:RSS11を保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
ImportContainerPickUpScheduleNotificationIdNotifications
RSS01
API | Description | ||
---|---|---|---|
POST | /API/v1/NaccsReport/ImportContainerPickUpScheduleNotificationIdNotifications/Create |
帳票:RSS01を作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 帳票:RSS01が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/ImportContainerPickUpScheduleNotificationIdNotifications/CreateByBlNo |
B/L番号を指定して、帳票:RSS01を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定されたB/L番号(***blNo***)に該当する取引に対して、帳票:RSS01を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定されたB/L番号(***blNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:RSS01が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/ImportContainerPickUpScheduleNotificationIdNotifications/CreateByBookingNo |
ブッキング番号を指定して、帳票:RSS01を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:RSS01を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:RSS01が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/ImportContainerPickUpScheduleNotificationIdNotifications/CreateByDomesticNo |
社内管理番号を指定して、帳票:RSS01を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:RSS01を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:RSS01が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/NaccsReport/ImportContainerPickUpScheduleNotificationIdNotifications/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:RSS01を削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/NaccsReport/ImportContainerPickUpScheduleNotificationIdNotifications/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
B/L番号を指定して、帳票:RSS01を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、帳票:RSS01を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/ImportContainerPickUpScheduleNotificationIdNotifications/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId} |
ブッキング番号を指定して、帳票:RSS01を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:RSS01を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/ImportContainerPickUpScheduleNotificationIdNotifications/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
取引管理番号を指定して、帳票:RSS01を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:RSS01を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/ImportContainerPickUpScheduleNotificationIdNotifications/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
社内管理番号を指定して、帳票:RSS01を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:RSS01を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/NaccsReport/ImportContainerPickUpScheduleNotificationIdNotifications/Get/{dealReportId} |
帳票:RSS01を取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/NaccsReport/ImportContainerPickUpScheduleNotificationIdNotifications/GetByDealNo/{dealNo} |
取引管理番号を指定して、帳票:RSS01を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:RSS01を取得します。 |
|
GET | /API/v1/NaccsReport/ImportContainerPickUpScheduleNotificationIdNotifications/GetListByBlNo/{blNo} |
B/L番号を指定して、帳票:RSS01を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、RSS01を取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が付番されている全ての取引から、帳票:RSS01を取得します。 |
|
GET | /API/v1/NaccsReport/ImportContainerPickUpScheduleNotificationIdNotifications/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo} |
ブッキング番号を指定して、帳票:RSS01を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:RSS01を取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が付番されている全ての取引から、帳票:RSS01を取得します。 |
|
GET | /API/v1/NaccsReport/ImportContainerPickUpScheduleNotificationIdNotifications/GetListByDomesticNo/{domesticNo} |
社内管理番号を指定して、帳票:RSS01を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:RSS01を取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:RSS01を取得します。 |
|
POST | /API/v1/NaccsReport/ImportContainerPickUpScheduleNotificationIdNotifications/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/ImportContainerPickUpScheduleNotificationIdNotifications/Register |
帳票:RSS01を保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
ImportContainerPickUpScheduleSelectionIdNotificationCalls
RSS12
API | Description | ||
---|---|---|---|
POST | /API/v1/NaccsReport/ImportContainerPickUpScheduleSelectionIdNotificationCalls/Create |
帳票:RSS12を作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 帳票:RSS12が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/ImportContainerPickUpScheduleSelectionIdNotificationCalls/CreateByBlNo |
B/L番号を指定して、帳票:RSS12を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定されたB/L番号(***blNo***)に該当する取引に対して、帳票:RSS12を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定されたB/L番号(***blNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:RSS12が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/ImportContainerPickUpScheduleSelectionIdNotificationCalls/CreateByBookingNo |
ブッキング番号を指定して、帳票:RSS12を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:RSS12を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:RSS12が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/ImportContainerPickUpScheduleSelectionIdNotificationCalls/CreateByDomesticNo |
社内管理番号を指定して、帳票:RSS12を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:RSS12を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:RSS12が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/NaccsReport/ImportContainerPickUpScheduleSelectionIdNotificationCalls/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:RSS12を削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/NaccsReport/ImportContainerPickUpScheduleSelectionIdNotificationCalls/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
B/L番号を指定して、帳票:RSS12を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、帳票:RSS12を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/ImportContainerPickUpScheduleSelectionIdNotificationCalls/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId} |
ブッキング番号を指定して、帳票:RSS12を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:RSS12を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/ImportContainerPickUpScheduleSelectionIdNotificationCalls/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
取引管理番号を指定して、帳票:RSS12を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:RSS12を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/ImportContainerPickUpScheduleSelectionIdNotificationCalls/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
社内管理番号を指定して、帳票:RSS12を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:RSS12を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/NaccsReport/ImportContainerPickUpScheduleSelectionIdNotificationCalls/Get/{dealReportId} |
帳票:RSS12を取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/NaccsReport/ImportContainerPickUpScheduleSelectionIdNotificationCalls/GetByDealNo/{dealNo} |
取引管理番号を指定して、帳票:RSS12を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:RSS12を取得します。 |
|
GET | /API/v1/NaccsReport/ImportContainerPickUpScheduleSelectionIdNotificationCalls/GetListByBlNo/{blNo} |
B/L番号を指定して、帳票:RSS12を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、RSS12を取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が付番されている全ての取引から、帳票:RSS12を取得します。 |
|
GET | /API/v1/NaccsReport/ImportContainerPickUpScheduleSelectionIdNotificationCalls/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo} |
ブッキング番号を指定して、帳票:RSS12を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:RSS12を取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が付番されている全ての取引から、帳票:RSS12を取得します。 |
|
GET | /API/v1/NaccsReport/ImportContainerPickUpScheduleSelectionIdNotificationCalls/GetListByDomesticNo/{domesticNo} |
社内管理番号を指定して、帳票:RSS12を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:RSS12を取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:RSS12を取得します。 |
|
POST | /API/v1/NaccsReport/ImportContainerPickUpScheduleSelectionIdNotificationCalls/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/ImportContainerPickUpScheduleSelectionIdNotificationCalls/Register |
帳票:RSS12を保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
ImportDeclarationCalls
IDB
API | Description | ||
---|---|---|---|
POST | /API/v1/NaccsReport/ImportDeclarationCalls/Create |
帳票:IDBを作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 帳票:IDBが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/ImportDeclarationCalls/CreateByBlNo |
B/L番号を指定して、帳票:IDBを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定されたB/L番号(***blNo***)に該当する取引に対して、帳票:IDBを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定されたB/L番号(***blNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:IDBが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/ImportDeclarationCalls/CreateByBookingNo |
ブッキング番号を指定して、帳票:IDBを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:IDBを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:IDBが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/ImportDeclarationCalls/CreateByDomesticNo |
社内管理番号を指定して、帳票:IDBを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:IDBを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:IDBが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/NaccsReport/ImportDeclarationCalls/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:IDBを削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/NaccsReport/ImportDeclarationCalls/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
B/L番号を指定して、帳票:IDBを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、帳票:IDBを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/ImportDeclarationCalls/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId} |
ブッキング番号を指定して、帳票:IDBを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:IDBを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/ImportDeclarationCalls/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
取引管理番号を指定して、帳票:IDBを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:IDBを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/ImportDeclarationCalls/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
社内管理番号を指定して、帳票:IDBを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:IDBを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/NaccsReport/ImportDeclarationCalls/Get/{dealReportId} |
帳票:IDBを取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/NaccsReport/ImportDeclarationCalls/GetByDealNo/{dealNo} |
取引管理番号を指定して、帳票:IDBを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:IDBを取得します。 |
|
GET | /API/v1/NaccsReport/ImportDeclarationCalls/GetListByBlNo/{blNo} |
B/L番号を指定して、帳票:IDBを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、IDBを取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が付番されている全ての取引から、帳票:IDBを取得します。 |
|
GET | /API/v1/NaccsReport/ImportDeclarationCalls/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo} |
ブッキング番号を指定して、帳票:IDBを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:IDBを取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が付番されている全ての取引から、帳票:IDBを取得します。 |
|
GET | /API/v1/NaccsReport/ImportDeclarationCalls/GetListByDomesticNo/{domesticNo} |
社内管理番号を指定して、帳票:IDBを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:IDBを取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:IDBを取得します。 |
|
POST | /API/v1/NaccsReport/ImportDeclarationCalls/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/ImportDeclarationCalls/Register |
帳票:IDBを保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
ImportDeclarationChangeCalls
IDD
API | Description | ||
---|---|---|---|
POST | /API/v1/NaccsReport/ImportDeclarationChangeCalls/Create |
帳票:IDDを作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 帳票:IDDが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/ImportDeclarationChangeCalls/CreateByBlNo |
B/L番号を指定して、帳票:IDDを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定されたB/L番号(***blNo***)に該当する取引に対して、帳票:IDDを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定されたB/L番号(***blNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:IDDが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/ImportDeclarationChangeCalls/CreateByBookingNo |
ブッキング番号を指定して、帳票:IDDを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:IDDを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:IDDが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/ImportDeclarationChangeCalls/CreateByDomesticNo |
社内管理番号を指定して、帳票:IDDを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:IDDを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:IDDが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/NaccsReport/ImportDeclarationChangeCalls/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:IDDを削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/NaccsReport/ImportDeclarationChangeCalls/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
B/L番号を指定して、帳票:IDDを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、帳票:IDDを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/ImportDeclarationChangeCalls/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId} |
ブッキング番号を指定して、帳票:IDDを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:IDDを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/ImportDeclarationChangeCalls/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
取引管理番号を指定して、帳票:IDDを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:IDDを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/ImportDeclarationChangeCalls/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
社内管理番号を指定して、帳票:IDDを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:IDDを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/NaccsReport/ImportDeclarationChangeCalls/Get/{dealReportId} |
帳票:IDDを取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/NaccsReport/ImportDeclarationChangeCalls/GetByDealNo/{dealNo} |
取引管理番号を指定して、帳票:IDDを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:IDDを取得します。 |
|
GET | /API/v1/NaccsReport/ImportDeclarationChangeCalls/GetListByBlNo/{blNo} |
B/L番号を指定して、帳票:IDDを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、IDDを取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が付番されている全ての取引から、帳票:IDDを取得します。 |
|
GET | /API/v1/NaccsReport/ImportDeclarationChangeCalls/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo} |
ブッキング番号を指定して、帳票:IDDを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:IDDを取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が付番されている全ての取引から、帳票:IDDを取得します。 |
|
GET | /API/v1/NaccsReport/ImportDeclarationChangeCalls/GetListByDomesticNo/{domesticNo} |
社内管理番号を指定して、帳票:IDDを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:IDDを取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:IDDを取得します。 |
|
POST | /API/v1/NaccsReport/ImportDeclarationChangeCalls/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/ImportDeclarationChangeCalls/Register |
帳票:IDDを保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
ImportDeclarationChangeRegistrations
IDA01
API | Description | ||
---|---|---|---|
POST | /API/v1/NaccsReport/ImportDeclarationChangeRegistrations/Create |
帳票:IDA01を作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 帳票:IDA01が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/ImportDeclarationChangeRegistrations/CreateByBlNo |
B/L番号を指定して、帳票:IDA01を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定されたB/L番号(***blNo***)に該当する取引に対して、帳票:IDA01を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定されたB/L番号(***blNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:IDA01が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/ImportDeclarationChangeRegistrations/CreateByBookingNo |
ブッキング番号を指定して、帳票:IDA01を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:IDA01を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:IDA01が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/ImportDeclarationChangeRegistrations/CreateByDomesticNo |
社内管理番号を指定して、帳票:IDA01を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:IDA01を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:IDA01が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/NaccsReport/ImportDeclarationChangeRegistrations/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:IDA01を削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/NaccsReport/ImportDeclarationChangeRegistrations/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
B/L番号を指定して、帳票:IDA01を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、帳票:IDA01を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/ImportDeclarationChangeRegistrations/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId} |
ブッキング番号を指定して、帳票:IDA01を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:IDA01を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/ImportDeclarationChangeRegistrations/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
取引管理番号を指定して、帳票:IDA01を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:IDA01を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/ImportDeclarationChangeRegistrations/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
社内管理番号を指定して、帳票:IDA01を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:IDA01を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/NaccsReport/ImportDeclarationChangeRegistrations/Get/{dealReportId} |
帳票:IDA01を取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/NaccsReport/ImportDeclarationChangeRegistrations/GetByDealNo/{dealNo} |
取引管理番号を指定して、帳票:IDA01を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:IDA01を取得します。 |
|
GET | /API/v1/NaccsReport/ImportDeclarationChangeRegistrations/GetListByBlNo/{blNo} |
B/L番号を指定して、帳票:IDA01を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、IDA01を取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が付番されている全ての取引から、帳票:IDA01を取得します。 |
|
GET | /API/v1/NaccsReport/ImportDeclarationChangeRegistrations/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo} |
ブッキング番号を指定して、帳票:IDA01を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:IDA01を取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が付番されている全ての取引から、帳票:IDA01を取得します。 |
|
GET | /API/v1/NaccsReport/ImportDeclarationChangeRegistrations/GetListByDomesticNo/{domesticNo} |
社内管理番号を指定して、帳票:IDA01を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:IDA01を取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:IDA01を取得します。 |
|
POST | /API/v1/NaccsReport/ImportDeclarationChangeRegistrations/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/ImportDeclarationChangeRegistrations/Register |
帳票:IDA01を保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
ImportDeclarationChanges
IDE
API | Description | ||
---|---|---|---|
POST | /API/v1/NaccsReport/ImportDeclarationChanges/Create |
帳票:IDEを作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 帳票:IDEが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/ImportDeclarationChanges/CreateByBlNo |
B/L番号を指定して、帳票:IDEを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定されたB/L番号(***blNo***)に該当する取引に対して、帳票:IDEを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定されたB/L番号(***blNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:IDEが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/ImportDeclarationChanges/CreateByBookingNo |
ブッキング番号を指定して、帳票:IDEを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:IDEを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:IDEが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/ImportDeclarationChanges/CreateByDomesticNo |
社内管理番号を指定して、帳票:IDEを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:IDEを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:IDEが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/NaccsReport/ImportDeclarationChanges/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:IDEを削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/NaccsReport/ImportDeclarationChanges/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
B/L番号を指定して、帳票:IDEを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、帳票:IDEを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/ImportDeclarationChanges/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId} |
ブッキング番号を指定して、帳票:IDEを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:IDEを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/ImportDeclarationChanges/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
取引管理番号を指定して、帳票:IDEを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:IDEを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/ImportDeclarationChanges/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
社内管理番号を指定して、帳票:IDEを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:IDEを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/NaccsReport/ImportDeclarationChanges/Get/{dealReportId} |
帳票:IDEを取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/NaccsReport/ImportDeclarationChanges/GetByDealNo/{dealNo} |
取引管理番号を指定して、帳票:IDEを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:IDEを取得します。 |
|
GET | /API/v1/NaccsReport/ImportDeclarationChanges/GetListByBlNo/{blNo} |
B/L番号を指定して、帳票:IDEを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、IDEを取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が付番されている全ての取引から、帳票:IDEを取得します。 |
|
GET | /API/v1/NaccsReport/ImportDeclarationChanges/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo} |
ブッキング番号を指定して、帳票:IDEを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:IDEを取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が付番されている全ての取引から、帳票:IDEを取得します。 |
|
GET | /API/v1/NaccsReport/ImportDeclarationChanges/GetListByDomesticNo/{domesticNo} |
社内管理番号を指定して、帳票:IDEを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:IDEを取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:IDEを取得します。 |
|
POST | /API/v1/NaccsReport/ImportDeclarationChanges/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/ImportDeclarationChanges/Register |
帳票:IDEを保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
ImportDeclarationInquiries
IID
API | Description | ||
---|---|---|---|
POST | /API/v1/NaccsReport/ImportDeclarationInquiries/Create |
帳票:IIDを作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 帳票:IIDが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/ImportDeclarationInquiries/CreateByBlNo |
B/L番号を指定して、帳票:IIDを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定されたB/L番号(***blNo***)に該当する取引に対して、帳票:IIDを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定されたB/L番号(***blNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:IIDが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/ImportDeclarationInquiries/CreateByBookingNo |
ブッキング番号を指定して、帳票:IIDを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:IIDを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:IIDが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/ImportDeclarationInquiries/CreateByDomesticNo |
社内管理番号を指定して、帳票:IIDを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:IIDを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:IIDが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/NaccsReport/ImportDeclarationInquiries/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:IIDを削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/NaccsReport/ImportDeclarationInquiries/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
B/L番号を指定して、帳票:IIDを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、帳票:IIDを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/ImportDeclarationInquiries/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId} |
ブッキング番号を指定して、帳票:IIDを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:IIDを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/ImportDeclarationInquiries/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
取引管理番号を指定して、帳票:IIDを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:IIDを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/ImportDeclarationInquiries/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
社内管理番号を指定して、帳票:IIDを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:IIDを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/NaccsReport/ImportDeclarationInquiries/Get/{dealReportId} |
帳票:IIDを取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/NaccsReport/ImportDeclarationInquiries/GetByDealNo/{dealNo} |
取引管理番号を指定して、帳票:IIDを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:IIDを取得します。 |
|
GET | /API/v1/NaccsReport/ImportDeclarationInquiries/GetListByBlNo/{blNo} |
B/L番号を指定して、帳票:IIDを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、IIDを取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が付番されている全ての取引から、帳票:IIDを取得します。 |
|
GET | /API/v1/NaccsReport/ImportDeclarationInquiries/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo} |
ブッキング番号を指定して、帳票:IIDを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:IIDを取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が付番されている全ての取引から、帳票:IIDを取得します。 |
|
GET | /API/v1/NaccsReport/ImportDeclarationInquiries/GetListByDomesticNo/{domesticNo} |
社内管理番号を指定して、帳票:IIDを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:IIDを取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:IIDを取得します。 |
|
POST | /API/v1/NaccsReport/ImportDeclarationInquiries/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/ImportDeclarationInquiries/Register |
帳票:IIDを保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
ImportDeclarationListInquiries
IDI
API | Description | ||
---|---|---|---|
POST | /API/v1/NaccsReport/ImportDeclarationListInquiries/Create |
帳票:IDIを作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 帳票:IDIが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/ImportDeclarationListInquiries/CreateByBlNo |
B/L番号を指定して、帳票:IDIを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定されたB/L番号(***blNo***)に該当する取引に対して、帳票:IDIを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定されたB/L番号(***blNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:IDIが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/ImportDeclarationListInquiries/CreateByBookingNo |
ブッキング番号を指定して、帳票:IDIを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:IDIを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:IDIが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/ImportDeclarationListInquiries/CreateByDomesticNo |
社内管理番号を指定して、帳票:IDIを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:IDIを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:IDIが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/NaccsReport/ImportDeclarationListInquiries/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:IDIを削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/NaccsReport/ImportDeclarationListInquiries/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
B/L番号を指定して、帳票:IDIを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、帳票:IDIを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/ImportDeclarationListInquiries/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId} |
ブッキング番号を指定して、帳票:IDIを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:IDIを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/ImportDeclarationListInquiries/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
取引管理番号を指定して、帳票:IDIを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:IDIを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/ImportDeclarationListInquiries/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
社内管理番号を指定して、帳票:IDIを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:IDIを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/NaccsReport/ImportDeclarationListInquiries/Get/{dealReportId} |
帳票:IDIを取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/NaccsReport/ImportDeclarationListInquiries/GetByDealNo/{dealNo} |
取引管理番号を指定して、帳票:IDIを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:IDIを取得します。 |
|
GET | /API/v1/NaccsReport/ImportDeclarationListInquiries/GetListByBlNo/{blNo} |
B/L番号を指定して、帳票:IDIを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、IDIを取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が付番されている全ての取引から、帳票:IDIを取得します。 |
|
GET | /API/v1/NaccsReport/ImportDeclarationListInquiries/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo} |
ブッキング番号を指定して、帳票:IDIを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:IDIを取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が付番されている全ての取引から、帳票:IDIを取得します。 |
|
GET | /API/v1/NaccsReport/ImportDeclarationListInquiries/GetListByDomesticNo/{domesticNo} |
社内管理番号を指定して、帳票:IDIを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:IDIを取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:IDIを取得します。 |
|
POST | /API/v1/NaccsReport/ImportDeclarationListInquiries/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/ImportDeclarationListInquiries/Register |
帳票:IDIを保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
ImportDeclarationRegistrations
IDA
API | Description | ||
---|---|---|---|
POST | /API/v1/NaccsReport/ImportDeclarationRegistrations/Create |
帳票:IDAを作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 帳票:IDAが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/ImportDeclarationRegistrations/CreateByBlNo |
B/L番号を指定して、帳票:IDAを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定されたB/L番号(***blNo***)に該当する取引に対して、帳票:IDAを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定されたB/L番号(***blNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:IDAが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/ImportDeclarationRegistrations/CreateByBookingNo |
ブッキング番号を指定して、帳票:IDAを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:IDAを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:IDAが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/ImportDeclarationRegistrations/CreateByDomesticNo |
社内管理番号を指定して、帳票:IDAを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:IDAを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:IDAが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/NaccsReport/ImportDeclarationRegistrations/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:IDAを削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/NaccsReport/ImportDeclarationRegistrations/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
B/L番号を指定して、帳票:IDAを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、帳票:IDAを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/ImportDeclarationRegistrations/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId} |
ブッキング番号を指定して、帳票:IDAを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:IDAを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/ImportDeclarationRegistrations/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
取引管理番号を指定して、帳票:IDAを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:IDAを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/ImportDeclarationRegistrations/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
社内管理番号を指定して、帳票:IDAを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:IDAを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/NaccsReport/ImportDeclarationRegistrations/Get/{dealReportId} |
帳票:IDAを取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/NaccsReport/ImportDeclarationRegistrations/GetByDealNo/{dealNo} |
取引管理番号を指定して、帳票:IDAを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:IDAを取得します。 |
|
GET | /API/v1/NaccsReport/ImportDeclarationRegistrations/GetListByBlNo/{blNo} |
B/L番号を指定して、帳票:IDAを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、IDAを取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が付番されている全ての取引から、帳票:IDAを取得します。 |
|
GET | /API/v1/NaccsReport/ImportDeclarationRegistrations/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo} |
ブッキング番号を指定して、帳票:IDAを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:IDAを取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が付番されている全ての取引から、帳票:IDAを取得します。 |
|
GET | /API/v1/NaccsReport/ImportDeclarationRegistrations/GetListByDomesticNo/{domesticNo} |
社内管理番号を指定して、帳票:IDAを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:IDAを取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:IDAを取得します。 |
|
POST | /API/v1/NaccsReport/ImportDeclarationRegistrations/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/ImportDeclarationRegistrations/Register |
帳票:IDAを保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
ImportDeclarations
IDC
API | Description | ||
---|---|---|---|
POST | /API/v1/NaccsReport/ImportDeclarations/Create |
帳票:IDCを作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 帳票:IDCが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/ImportDeclarations/CreateByBlNo |
B/L番号を指定して、帳票:IDCを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定されたB/L番号(***blNo***)に該当する取引に対して、帳票:IDCを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定されたB/L番号(***blNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:IDCが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/ImportDeclarations/CreateByBookingNo |
ブッキング番号を指定して、帳票:IDCを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:IDCを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:IDCが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/ImportDeclarations/CreateByDomesticNo |
社内管理番号を指定して、帳票:IDCを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:IDCを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:IDCが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/NaccsReport/ImportDeclarations/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:IDCを削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/NaccsReport/ImportDeclarations/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
B/L番号を指定して、帳票:IDCを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、帳票:IDCを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/ImportDeclarations/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId} |
ブッキング番号を指定して、帳票:IDCを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:IDCを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/ImportDeclarations/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
取引管理番号を指定して、帳票:IDCを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:IDCを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/ImportDeclarations/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
社内管理番号を指定して、帳票:IDCを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:IDCを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/NaccsReport/ImportDeclarations/Get/{dealReportId} |
帳票:IDCを取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/NaccsReport/ImportDeclarations/GetByDealNo/{dealNo} |
取引管理番号を指定して、帳票:IDCを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:IDCを取得します。 |
|
GET | /API/v1/NaccsReport/ImportDeclarations/GetListByBlNo/{blNo} |
B/L番号を指定して、帳票:IDCを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、IDCを取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が付番されている全ての取引から、帳票:IDCを取得します。 |
|
GET | /API/v1/NaccsReport/ImportDeclarations/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo} |
ブッキング番号を指定して、帳票:IDCを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:IDCを取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が付番されている全ての取引から、帳票:IDCを取得します。 |
|
GET | /API/v1/NaccsReport/ImportDeclarations/GetListByDomesticNo/{domesticNo} |
社内管理番号を指定して、帳票:IDCを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:IDCを取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:IDCを取得します。 |
|
POST | /API/v1/NaccsReport/ImportDeclarations/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/ImportDeclarations/Register |
帳票:IDCを保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
ImportInstructions
輸入指図書
API | Description | ||
---|---|---|---|
POST | /API/v1/Report/ImportInstructions/Create |
帳票:輸入指図書を作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 帳票:輸入指図書が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/Report/ImportInstructions/CreateAttachFileMeta |
添付ファイルメタ情報を登録します。 |
|
POST | /API/v1/Report/ImportInstructions/CreateByBlNo |
B/L番号を指定して、帳票:輸入指図書を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定されたB/L番号(***blNo***)に該当する取引に対して、帳票:輸入指図書を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定されたB/L番号(***blNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:輸入指図書が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/Report/ImportInstructions/CreateByBookingNo |
ブッキング番号を指定して、帳票:輸入指図書を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:輸入指図書を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:輸入指図書が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/Report/ImportInstructions/CreateByDomesticNo |
社内管理番号を指定して、帳票:輸入指図書を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:輸入指図書を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:輸入指図書が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/Report/ImportInstructions/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:輸入指図書を削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/Report/ImportInstructions/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
B/L番号を指定して、帳票:輸入指図書を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、帳票:輸入指図書を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/Report/ImportInstructions/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId} |
ブッキング番号を指定して、帳票:輸入指図書を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:輸入指図書を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/Report/ImportInstructions/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
取引管理番号を指定して、帳票:輸入指図書を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:輸入指図書を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/Report/ImportInstructions/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
社内管理番号を指定して、帳票:輸入指図書を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:輸入指図書を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/Report/ImportInstructions/Get/{dealReportId} |
帳票:輸入指図書を取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/Report/ImportInstructions/GetAttachFileMetaList/{dealReportId} |
添付ファイル情報一覧を取得します。 |
|
GET | /API/v1/Report/ImportInstructions/GetByDealNo/{dealNo} |
取引管理番号を指定して、帳票:輸入指図書を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:輸入指図書を取得します。 |
|
GET | /API/v1/Report/ImportInstructions/GetListByBlNo/{blNo} |
B/L番号を指定して、帳票:輸入指図書を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、輸入指図書を取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が付番されている全ての取引から、帳票:輸入指図書を取得します。 |
|
GET | /API/v1/Report/ImportInstructions/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo} |
ブッキング番号を指定して、帳票:輸入指図書を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:輸入指図書を取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が付番されている全ての取引から、帳票:輸入指図書を取得します。 |
|
GET | /API/v1/Report/ImportInstructions/GetListByDomesticNo/{domesticNo} |
社内管理番号を指定して、帳票:輸入指図書を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:輸入指図書を取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:輸入指図書を取得します。 |
|
POST | /API/v1/Report/ImportInstructions/Register |
帳票:輸入指図書を保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
IVA
IVA_インボイス・パッキングリスト情報登録
API | Description | ||
---|---|---|---|
POST | /API/v1/NACCS/IVA/Create |
帳票:IVA_インボイス・パッキングリスト情報登録を作成します。 帳票:IVA_インボイス・パッキングリスト情報登録を作成します。帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対して、Write権限が必要です。また、取引内に帳票:IVA_インボイス・パッキングリスト情報登録が存在する場合は、ステータスコード:200となり、Getメソッドと同じ動作となります。 |
|
DELETE | /API/v1/NACCS/IVA/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:IVA_インボイス・パッキングリスト情報登録を削除します。 帳票:IVA_インボイス・パッキングリスト情報登録を削除します。帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
GET | /API/v1/NACCS/IVA/Get/{dealReportId} |
帳票:IVA_インボイス・パッキングリスト情報登録を取得します。 帳票:IVA_インボイス・パッキングリスト情報登録を取得します。帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対して、Read権限が必要です。 |
IVB
IVB_インボイス・パッキングリスト仕分情報登録
API | Description | ||
---|---|---|---|
POST | /API/v1/NACCS/IVB/Create |
帳票:IVB_インボイス・パッキングリスト仕分情報登録を作成します。 帳票:IVB_インボイス・パッキングリスト仕分情報登録を作成します。帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対して、Write権限が必要です。また、取引内に帳票:IVB_インボイス・パッキングリスト仕分情報登録が存在する場合は、ステータスコード:200となり、Getメソッドと同じ動作となります。 |
|
DELETE | /API/v1/NACCS/IVB/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:IVB_インボイス・パッキングリスト仕分情報登録を削除します。 帳票:IVB_インボイス・パッキングリスト仕分情報登録を削除します。帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
GET | /API/v1/NACCS/IVB/Get/{dealReportId} |
帳票:IVB_インボイス・パッキングリスト仕分情報登録を取得します。 帳票:IVB_インボイス・パッキングリスト仕分情報登録を取得します。帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対して、Read権限が必要です。 |
MatchingResults
照合結果
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でのレスポンスデータを編集し、指定するようにしてください。 |
MFR
MFR_積荷目録情報登録
API | Description | ||
---|---|---|---|
POST | /API/v1/NACCS/MFR/Create |
帳票:MFR_積荷目録情報登録を作成します。 帳票:MFR_積荷目録情報登録を作成します。帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対して、Write権限が必要です。また、取引内に帳票:MFR_積荷目録情報登録が存在する場合は、ステータスコード:200となり、Getメソッドと同じ動作となります。 |
|
DELETE | /API/v1/NACCS/MFR/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:MFR_積荷目録情報登録を削除します。 帳票:MFR_積荷目録情報登録を削除します。帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
GET | /API/v1/NACCS/MFR/Get/{dealReportId} |
帳票:MFR_積荷目録情報登録を取得します。 帳票:MFR_積荷目録情報登録を取得します。帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対して、Read権限が必要です。 |
ModifiedDeclarationCalls
AMB
API | Description | ||
---|---|---|---|
POST | /API/v1/NaccsReport/ModifiedDeclarationCalls/Create |
帳票:AMBを作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 帳票:AMBが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/ModifiedDeclarationCalls/CreateByBlNo |
B/L番号を指定して、帳票:AMBを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定されたB/L番号(***blNo***)に該当する取引に対して、帳票:AMBを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定されたB/L番号(***blNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:AMBが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/ModifiedDeclarationCalls/CreateByBookingNo |
ブッキング番号を指定して、帳票:AMBを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:AMBを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:AMBが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/ModifiedDeclarationCalls/CreateByDomesticNo |
社内管理番号を指定して、帳票:AMBを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:AMBを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:AMBが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/NaccsReport/ModifiedDeclarationCalls/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:AMBを削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/NaccsReport/ModifiedDeclarationCalls/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
B/L番号を指定して、帳票:AMBを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、帳票:AMBを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/ModifiedDeclarationCalls/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId} |
ブッキング番号を指定して、帳票:AMBを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:AMBを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/ModifiedDeclarationCalls/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
取引管理番号を指定して、帳票:AMBを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:AMBを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/ModifiedDeclarationCalls/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
社内管理番号を指定して、帳票:AMBを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:AMBを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/NaccsReport/ModifiedDeclarationCalls/Get/{dealReportId} |
帳票:AMBを取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/NaccsReport/ModifiedDeclarationCalls/GetByDealNo/{dealNo} |
取引管理番号を指定して、帳票:AMBを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:AMBを取得します。 |
|
GET | /API/v1/NaccsReport/ModifiedDeclarationCalls/GetListByBlNo/{blNo} |
B/L番号を指定して、帳票:AMBを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、AMBを取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が付番されている全ての取引から、帳票:AMBを取得します。 |
|
GET | /API/v1/NaccsReport/ModifiedDeclarationCalls/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo} |
ブッキング番号を指定して、帳票:AMBを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:AMBを取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が付番されている全ての取引から、帳票:AMBを取得します。 |
|
GET | /API/v1/NaccsReport/ModifiedDeclarationCalls/GetListByDomesticNo/{domesticNo} |
社内管理番号を指定して、帳票:AMBを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:AMBを取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:AMBを取得します。 |
|
POST | /API/v1/NaccsReport/ModifiedDeclarationCalls/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/ModifiedDeclarationCalls/Register |
帳票:AMBを保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
ModifiedDeclarationRegistrations
AMA
API | Description | ||
---|---|---|---|
POST | /API/v1/NaccsReport/ModifiedDeclarationRegistrations/Create |
帳票:AMAを作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 帳票:AMAが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/ModifiedDeclarationRegistrations/CreateByBlNo |
B/L番号を指定して、帳票:AMAを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定されたB/L番号(***blNo***)に該当する取引に対して、帳票:AMAを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定されたB/L番号(***blNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:AMAが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/ModifiedDeclarationRegistrations/CreateByBookingNo |
ブッキング番号を指定して、帳票:AMAを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:AMAを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:AMAが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/ModifiedDeclarationRegistrations/CreateByDomesticNo |
社内管理番号を指定して、帳票:AMAを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:AMAを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:AMAが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/NaccsReport/ModifiedDeclarationRegistrations/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:AMAを削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/NaccsReport/ModifiedDeclarationRegistrations/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
B/L番号を指定して、帳票:AMAを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、帳票:AMAを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/ModifiedDeclarationRegistrations/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId} |
ブッキング番号を指定して、帳票:AMAを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:AMAを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/ModifiedDeclarationRegistrations/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
取引管理番号を指定して、帳票:AMAを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:AMAを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/ModifiedDeclarationRegistrations/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
社内管理番号を指定して、帳票:AMAを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:AMAを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/NaccsReport/ModifiedDeclarationRegistrations/Get/{dealReportId} |
帳票:AMAを取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/NaccsReport/ModifiedDeclarationRegistrations/GetByDealNo/{dealNo} |
取引管理番号を指定して、帳票:AMAを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:AMAを取得します。 |
|
GET | /API/v1/NaccsReport/ModifiedDeclarationRegistrations/GetListByBlNo/{blNo} |
B/L番号を指定して、帳票:AMAを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、AMAを取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が付番されている全ての取引から、帳票:AMAを取得します。 |
|
GET | /API/v1/NaccsReport/ModifiedDeclarationRegistrations/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo} |
ブッキング番号を指定して、帳票:AMAを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:AMAを取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が付番されている全ての取引から、帳票:AMAを取得します。 |
|
GET | /API/v1/NaccsReport/ModifiedDeclarationRegistrations/GetListByDomesticNo/{domesticNo} |
社内管理番号を指定して、帳票:AMAを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:AMAを取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:AMAを取得します。 |
|
POST | /API/v1/NaccsReport/ModifiedDeclarationRegistrations/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/ModifiedDeclarationRegistrations/Register |
帳票:AMAを保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
ModifiedDeclarations
AMC
API | Description | ||
---|---|---|---|
POST | /API/v1/NaccsReport/ModifiedDeclarations/Create |
帳票:AMCを作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 帳票:AMCが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/ModifiedDeclarations/CreateByBlNo |
B/L番号を指定して、帳票:AMCを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定されたB/L番号(***blNo***)に該当する取引に対して、帳票:AMCを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定されたB/L番号(***blNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:AMCが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/ModifiedDeclarations/CreateByBookingNo |
ブッキング番号を指定して、帳票:AMCを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:AMCを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:AMCが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/ModifiedDeclarations/CreateByDomesticNo |
社内管理番号を指定して、帳票:AMCを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:AMCを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:AMCが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/NaccsReport/ModifiedDeclarations/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:AMCを削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/NaccsReport/ModifiedDeclarations/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
B/L番号を指定して、帳票:AMCを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、帳票:AMCを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/ModifiedDeclarations/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId} |
ブッキング番号を指定して、帳票:AMCを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:AMCを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/ModifiedDeclarations/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
取引管理番号を指定して、帳票:AMCを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:AMCを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/ModifiedDeclarations/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
社内管理番号を指定して、帳票:AMCを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:AMCを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/NaccsReport/ModifiedDeclarations/Get/{dealReportId} |
帳票:AMCを取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/NaccsReport/ModifiedDeclarations/GetByDealNo/{dealNo} |
取引管理番号を指定して、帳票:AMCを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:AMCを取得します。 |
|
GET | /API/v1/NaccsReport/ModifiedDeclarations/GetListByBlNo/{blNo} |
B/L番号を指定して、帳票:AMCを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、AMCを取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が付番されている全ての取引から、帳票:AMCを取得します。 |
|
GET | /API/v1/NaccsReport/ModifiedDeclarations/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo} |
ブッキング番号を指定して、帳票:AMCを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:AMCを取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が付番されている全ての取引から、帳票:AMCを取得します。 |
|
GET | /API/v1/NaccsReport/ModifiedDeclarations/GetListByDomesticNo/{domesticNo} |
社内管理番号を指定して、帳票:AMCを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:AMCを取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:AMCを取得します。 |
|
POST | /API/v1/NaccsReport/ModifiedDeclarations/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/ModifiedDeclarations/Register |
帳票:AMCを保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
MultimodalTransportBillOfLadings
複合運送証券
API | Description | ||
---|---|---|---|
POST | /API/v1/Report/MultimodalTransportBillOfLadings/Create |
帳票:複合運送証券を作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 帳票:複合運送証券が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/Report/MultimodalTransportBillOfLadings/CreateAttachFileMeta |
添付ファイルメタ情報を登録します。 |
|
POST | /API/v1/Report/MultimodalTransportBillOfLadings/CreateByBlNo |
B/L番号を指定して、帳票:複合運送証券を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定されたB/L番号(***blNo***)に該当する取引に対して、帳票:複合運送証券を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定されたB/L番号(***blNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:複合運送証券が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/Report/MultimodalTransportBillOfLadings/CreateByBookingNo |
ブッキング番号を指定して、帳票:複合運送証券を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:複合運送証券を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:複合運送証券が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/Report/MultimodalTransportBillOfLadings/CreateByDomesticNo |
社内管理番号を指定して、帳票:複合運送証券を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:複合運送証券を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:複合運送証券が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/Report/MultimodalTransportBillOfLadings/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:複合運送証券を削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/Report/MultimodalTransportBillOfLadings/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
B/L番号を指定して、帳票:複合運送証券を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、帳票:複合運送証券を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/Report/MultimodalTransportBillOfLadings/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId} |
ブッキング番号を指定して、帳票:複合運送証券を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:複合運送証券を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/Report/MultimodalTransportBillOfLadings/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
取引管理番号を指定して、帳票:複合運送証券を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:複合運送証券を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/Report/MultimodalTransportBillOfLadings/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
社内管理番号を指定して、帳票:複合運送証券を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:複合運送証券を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/Report/MultimodalTransportBillOfLadings/Get/{dealReportId} |
帳票:複合運送証券を取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/Report/MultimodalTransportBillOfLadings/GetAttachFileMetaList/{dealReportId} |
添付ファイル情報一覧を取得します。 |
|
GET | /API/v1/Report/MultimodalTransportBillOfLadings/GetByDealNo/{dealNo} |
取引管理番号を指定して、帳票:複合運送証券を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:複合運送証券を取得します。 |
|
GET | /API/v1/Report/MultimodalTransportBillOfLadings/GetListByBlNo/{blNo} |
B/L番号を指定して、帳票:複合運送証券を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、複合運送証券を取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が付番されている全ての取引から、帳票:複合運送証券を取得します。 |
|
GET | /API/v1/Report/MultimodalTransportBillOfLadings/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo} |
ブッキング番号を指定して、帳票:複合運送証券を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:複合運送証券を取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が付番されている全ての取引から、帳票:複合運送証券を取得します。 |
|
GET | /API/v1/Report/MultimodalTransportBillOfLadings/GetListByDomesticNo/{domesticNo} |
社内管理番号を指定して、帳票:複合運送証券を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:複合運送証券を取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:複合運送証券を取得します。 |
|
POST | /API/v1/Report/MultimodalTransportBillOfLadings/Register |
帳票:複合運送証券を保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
NaccsAttachFileAdditionalInfos
NACCS連携添付ファイル付加情報
API | Description | ||
---|---|---|---|
DELETE | /API/v1/NACCS/NaccsAttachFileAdditionalInfos/Delete/{fileId} |
NACCS連携添付ファイル付加情報を削除します。 |
|
GET | /API/v1/NACCS/NaccsAttachFileAdditionalInfos/Get/{fileId} |
NACCS連携添付ファイル付加情報を取得します |
|
POST | /API/v1/NACCS/NaccsAttachFileAdditionalInfos/Register |
NACCS連携添付ファイル付加情報を登録します。 |
NaccsItemMasters
NACCS項目マスタ
API | Description | ||
---|---|---|---|
GET | /API/v1/Master/NaccsItemMasters/Get/{reportCode} |
Naccs項目マスタ取得 |
|
GET | /API/v1/Master/NaccsItemMasters/GetList?filter={filter}&orderby={orderby} |
Naccs項目マスタ一覧取得 |
NaccsMessageMasters
NACCSメッセージマスタ
API | Description | ||
---|---|---|---|
GET | /API/v1/Master/NaccsMessageMasters/Get/{naccsBusinessCode} |
Naccsメッセージマスタ取得 |
|
GET | /API/v1/Master/NaccsMessageMasters/GetList?filter={filter}&orderby={orderby} |
Naccsメッセージマスタ一覧取得 |
NaccsReceiveDatas
NACCS受信データ
API | Description | ||
---|---|---|---|
GET | /API/v1/NACCS/NaccsReceiveDatas/GetByInputInfoSpecificNo/{naccsBusinessCode}?naccsUserCode={naccsUserCode}&inputInfoSpecificNo={inputInfoSpecificNo} |
NACCSから受信したデータをEDI形式で、入力情報特定番号単位に一括取得します。 ## 概要 NACCSから受信したデータをNACCS業務コード(***naccsBusinessCode***)、NACCS利用者コード(***naccsUserCode***)、入力情報特定番号(***inputInfoSpecificNo***)を指定して取得します。 取得したデータはEDI電文の形式です。 処理結果と出力情報の様に2種類ある場合は、List形式で一括取得されます。 また継続電文は1つのEDIデータにまとまって取得されますが、1つのEDIデータが1.8MBを超える場合には複数に分割されます。 ## 指定するパラメタについて ### NACCS業務コード 取得するEDIデータのNACCS業務コード(***naccsBusinessCode***)を必ず指定します。 ### NACCS利用者コード ユーザと紐づいているNACCS利用者コード(***naccsUserCode***)を必ず指定します。 指定したNACCS利用者コードがユーザと紐づいているNACCS利用者コードで無い場合エラーとなります。 ### 入力情報特定番号 取得するEDIデータの入力情報特定番号(***inputInfoSpecificNo***)を必ず指定します。 入力情報特定番号は、NACCSへの送信時に割り当てられています。 |
|
GET | /API/v1/NACCS/NaccsReceiveDatas/GetEdiList/{naccsBusinessCode}?naccsOutputInfoCode={naccsOutputInfoCode}&naccsUserCode={naccsUserCode}&inputInfoSpecificNo={inputInfoSpecificNo} |
NACCSから受信したデータをEDI形式で取得します。 ## 概要 NACCSから受信したデータをNACCS業務コード(***naccsBusinessCode***)、NACCS出力情報コード(***naccsOutputInfoCode***)、NACCS利用者コード(***naccsUserCode***)、入力情報特定番号(***inputInfoSpecificNo***)を指定して取得します。 取得したデータはEDI電文の形式です。 継続電文は1つのEDIデータにまとまって取得されますが、1つのEDIデータが1.8MBを超える場合には複数に分割されます。 ## 指定するパラメタについて ### NACCS業務コード 取得するEDIデータのNACCS業務コード(***naccsBusinessCode***)を必ず指定します。 ### NACCS出力情報コード 取得するEDIデータのNACCS業務コード(***naccsBusinessCode***)のNACCS出力情報コード(***naccsOutputInfoCode***)を必ず指定します。 ### NACCS利用者コード ユーザと紐づいているNACCS利用者コード(***naccsUserCode***)を必ず指定します。 指定したNACCS利用者コードがユーザと紐づいているNACCS利用者コードで無い場合エラーとなります。 ### 入力情報特定番号 取得するEDIデータの入力情報特定番号(***inputInfoSpecificNo***)を必ず指定します。 入力情報特定番号は、NACCSへの送信時に割り当てられています。 |
|
GET | /API/v1/NACCS/NaccsReceiveDatas/GetExcelReport/{naccsBusinessCode}?naccsOutputInfoCode={naccsOutputInfoCode}&naccsUserCode={naccsUserCode}&inputInfoSpecificNo={inputInfoSpecificNo} |
NACCSから受信したデータをExcelフォーマットで取得します。 ## 概要 NACCSから受信したデータをNACCS業務コード(***naccsBusinessCode***)、NACCS出力情報コード(***naccsOutputInfoCode***)、NACCS利用者コード(***naccsUserCode***)、入力情報特定番号(***inputInfoSpecificNo***)を指定してExcelフォーマットで取得します。 取得したデータはバイナリ形式です。 ***※このAPIは、Swagger上ではレスポンスを取得できません。*** ## 指定するパラメタについて ### NACCS業務コード 取得するEDIデータのNACCS業務コード(***naccsBusinessCode***)を必ず指定します。 ### NACCS出力情報コード 取得するEDIデータのNACCS業務コード(***naccsBusinessCode***)のNACCS出力情報コード(***naccsOutputInfoCode***)を必ず指定します。 ### NACCS利用者コード ユーザと紐づいているNACCS利用者コード(***naccsUserCode***)を必ず指定します。 指定したNACCS利用者コードがユーザと紐づいているNACCS利用者コードで無い場合エラーとなります。 ### 入力情報特定番号 取得するEDIデータの入力情報特定番号(***inputInfoSpecificNo***)を必ず指定します。 入力情報特定番号は、NACCSへの送信時に割り当てられています。 ## レスポンス例 (Responses Code : 200) ### Response headers content-disposition: attachment; filename=SAE1LF.xlsx ※filenameの形式は「NACCS出力情報コード.xlsx」です。 content-type: application/octet-stream ### Response body バイナリデータ |
|
GET | /API/v1/NACCS/NaccsReceiveDatas/GetJson/{naccsBusinessCode}?naccsOutputInfoCode={naccsOutputInfoCode}&naccsUserCode={naccsUserCode}&inputInfoSpecificNo={inputInfoSpecificNo} |
NACCSから受信したデータをJSON形式で取得します。 ## 概要 NACCSから受信したデータをNACCS業務コード(***naccsBusinessCode***)、NACCS出力情報コード(***naccsOutputInfoCode***)、NACCS利用者コード(***naccsUserCode***)、入力情報特定番号(***inputInfoSpecificNo***)を指定して取得します。 取得したデータはJSONの形式です。 取得可能なデータは、照会業務と呼出業務の出力情報と、輸出入申告の許可通知・申告控え情報です。 詳細はマニュアルを参照してください。 ## 指定するパラメタについて ### NACCS業務コード 取得するEDIデータのNACCS業務コード(***naccsBusinessCode***)を必ず指定します。 ### NACCS出力情報コード 取得するEDIデータのNACCS業務コード(***naccsBusinessCode***)のNACCS出力情報コード(***naccsOutputInfoCode***)を必ず指定します。 ### NACCS利用者コード ユーザと紐づいているNACCS利用者コード(***naccsUserCode***)を必ず指定します。 指定したNACCS利用者コードがユーザと紐づいているNACCS利用者コードで無い場合エラーとなります。 ### 入力情報特定番号 取得するEDIデータの入力情報特定番号(***inputInfoSpecificNo***)を必ず指定します。 入力情報特定番号は、NACCSへの送信時に割り当てられています。 |
NaccsSendPermissions
NACCS連携送信権限マスタ
API | Description | ||
---|---|---|---|
GET | /API/v1/Master/NaccsSendPermissions/Get/{naccsSendPermissionId} |
NACCS連携送信権限マスタから、送信権限ID(naccsSendPermissionId)を指定して、送信権限を取得します。 このマスタは、業務パターン毎に、送信権限(S権限)を管理します。 |
|
GET | /API/v1/Master/NaccsSendPermissions/GetList?filter={filter}&orderby={orderby} |
NACCS連携送信権限一覧取得 |
NaccsShutdownSchedules
NACCS停止スケジュール
API | Description | ||
---|---|---|---|
GET | /API/v1/Master/NaccsShutdownSchedules/Get/{scheduleNo} |
スケジュールNoを指定してNACCS停止スケジュールを取得する。 |
|
GET | /API/v1/Master/NaccsShutdownSchedules/GetList?filter={filter}&orderby={orderby} |
NACCS停止スケジュールをフィルター条件を付けて取得する。 |
NaccsUserInfos
NACCS利用者情報
API | Description | ||
---|---|---|---|
GET | /API/v1/Master/NaccsUserInfos/Get/{employeeId} |
NACCS利用者情報取得 |
|
GET | /API/v1/Master/NaccsUserInfos/GetList?filter={filter}&orderby={orderby} |
NACCS利用者情報一覧取得 |
NaccsUserRegisters
NACCS利用者登録
API | Description | ||
---|---|---|---|
GET | /API/v1/Master/NaccsUserRegisters/Get/{naccsUserId} |
NACCS利用者登録情報取得 |
|
GET | /API/v1/Master/NaccsUserRegisters/GetList?filter={filter}&orderby={orderby} |
NACCS利用者登録情報一覧取得 |
Notifications
未読通知
API | Description | ||
---|---|---|---|
GET | /API/v1/Notifications/GetByDealReportHistoryId/{dealReportHistoryId} |
取引・帳票履歴IDを指定して、通知を取得します。 |
|
GET | /API/v1/Notifications/GetCount?filter={filter} |
検索条件を指定して、条件に該当する未読通知の件数を取得します。 ## 概要 ユーザが宛先の未読通知について、検索条件を指定して、条件に該当する未読通知の件数を取得します。 検索条件の指定方法については、[こちらを参照ください](https://docs.microsoft.com/ja-jp/graph/query-parameters#filter-parameter)。 |
|
GET | /API/v1/Notifications/GetList?filter={filter}&orderby={orderby}&top={top} |
検索条件を指定して、条件に該当する通知を全て取得します。 ## 概要 検索条件を指定して、条件に該当する通知を全て取得します。 検索条件の指定方法については、[こちらを参照ください](https://docs.microsoft.com/ja-jp/graph/query-parameters#filter-parameter)。 |
|
POST | /API/v1/Notifications/SetStatus |
指定された未読通知のステータスを変更します。 ## 概要 ユーザが受け取っている通知の中から、未読通知ID(***notificationId***)に該当する通知のステータスを変更します。 ## 指定するパラメタについて ### 未読通知ID 未読通知ID(***notificationId***)を指定します。 ### 既読状態 既読にする場合は、trueを指定します。 ### 確認状態 確認済みにする場合は、trueを指定します。 |
NVC01
NVC01_ハウスB/L貨物情報登録(登録、訂正、削除)
API | Description | ||
---|---|---|---|
POST | /API/v1/NACCS/NVC01/Create |
帳票:NVC01_ハウスB/L貨物情報登録(登録、訂正、削除)を作成します。 帳票:NVC01_ハウスB/L貨物情報登録(登録、訂正、削除)を作成します。帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対して、Write権限が必要です。また、取引内に帳票:NVC01_ハウスB/L貨物情報登録(登録、訂正、削除)が存在する場合は、ステータスコード:200となり、Getメソッドと同じ動作となります。 |
|
DELETE | /API/v1/NACCS/NVC01/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:NVC01_ハウスB/L貨物情報登録(登録、訂正、削除)を削除します。 帳票:NVC01_ハウスB/L貨物情報登録(登録、訂正、削除)を削除します。帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
GET | /API/v1/NACCS/NVC01/Get/{dealReportId} |
帳票:NVC01_ハウスB/L貨物情報登録(登録、訂正、削除)を取得します。 帳票:NVC01_ハウスB/L貨物情報登録(登録、訂正、削除)を取得します。帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対して、Read権限が必要です。 |
OffSystemCarryInConfirmExportPermitteds
BIE
API | Description | ||
---|---|---|---|
POST | /API/v1/NaccsReport/OffSystemCarryInConfirmExportPermitteds/Create |
帳票:BIEを作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 帳票:BIEが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/OffSystemCarryInConfirmExportPermitteds/CreateByBlNo |
B/L番号を指定して、帳票:BIEを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定されたB/L番号(***blNo***)に該当する取引に対して、帳票:BIEを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定されたB/L番号(***blNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:BIEが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/OffSystemCarryInConfirmExportPermitteds/CreateByBookingNo |
ブッキング番号を指定して、帳票:BIEを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:BIEを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:BIEが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/OffSystemCarryInConfirmExportPermitteds/CreateByDomesticNo |
社内管理番号を指定して、帳票:BIEを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:BIEを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:BIEが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/NaccsReport/OffSystemCarryInConfirmExportPermitteds/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:BIEを削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/NaccsReport/OffSystemCarryInConfirmExportPermitteds/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
B/L番号を指定して、帳票:BIEを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、帳票:BIEを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/OffSystemCarryInConfirmExportPermitteds/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId} |
ブッキング番号を指定して、帳票:BIEを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:BIEを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/OffSystemCarryInConfirmExportPermitteds/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
取引管理番号を指定して、帳票:BIEを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:BIEを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/OffSystemCarryInConfirmExportPermitteds/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
社内管理番号を指定して、帳票:BIEを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:BIEを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/NaccsReport/OffSystemCarryInConfirmExportPermitteds/Get/{dealReportId} |
帳票:BIEを取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/NaccsReport/OffSystemCarryInConfirmExportPermitteds/GetByDealNo/{dealNo} |
取引管理番号を指定して、帳票:BIEを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:BIEを取得します。 |
|
GET | /API/v1/NaccsReport/OffSystemCarryInConfirmExportPermitteds/GetListByBlNo/{blNo} |
B/L番号を指定して、帳票:BIEを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、BIEを取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が付番されている全ての取引から、帳票:BIEを取得します。 |
|
GET | /API/v1/NaccsReport/OffSystemCarryInConfirmExportPermitteds/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo} |
ブッキング番号を指定して、帳票:BIEを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:BIEを取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が付番されている全ての取引から、帳票:BIEを取得します。 |
|
GET | /API/v1/NaccsReport/OffSystemCarryInConfirmExportPermitteds/GetListByDomesticNo/{domesticNo} |
社内管理番号を指定して、帳票:BIEを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:BIEを取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:BIEを取得します。 |
|
POST | /API/v1/NaccsReport/OffSystemCarryInConfirmExportPermitteds/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/OffSystemCarryInConfirmExportPermitteds/Register |
帳票:BIEを保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
OffSystemCyCarryInConfirmBlUnitPreRegistereds
CYD01
API | Description | ||
---|---|---|---|
POST | /API/v1/NaccsReport/OffSystemCyCarryInConfirmBlUnitPreRegistereds/Create |
帳票:CYD01を作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 帳票:CYD01が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/OffSystemCyCarryInConfirmBlUnitPreRegistereds/CreateByBlNo |
B/L番号を指定して、帳票:CYD01を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定されたB/L番号(***blNo***)に該当する取引に対して、帳票:CYD01を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定されたB/L番号(***blNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:CYD01が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/OffSystemCyCarryInConfirmBlUnitPreRegistereds/CreateByBookingNo |
ブッキング番号を指定して、帳票:CYD01を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:CYD01を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:CYD01が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/OffSystemCyCarryInConfirmBlUnitPreRegistereds/CreateByDomesticNo |
社内管理番号を指定して、帳票:CYD01を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:CYD01を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:CYD01が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/NaccsReport/OffSystemCyCarryInConfirmBlUnitPreRegistereds/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:CYD01を削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/NaccsReport/OffSystemCyCarryInConfirmBlUnitPreRegistereds/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
B/L番号を指定して、帳票:CYD01を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、帳票:CYD01を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/OffSystemCyCarryInConfirmBlUnitPreRegistereds/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId} |
ブッキング番号を指定して、帳票:CYD01を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:CYD01を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/OffSystemCyCarryInConfirmBlUnitPreRegistereds/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
取引管理番号を指定して、帳票:CYD01を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:CYD01を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/OffSystemCyCarryInConfirmBlUnitPreRegistereds/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
社内管理番号を指定して、帳票:CYD01を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:CYD01を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/NaccsReport/OffSystemCyCarryInConfirmBlUnitPreRegistereds/Get/{dealReportId} |
帳票:CYD01を取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/NaccsReport/OffSystemCyCarryInConfirmBlUnitPreRegistereds/GetByDealNo/{dealNo} |
取引管理番号を指定して、帳票:CYD01を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:CYD01を取得します。 |
|
GET | /API/v1/NaccsReport/OffSystemCyCarryInConfirmBlUnitPreRegistereds/GetListByBlNo/{blNo} |
B/L番号を指定して、帳票:CYD01を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、CYD01を取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が付番されている全ての取引から、帳票:CYD01を取得します。 |
|
GET | /API/v1/NaccsReport/OffSystemCyCarryInConfirmBlUnitPreRegistereds/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo} |
ブッキング番号を指定して、帳票:CYD01を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:CYD01を取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が付番されている全ての取引から、帳票:CYD01を取得します。 |
|
GET | /API/v1/NaccsReport/OffSystemCyCarryInConfirmBlUnitPreRegistereds/GetListByDomesticNo/{domesticNo} |
社内管理番号を指定して、帳票:CYD01を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:CYD01を取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:CYD01を取得します。 |
|
POST | /API/v1/NaccsReport/OffSystemCyCarryInConfirmBlUnitPreRegistereds/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/OffSystemCyCarryInConfirmBlUnitPreRegistereds/Register |
帳票:CYD01を保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
OLA
OLA_保税運送申告事項登録
API | Description | ||
---|---|---|---|
POST | /API/v1/NACCS/OLA/Create |
帳票:OLA_保税運送申告事項登録を作成します。 帳票:OLA_保税運送申告事項登録を作成します。帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対して、Write権限が必要です。また、取引内に帳票:OLA_保税運送申告事項登録が存在する場合は、ステータスコード:200となり、Getメソッドと同じ動作となります。 |
|
DELETE | /API/v1/NACCS/OLA/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:OLA_保税運送申告事項登録を削除します。 帳票:OLA_保税運送申告事項登録を削除します。帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
GET | /API/v1/NACCS/OLA/Get/{dealReportId} |
帳票:OLA_保税運送申告事項登録を取得します。 帳票:OLA_保税運送申告事項登録を取得します。帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対して、Read権限が必要です。 |
OneJapanViewers
API | Description | ||
---|---|---|---|
POST | /API/v1/OneJapanViewers/GetListByBlNo/{billOfLadingNumber} |
B/L番号でトラッキングデータを取得します。 |
|
POST | /API/v1/OneJapanViewers/GetListByBookingNo/{bookingNo} |
ブッキング番号でトラッキングデータを取得します。 |
Organizations
組織マスタ
API | Description | ||
---|---|---|---|
GET | /API/v1/Master/Organizations/Get/{organizationId} |
組織情報を取得します。 ## 概要 組織マスタから、組織ID(***organizationId***)を指定して、組織の情報を取得します。 参照できる項目は、APIを呼び出すユーザが所属している会社情報により制限されます。 APIを呼び出すユーザが所属していない他社の情報の場合、参照できる項目は以下だけとなります。 会社ID(***companyId***) 組織ID(***organizationId***) 組織名(***organizationName***) 事業種別(***businessTypes***) ## 指定するパラメタについて ### 会社ID 取得する組織情報の組織ID(***organizationId***)を指定します。 |
|
GET | /API/v1/Master/Organizations/GetList?filter={filter}&orderby={orderby} |
検索条件を指定して、条件に該当する組織情報を全て取得します。 ## 概要 検索条件を指定して、条件に該当する組織情報を全て取得します。 ***/API/v1/Master/Organizations/Get*** と同じく、APIを呼び出すユーザが所属していない他社の情報の場合、参照できる項目は制限されます。 検索条件の指定方法については、[こちらを参照ください](https://docs.microsoft.com/ja-jp/graph/query-parameters#filter-parameter)。 |
OrgEmployees
組織・利用者マスタ
API | Description | ||
---|---|---|---|
GET | /API/v1/Master/OrgEmployees/Get/{orgEmployeeId} |
組織・利用者マスタから、組織・利用者IDを指定して、組織と利用者の情報を取得します。 ただし、自社の組織・利用者情報に限ります。他社の組織・利用者情報は取得出来ません |
|
GET | /API/v1/Master/OrgEmployees/GetList?filter={filter}&orderby={orderby} |
組織・利用者マスタから、検索条件に該当する組織・利用者を全て取得します。 ただし、自社の組織・利用者情報に限ります。他社の組織・利用者情報は取得出来ません。 |
PackingLists
パッキングリスト
API | Description | ||
---|---|---|---|
POST | /API/v1/Report/PackingLists/Create |
帳票:パッキングリストを作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 帳票:パッキングリストが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/Report/PackingLists/CreateAttachFileMeta |
添付ファイルメタ情報を登録します。 |
|
POST | /API/v1/Report/PackingLists/CreateByBlNo |
B/L番号を指定して、帳票:パッキングリストを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定されたB/L番号(***blNo***)に該当する取引に対して、帳票:パッキングリストを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定されたB/L番号(***blNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:パッキングリストが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/Report/PackingLists/CreateByBookingNo |
ブッキング番号を指定して、帳票:パッキングリストを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:パッキングリストを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:パッキングリストが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/Report/PackingLists/CreateByDomesticNo |
社内管理番号を指定して、帳票:パッキングリストを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:パッキングリストを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:パッキングリストが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/Report/PackingLists/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:パッキングリストを削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/Report/PackingLists/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
B/L番号を指定して、帳票:パッキングリストを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、帳票:パッキングリストを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/Report/PackingLists/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId} |
ブッキング番号を指定して、帳票:パッキングリストを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:パッキングリストを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/Report/PackingLists/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
取引管理番号を指定して、帳票:パッキングリストを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:パッキングリストを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/Report/PackingLists/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
社内管理番号を指定して、帳票:パッキングリストを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:パッキングリストを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/Report/PackingLists/Get/{dealReportId} |
帳票:パッキングリストを取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/Report/PackingLists/GetAttachFileMetaList/{dealReportId} |
添付ファイル情報一覧を取得します。 |
|
GET | /API/v1/Report/PackingLists/GetByDealNo/{dealNo} |
取引管理番号を指定して、帳票:パッキングリストを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:パッキングリストを取得します。 |
|
GET | /API/v1/Report/PackingLists/GetListByBlNo/{blNo} |
B/L番号を指定して、帳票:パッキングリストを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、パッキングリストを取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が付番されている全ての取引から、帳票:パッキングリストを取得します。 |
|
GET | /API/v1/Report/PackingLists/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo} |
ブッキング番号を指定して、帳票:パッキングリストを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:パッキングリストを取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が付番されている全ての取引から、帳票:パッキングリストを取得します。 |
|
GET | /API/v1/Report/PackingLists/GetListByDomesticNo/{domesticNo} |
社内管理番号を指定して、帳票:パッキングリストを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:パッキングリストを取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:パッキングリストを取得します。 |
|
POST | /API/v1/Report/PackingLists/Register |
帳票:パッキングリストを保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
PreDepartureReportInquiries
IAR
API | Description | ||
---|---|---|---|
POST | /API/v1/NaccsReport/PreDepartureReportInquiries/Create |
帳票:IARを作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 帳票:IARが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/PreDepartureReportInquiries/CreateByBlNo |
B/L番号を指定して、帳票:IARを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定されたB/L番号(***blNo***)に該当する取引に対して、帳票:IARを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定されたB/L番号(***blNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:IARが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/PreDepartureReportInquiries/CreateByBookingNo |
ブッキング番号を指定して、帳票:IARを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:IARを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:IARが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/PreDepartureReportInquiries/CreateByDomesticNo |
社内管理番号を指定して、帳票:IARを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:IARを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:IARが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/NaccsReport/PreDepartureReportInquiries/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:IARを削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/NaccsReport/PreDepartureReportInquiries/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
B/L番号を指定して、帳票:IARを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、帳票:IARを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/PreDepartureReportInquiries/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId} |
ブッキング番号を指定して、帳票:IARを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:IARを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/PreDepartureReportInquiries/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
取引管理番号を指定して、帳票:IARを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:IARを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/PreDepartureReportInquiries/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
社内管理番号を指定して、帳票:IARを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:IARを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/NaccsReport/PreDepartureReportInquiries/Get/{dealReportId} |
帳票:IARを取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/NaccsReport/PreDepartureReportInquiries/GetByDealNo/{dealNo} |
取引管理番号を指定して、帳票:IARを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:IARを取得します。 |
|
GET | /API/v1/NaccsReport/PreDepartureReportInquiries/GetListByBlNo/{blNo} |
B/L番号を指定して、帳票:IARを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、IARを取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が付番されている全ての取引から、帳票:IARを取得します。 |
|
GET | /API/v1/NaccsReport/PreDepartureReportInquiries/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo} |
ブッキング番号を指定して、帳票:IARを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:IARを取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が付番されている全ての取引から、帳票:IARを取得します。 |
|
GET | /API/v1/NaccsReport/PreDepartureReportInquiries/GetListByDomesticNo/{domesticNo} |
社内管理番号を指定して、帳票:IARを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:IARを取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:IARを取得します。 |
|
POST | /API/v1/NaccsReport/PreDepartureReportInquiries/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/PreDepartureReportInquiries/Register |
帳票:IARを保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
PreDepartureReportListInquiries
IML
API | Description | ||
---|---|---|---|
POST | /API/v1/NaccsReport/PreDepartureReportListInquiries/Create |
帳票:IMLを作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 帳票:IMLが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/PreDepartureReportListInquiries/CreateByBlNo |
B/L番号を指定して、帳票:IMLを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定されたB/L番号(***blNo***)に該当する取引に対して、帳票:IMLを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定されたB/L番号(***blNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:IMLが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/PreDepartureReportListInquiries/CreateByBookingNo |
ブッキング番号を指定して、帳票:IMLを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:IMLを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:IMLが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/PreDepartureReportListInquiries/CreateByDomesticNo |
社内管理番号を指定して、帳票:IMLを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:IMLを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:IMLが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/NaccsReport/PreDepartureReportListInquiries/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:IMLを削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/NaccsReport/PreDepartureReportListInquiries/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
B/L番号を指定して、帳票:IMLを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、帳票:IMLを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/PreDepartureReportListInquiries/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId} |
ブッキング番号を指定して、帳票:IMLを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:IMLを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/PreDepartureReportListInquiries/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
取引管理番号を指定して、帳票:IMLを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:IMLを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/PreDepartureReportListInquiries/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
社内管理番号を指定して、帳票:IMLを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:IMLを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/NaccsReport/PreDepartureReportListInquiries/Get/{dealReportId} |
帳票:IMLを取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/NaccsReport/PreDepartureReportListInquiries/GetByDealNo/{dealNo} |
取引管理番号を指定して、帳票:IMLを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:IMLを取得します。 |
|
GET | /API/v1/NaccsReport/PreDepartureReportListInquiries/GetListByBlNo/{blNo} |
B/L番号を指定して、帳票:IMLを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、IMLを取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が付番されている全ての取引から、帳票:IMLを取得します。 |
|
GET | /API/v1/NaccsReport/PreDepartureReportListInquiries/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo} |
ブッキング番号を指定して、帳票:IMLを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:IMLを取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が付番されている全ての取引から、帳票:IMLを取得します。 |
|
GET | /API/v1/NaccsReport/PreDepartureReportListInquiries/GetListByDomesticNo/{domesticNo} |
社内管理番号を指定して、帳票:IMLを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:IMLを取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:IMLを取得します。 |
|
POST | /API/v1/NaccsReport/PreDepartureReportListInquiries/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/PreDepartureReportListInquiries/Register |
帳票:IMLを保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
PresettingOrganizations
組織事前設定
API | Description | ||
---|---|---|---|
POST | /API/v1/Master/PresettingOrganizations/RegisterInternal |
組織事前設定を登録します。(Internal Method) |
ProformaInvoices
仮送り状
API | Description | ||
---|---|---|---|
POST | /API/v1/Report/ProformaInvoices/Create |
帳票:仮送り状を作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 帳票:仮送り状が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/Report/ProformaInvoices/CreateAttachFileMeta |
添付ファイルメタ情報を登録します。 |
|
POST | /API/v1/Report/ProformaInvoices/CreateByBlNo |
B/L番号を指定して、帳票:仮送り状を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定されたB/L番号(***blNo***)に該当する取引に対して、帳票:仮送り状を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定されたB/L番号(***blNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:仮送り状が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/Report/ProformaInvoices/CreateByBookingNo |
ブッキング番号を指定して、帳票:仮送り状を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:仮送り状を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:仮送り状が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/Report/ProformaInvoices/CreateByDomesticNo |
社内管理番号を指定して、帳票:仮送り状を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:仮送り状を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:仮送り状が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/Report/ProformaInvoices/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:仮送り状を削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/Report/ProformaInvoices/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
B/L番号を指定して、帳票:仮送り状を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、帳票:仮送り状を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/Report/ProformaInvoices/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId} |
ブッキング番号を指定して、帳票:仮送り状を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:仮送り状を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/Report/ProformaInvoices/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
取引管理番号を指定して、帳票:仮送り状を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:仮送り状を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/Report/ProformaInvoices/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
社内管理番号を指定して、帳票:仮送り状を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:仮送り状を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/Report/ProformaInvoices/Get/{dealReportId} |
帳票:仮送り状を取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/Report/ProformaInvoices/GetAttachFileMetaList/{dealReportId} |
添付ファイル情報一覧を取得します。 |
|
GET | /API/v1/Report/ProformaInvoices/GetByDealNo/{dealNo} |
取引管理番号を指定して、帳票:仮送り状を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:仮送り状を取得します。 |
|
GET | /API/v1/Report/ProformaInvoices/GetListByBlNo/{blNo} |
B/L番号を指定して、帳票:仮送り状を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、仮送り状を取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が付番されている全ての取引から、帳票:仮送り状を取得します。 |
|
GET | /API/v1/Report/ProformaInvoices/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo} |
ブッキング番号を指定して、帳票:仮送り状を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:仮送り状を取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が付番されている全ての取引から、帳票:仮送り状を取得します。 |
|
GET | /API/v1/Report/ProformaInvoices/GetListByDomesticNo/{domesticNo} |
社内管理番号を指定して、帳票:仮送り状を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:仮送り状を取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:仮送り状を取得します。 |
|
POST | /API/v1/Report/ProformaInvoices/Register |
帳票:仮送り状を保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
RelatedMinistriesDeclarationApplicationStatusInquiries
IXX
API | Description | ||
---|---|---|---|
POST | /API/v1/NaccsReport/RelatedMinistriesDeclarationApplicationStatusInquiries/Create |
帳票:IXXを作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 帳票:IXXが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/RelatedMinistriesDeclarationApplicationStatusInquiries/CreateByBlNo |
B/L番号を指定して、帳票:IXXを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定されたB/L番号(***blNo***)に該当する取引に対して、帳票:IXXを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定されたB/L番号(***blNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:IXXが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/RelatedMinistriesDeclarationApplicationStatusInquiries/CreateByBookingNo |
ブッキング番号を指定して、帳票:IXXを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:IXXを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:IXXが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/RelatedMinistriesDeclarationApplicationStatusInquiries/CreateByDomesticNo |
社内管理番号を指定して、帳票:IXXを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:IXXを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:IXXが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/NaccsReport/RelatedMinistriesDeclarationApplicationStatusInquiries/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:IXXを削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/NaccsReport/RelatedMinistriesDeclarationApplicationStatusInquiries/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
B/L番号を指定して、帳票:IXXを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、帳票:IXXを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/RelatedMinistriesDeclarationApplicationStatusInquiries/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId} |
ブッキング番号を指定して、帳票:IXXを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:IXXを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/RelatedMinistriesDeclarationApplicationStatusInquiries/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
取引管理番号を指定して、帳票:IXXを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:IXXを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/RelatedMinistriesDeclarationApplicationStatusInquiries/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
社内管理番号を指定して、帳票:IXXを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:IXXを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/NaccsReport/RelatedMinistriesDeclarationApplicationStatusInquiries/Get/{dealReportId} |
帳票:IXXを取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/NaccsReport/RelatedMinistriesDeclarationApplicationStatusInquiries/GetByDealNo/{dealNo} |
取引管理番号を指定して、帳票:IXXを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:IXXを取得します。 |
|
GET | /API/v1/NaccsReport/RelatedMinistriesDeclarationApplicationStatusInquiries/GetListByBlNo/{blNo} |
B/L番号を指定して、帳票:IXXを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、IXXを取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が付番されている全ての取引から、帳票:IXXを取得します。 |
|
GET | /API/v1/NaccsReport/RelatedMinistriesDeclarationApplicationStatusInquiries/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo} |
ブッキング番号を指定して、帳票:IXXを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:IXXを取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が付番されている全ての取引から、帳票:IXXを取得します。 |
|
GET | /API/v1/NaccsReport/RelatedMinistriesDeclarationApplicationStatusInquiries/GetListByDomesticNo/{domesticNo} |
社内管理番号を指定して、帳票:IXXを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:IXXを取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:IXXを取得します。 |
|
POST | /API/v1/NaccsReport/RelatedMinistriesDeclarationApplicationStatusInquiries/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/RelatedMinistriesDeclarationApplicationStatusInquiries/Register |
帳票:IXXを保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
RemittanceAdvices
振込完了通知書
API | Description | ||
---|---|---|---|
POST | /API/v1/Report/RemittanceAdvices/Create |
帳票:振込完了通知書を作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 帳票:振込完了通知書が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/Report/RemittanceAdvices/CreateAttachFileMeta |
添付ファイルメタ情報を登録します。 |
|
POST | /API/v1/Report/RemittanceAdvices/CreateByBlNo |
B/L番号を指定して、帳票:振込完了通知書を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定されたB/L番号(***blNo***)に該当する取引に対して、帳票:振込完了通知書を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定されたB/L番号(***blNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:振込完了通知書が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/Report/RemittanceAdvices/CreateByBookingNo |
ブッキング番号を指定して、帳票:振込完了通知書を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:振込完了通知書を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:振込完了通知書が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/Report/RemittanceAdvices/CreateByDomesticNo |
社内管理番号を指定して、帳票:振込完了通知書を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:振込完了通知書を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:振込完了通知書が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/Report/RemittanceAdvices/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:振込完了通知書を削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/Report/RemittanceAdvices/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
B/L番号を指定して、帳票:振込完了通知書を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、帳票:振込完了通知書を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/Report/RemittanceAdvices/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId} |
ブッキング番号を指定して、帳票:振込完了通知書を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:振込完了通知書を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/Report/RemittanceAdvices/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
取引管理番号を指定して、帳票:振込完了通知書を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:振込完了通知書を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/Report/RemittanceAdvices/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
社内管理番号を指定して、帳票:振込完了通知書を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:振込完了通知書を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/Report/RemittanceAdvices/Get/{dealReportId} |
帳票:振込完了通知書を取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/Report/RemittanceAdvices/GetAttachFileMetaList/{dealReportId} |
添付ファイル情報一覧を取得します。 |
|
GET | /API/v1/Report/RemittanceAdvices/GetByDealNo/{dealNo} |
取引管理番号を指定して、帳票:振込完了通知書を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:振込完了通知書を取得します。 |
|
GET | /API/v1/Report/RemittanceAdvices/GetListByBlNo/{blNo} |
B/L番号を指定して、帳票:振込完了通知書を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、振込完了通知書を取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が付番されている全ての取引から、帳票:振込完了通知書を取得します。 |
|
GET | /API/v1/Report/RemittanceAdvices/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo} |
ブッキング番号を指定して、帳票:振込完了通知書を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:振込完了通知書を取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が付番されている全ての取引から、帳票:振込完了通知書を取得します。 |
|
GET | /API/v1/Report/RemittanceAdvices/GetListByDomesticNo/{domesticNo} |
社内管理番号を指定して、帳票:振込完了通知書を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:振込完了通知書を取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:振込完了通知書を取得します。 |
|
POST | /API/v1/Report/RemittanceAdvices/Register |
帳票:振込完了通知書を保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
RemittanceSlips
振込・振替明細帳票
API | Description | ||
---|---|---|---|
POST | /API/v1/Report/RemittanceSlips/Create |
帳票:振込・振替明細帳票を作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 帳票:振込・振替明細帳票が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/Report/RemittanceSlips/CreateAttachFileMeta |
添付ファイルメタ情報を登録します。 |
|
POST | /API/v1/Report/RemittanceSlips/CreateByBlNo |
B/L番号を指定して、帳票:振込・振替明細帳票を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定されたB/L番号(***blNo***)に該当する取引に対して、帳票:振込・振替明細帳票を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定されたB/L番号(***blNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:振込・振替明細帳票が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/Report/RemittanceSlips/CreateByBookingNo |
ブッキング番号を指定して、帳票:振込・振替明細帳票を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:振込・振替明細帳票を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:振込・振替明細帳票が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/Report/RemittanceSlips/CreateByDomesticNo |
社内管理番号を指定して、帳票:振込・振替明細帳票を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:振込・振替明細帳票を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:振込・振替明細帳票が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/Report/RemittanceSlips/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:振込・振替明細帳票を削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/Report/RemittanceSlips/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
B/L番号を指定して、帳票:振込・振替明細帳票を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、帳票:振込・振替明細帳票を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/Report/RemittanceSlips/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId} |
ブッキング番号を指定して、帳票:振込・振替明細帳票を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:振込・振替明細帳票を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/Report/RemittanceSlips/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
取引管理番号を指定して、帳票:振込・振替明細帳票を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:振込・振替明細帳票を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/Report/RemittanceSlips/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
社内管理番号を指定して、帳票:振込・振替明細帳票を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:振込・振替明細帳票を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/Report/RemittanceSlips/Get/{dealReportId} |
帳票:振込・振替明細帳票を取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/Report/RemittanceSlips/GetAttachFileMetaList/{dealReportId} |
添付ファイル情報一覧を取得します。 |
|
GET | /API/v1/Report/RemittanceSlips/GetByDealNo/{dealNo} |
取引管理番号を指定して、帳票:振込・振替明細帳票を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:振込・振替明細帳票を取得します。 |
|
GET | /API/v1/Report/RemittanceSlips/GetListByBlNo/{blNo} |
B/L番号を指定して、帳票:振込・振替明細帳票を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、振込・振替明細帳票を取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が付番されている全ての取引から、帳票:振込・振替明細帳票を取得します。 |
|
GET | /API/v1/Report/RemittanceSlips/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo} |
ブッキング番号を指定して、帳票:振込・振替明細帳票を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:振込・振替明細帳票を取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が付番されている全ての取引から、帳票:振込・振替明細帳票を取得します。 |
|
GET | /API/v1/Report/RemittanceSlips/GetListByDomesticNo/{domesticNo} |
社内管理番号を指定して、帳票:振込・振替明細帳票を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:振込・振替明細帳票を取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:振込・振替明細帳票を取得します。 |
|
POST | /API/v1/Report/RemittanceSlips/Register |
帳票:振込・振替明細帳票を保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
ReportPermissions
帳票アクセス権限マスタ
API | Description | ||
---|---|---|---|
GET | /API/v1/Master/ReportPermissions/Get/{reportPermissionId} |
帳票アクセス権限マスタから、アクセス権限ID(reportPermissionId)を指定して、帳票アクセス権限を取得します。 このマスタは、業務パターン毎に、事業種別と帳票のアクセス権限(RW権限)を管理します。 このマスタの内容が取引に組織を追加した際のデフォルトでの設定となります。 |
Reports
帳票マスタ
API | Description | ||
---|---|---|---|
GET | /API/v1/Master/Reports/Get/{reportCode} |
帳票マスタから、帳票コード(reportCode)を指定して、帳票マスタを取得します。 |
|
GET | /API/v1/Master/Reports/GetSchema/{reportCode} |
帳票マスタから、帳票コード(reportCode)を指定して、帳票スキーマを取得します。 |
RequirementsRules
必須項目の設定
API | Description | ||
---|---|---|---|
POST | /API/v1/Master/RequirementsRules/Create |
必須項目の設定を作成します。 ## 概要 帳票の必須項目を、必須項目の設定として作成します。 この必須項目の設定は、タスクを作成する際、そのタスクの対象となる帳票で入力が必須となる項目をJSONパスで指定します。 必須項目の設定は、組織(組織ID・事業種別ID)単位で所有します。 |
|
DELETE | /API/v1/Master/RequirementsRules/Delete/{requirementsRuleId} |
必須項目の設定を削除します。 ## 概要 必須項目設定ID(***requirementsRuleId***)を指定して、必須項目の設定を削除します。 この必須項目の設定を使用して作成されたタスクには影響はありません。 削除できる必須項目の設定は、所属する組織(組織ID・事業種別)が所有する設定に限定されます。 ## 指定するパラメタについて ### 必須項目設定ID 削除する必須項目の設定について必須項目設定ID(***requirementsRuleId***)を指定します。 |
|
GET | /API/v1/Master/RequirementsRules/Get/{requirementsRuleId} |
必須項目の設定を取得します。 ## 概要 必須項目設定ID(***requirementsRuleId***)を指定して、必須項目の設定を取得します。 ## 指定するパラメタについて ### 必須項目設定ID 取得する必須項目の設定について必須項目設定ID(***requirementsRuleId***)を指定します。 |
|
GET | /API/v1/Master/RequirementsRules/GetList?filter={filter}&orderby={orderby} |
検索条件を指定して、条件に該当する必須項目の設定を全て取得します。 ## 概要 検索条件を指定して、条件に該当する必須項目の設定を全て取得します。 検索条件の指定方法については、[こちらを参照ください](https://docs.microsoft.com/ja-jp/graph/query-parameters#filter-parameter)。 |
|
POST | /API/v1/Master/RequirementsRules/Register |
必須項目の設定を登録(更新)します。 ## 概要 必須項目設定ID(***requirementsRuleId***)を指定して、必須項目の設定を更新します。 この必須項目の設定を使用して作成されたタスクには影響はありません。 |
Reviews
レビュー
API | Description | ||
---|---|---|---|
DELETE | /API/v1/Reviews/Cancel/{reviewId} |
レビュー依頼をキャンセルします。 |
|
POST | /API/v1/Reviews/Create |
レビュー依頼を作成します。 |
|
GET | /API/v1/Reviews/Get/{reviewId} |
レビューIDを指定して、レビュー(Review)を取得します。 |
|
GET | /API/v1/Reviews/GetCountPerReportByDealNo/{dealNo} |
指定した取引番号の取引内にあるレビュー(Review)の集計結果を取得します。 |
|
GET | /API/v1/Reviews/GetList?filter={filter}&orderby={orderby}&top={top} |
検索条件を指定して、条件に該当するレビュー(Review)を全て取得します。 |
|
GET | /API/v1/Reviews/GetListByDealReportId/{dealReportId} |
指定した帳票番号の帳票に紐づくレビュー(Review)の集計結果を取得します。 |
|
POST | /API/v1/Reviews/MarkAsRead |
レビューを既読状態にします。 |
SAI
SAI_輸入貨物情報訂正
API | Description | ||
---|---|---|---|
POST | /API/v1/NACCS/SAI/Create |
帳票:SAI_輸入貨物情報訂正を作成します。 帳票:SAI_輸入貨物情報訂正を作成します。帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対して、Write権限が必要です。また、取引内に帳票:SAI_輸入貨物情報訂正が存在する場合は、ステータスコード:200となり、Getメソッドと同じ動作となります。 |
|
DELETE | /API/v1/NACCS/SAI/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:SAI_輸入貨物情報訂正を削除します。 帳票:SAI_輸入貨物情報訂正を削除します。帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
GET | /API/v1/NACCS/SAI/Get/{dealReportId} |
帳票:SAI_輸入貨物情報訂正を取得します。 帳票:SAI_輸入貨物情報訂正を取得します。帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対して、Read権限が必要です。 |
SeaWayBills
海上運送状
API | Description | ||
---|---|---|---|
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でのレスポンスデータを編集し、指定するようにしてください。 |
ShippingCodeInquiries
IVK
API | Description | ||
---|---|---|---|
POST | /API/v1/NaccsReport/ShippingCodeInquiries/Create |
帳票:IVKを作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 帳票:IVKが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/ShippingCodeInquiries/CreateByBlNo |
B/L番号を指定して、帳票:IVKを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定されたB/L番号(***blNo***)に該当する取引に対して、帳票:IVKを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定されたB/L番号(***blNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:IVKが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/ShippingCodeInquiries/CreateByBookingNo |
ブッキング番号を指定して、帳票:IVKを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:IVKを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:IVKが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/ShippingCodeInquiries/CreateByDomesticNo |
社内管理番号を指定して、帳票:IVKを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:IVKを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:IVKが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/NaccsReport/ShippingCodeInquiries/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:IVKを削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/NaccsReport/ShippingCodeInquiries/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
B/L番号を指定して、帳票:IVKを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、帳票:IVKを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/ShippingCodeInquiries/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId} |
ブッキング番号を指定して、帳票:IVKを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:IVKを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/ShippingCodeInquiries/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
取引管理番号を指定して、帳票:IVKを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:IVKを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/ShippingCodeInquiries/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
社内管理番号を指定して、帳票:IVKを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:IVKを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/NaccsReport/ShippingCodeInquiries/Get/{dealReportId} |
帳票:IVKを取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/NaccsReport/ShippingCodeInquiries/GetByDealNo/{dealNo} |
取引管理番号を指定して、帳票:IVKを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:IVKを取得します。 |
|
GET | /API/v1/NaccsReport/ShippingCodeInquiries/GetListByBlNo/{blNo} |
B/L番号を指定して、帳票:IVKを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、IVKを取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が付番されている全ての取引から、帳票:IVKを取得します。 |
|
GET | /API/v1/NaccsReport/ShippingCodeInquiries/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo} |
ブッキング番号を指定して、帳票:IVKを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:IVKを取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が付番されている全ての取引から、帳票:IVKを取得します。 |
|
GET | /API/v1/NaccsReport/ShippingCodeInquiries/GetListByDomesticNo/{domesticNo} |
社内管理番号を指定して、帳票:IVKを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:IVKを取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:IVKを取得します。 |
|
POST | /API/v1/NaccsReport/ShippingCodeInquiries/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/ShippingCodeInquiries/Register |
帳票:IVKを保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
ShippingContainerInquiries
ICI
API | Description | ||
---|---|---|---|
POST | /API/v1/NaccsReport/ShippingContainerInquiries/Create |
帳票:ICIを作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 帳票:ICIが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/ShippingContainerInquiries/CreateByBlNo |
B/L番号を指定して、帳票:ICIを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定されたB/L番号(***blNo***)に該当する取引に対して、帳票:ICIを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定されたB/L番号(***blNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:ICIが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/ShippingContainerInquiries/CreateByBookingNo |
ブッキング番号を指定して、帳票:ICIを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:ICIを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:ICIが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/ShippingContainerInquiries/CreateByDomesticNo |
社内管理番号を指定して、帳票:ICIを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:ICIを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:ICIが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/NaccsReport/ShippingContainerInquiries/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:ICIを削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/NaccsReport/ShippingContainerInquiries/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
B/L番号を指定して、帳票:ICIを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、帳票:ICIを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/ShippingContainerInquiries/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId} |
ブッキング番号を指定して、帳票:ICIを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:ICIを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/ShippingContainerInquiries/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
取引管理番号を指定して、帳票:ICIを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:ICIを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/ShippingContainerInquiries/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
社内管理番号を指定して、帳票:ICIを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:ICIを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/NaccsReport/ShippingContainerInquiries/Get/{dealReportId} |
帳票:ICIを取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/NaccsReport/ShippingContainerInquiries/GetByDealNo/{dealNo} |
取引管理番号を指定して、帳票:ICIを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:ICIを取得します。 |
|
GET | /API/v1/NaccsReport/ShippingContainerInquiries/GetListByBlNo/{blNo} |
B/L番号を指定して、帳票:ICIを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、ICIを取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が付番されている全ての取引から、帳票:ICIを取得します。 |
|
GET | /API/v1/NaccsReport/ShippingContainerInquiries/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo} |
ブッキング番号を指定して、帳票:ICIを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:ICIを取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が付番されている全ての取引から、帳票:ICIを取得します。 |
|
GET | /API/v1/NaccsReport/ShippingContainerInquiries/GetListByDomesticNo/{domesticNo} |
社内管理番号を指定して、帳票:ICIを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:ICIを取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:ICIを取得します。 |
|
POST | /API/v1/NaccsReport/ShippingContainerInquiries/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/ShippingContainerInquiries/Register |
帳票:ICIを保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
ShippingInstructions
船積依頼書
API | Description | ||
---|---|---|---|
POST | /API/v1/Report/ShippingInstructions/Create |
帳票:船積依頼書を作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 帳票:船積依頼書が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/Report/ShippingInstructions/CreateAttachFileMeta |
添付ファイルメタ情報を登録します。 |
|
POST | /API/v1/Report/ShippingInstructions/CreateByBlNo |
B/L番号を指定して、帳票:船積依頼書を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定されたB/L番号(***blNo***)に該当する取引に対して、帳票:船積依頼書を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定されたB/L番号(***blNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:船積依頼書が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/Report/ShippingInstructions/CreateByBookingNo |
ブッキング番号を指定して、帳票:船積依頼書を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:船積依頼書を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:船積依頼書が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/Report/ShippingInstructions/CreateByDomesticNo |
社内管理番号を指定して、帳票:船積依頼書を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:船積依頼書を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:船積依頼書が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/Report/ShippingInstructions/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:船積依頼書を削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/Report/ShippingInstructions/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
B/L番号を指定して、帳票:船積依頼書を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、帳票:船積依頼書を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/Report/ShippingInstructions/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId} |
ブッキング番号を指定して、帳票:船積依頼書を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:船積依頼書を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/Report/ShippingInstructions/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
取引管理番号を指定して、帳票:船積依頼書を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:船積依頼書を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/Report/ShippingInstructions/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
社内管理番号を指定して、帳票:船積依頼書を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:船積依頼書を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/Report/ShippingInstructions/Get/{dealReportId} |
帳票:船積依頼書を取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/Report/ShippingInstructions/GetAttachFileMetaList/{dealReportId} |
添付ファイル情報一覧を取得します。 |
|
GET | /API/v1/Report/ShippingInstructions/GetByDealNo/{dealNo} |
取引管理番号を指定して、帳票:船積依頼書を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:船積依頼書を取得します。 |
|
GET | /API/v1/Report/ShippingInstructions/GetListByBlNo/{blNo} |
B/L番号を指定して、帳票:船積依頼書を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、船積依頼書を取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が付番されている全ての取引から、帳票:船積依頼書を取得します。 |
|
GET | /API/v1/Report/ShippingInstructions/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo} |
ブッキング番号を指定して、帳票:船積依頼書を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:船積依頼書を取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が付番されている全ての取引から、帳票:船積依頼書を取得します。 |
|
GET | /API/v1/Report/ShippingInstructions/GetListByDomesticNo/{domesticNo} |
社内管理番号を指定して、帳票:船積依頼書を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:船積依頼書を取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:船積依頼書を取得します。 |
|
POST | /API/v1/Report/ShippingInstructions/Register |
帳票:船積依頼書を保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
SimpleCargoRegistrationCalls
SCR11
API | Description | ||
---|---|---|---|
POST | /API/v1/NaccsReport/SimpleCargoRegistrationCalls/Create |
帳票:SCR11を作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 帳票:SCR11が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/SimpleCargoRegistrationCalls/CreateByBlNo |
B/L番号を指定して、帳票:SCR11を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定されたB/L番号(***blNo***)に該当する取引に対して、帳票:SCR11を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定されたB/L番号(***blNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:SCR11が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/SimpleCargoRegistrationCalls/CreateByBookingNo |
ブッキング番号を指定して、帳票:SCR11を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:SCR11を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:SCR11が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/SimpleCargoRegistrationCalls/CreateByDomesticNo |
社内管理番号を指定して、帳票:SCR11を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:SCR11を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:SCR11が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/NaccsReport/SimpleCargoRegistrationCalls/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:SCR11を削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/NaccsReport/SimpleCargoRegistrationCalls/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
B/L番号を指定して、帳票:SCR11を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、帳票:SCR11を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/SimpleCargoRegistrationCalls/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId} |
ブッキング番号を指定して、帳票:SCR11を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:SCR11を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/SimpleCargoRegistrationCalls/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
取引管理番号を指定して、帳票:SCR11を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:SCR11を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/SimpleCargoRegistrationCalls/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
社内管理番号を指定して、帳票:SCR11を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:SCR11を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/NaccsReport/SimpleCargoRegistrationCalls/Get/{dealReportId} |
帳票:SCR11を取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/NaccsReport/SimpleCargoRegistrationCalls/GetByDealNo/{dealNo} |
取引管理番号を指定して、帳票:SCR11を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:SCR11を取得します。 |
|
GET | /API/v1/NaccsReport/SimpleCargoRegistrationCalls/GetListByBlNo/{blNo} |
B/L番号を指定して、帳票:SCR11を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、SCR11を取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が付番されている全ての取引から、帳票:SCR11を取得します。 |
|
GET | /API/v1/NaccsReport/SimpleCargoRegistrationCalls/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo} |
ブッキング番号を指定して、帳票:SCR11を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:SCR11を取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が付番されている全ての取引から、帳票:SCR11を取得します。 |
|
GET | /API/v1/NaccsReport/SimpleCargoRegistrationCalls/GetListByDomesticNo/{domesticNo} |
社内管理番号を指定して、帳票:SCR11を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:SCR11を取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:SCR11を取得します。 |
|
POST | /API/v1/NaccsReport/SimpleCargoRegistrationCalls/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/SimpleCargoRegistrationCalls/Register |
帳票:SCR11を保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
SimpleCargoRegistrations
SCR
API | Description | ||
---|---|---|---|
POST | /API/v1/NaccsReport/SimpleCargoRegistrations/Create |
帳票:SCRを作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 帳票:SCRが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/SimpleCargoRegistrations/CreateByBlNo |
B/L番号を指定して、帳票:SCRを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定されたB/L番号(***blNo***)に該当する取引に対して、帳票:SCRを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定されたB/L番号(***blNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:SCRが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/SimpleCargoRegistrations/CreateByBookingNo |
ブッキング番号を指定して、帳票:SCRを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:SCRを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:SCRが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/SimpleCargoRegistrations/CreateByDomesticNo |
社内管理番号を指定して、帳票:SCRを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:SCRを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:SCRが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/NaccsReport/SimpleCargoRegistrations/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:SCRを削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/NaccsReport/SimpleCargoRegistrations/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
B/L番号を指定して、帳票:SCRを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、帳票:SCRを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/SimpleCargoRegistrations/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId} |
ブッキング番号を指定して、帳票:SCRを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:SCRを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/SimpleCargoRegistrations/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
取引管理番号を指定して、帳票:SCRを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:SCRを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/SimpleCargoRegistrations/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
社内管理番号を指定して、帳票:SCRを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:SCRを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/NaccsReport/SimpleCargoRegistrations/Get/{dealReportId} |
帳票:SCRを取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/NaccsReport/SimpleCargoRegistrations/GetByDealNo/{dealNo} |
取引管理番号を指定して、帳票:SCRを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:SCRを取得します。 |
|
GET | /API/v1/NaccsReport/SimpleCargoRegistrations/GetListByBlNo/{blNo} |
B/L番号を指定して、帳票:SCRを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、SCRを取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が付番されている全ての取引から、帳票:SCRを取得します。 |
|
GET | /API/v1/NaccsReport/SimpleCargoRegistrations/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo} |
ブッキング番号を指定して、帳票:SCRを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:SCRを取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が付番されている全ての取引から、帳票:SCRを取得します。 |
|
GET | /API/v1/NaccsReport/SimpleCargoRegistrations/GetListByDomesticNo/{domesticNo} |
社内管理番号を指定して、帳票:SCRを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:SCRを取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:SCRを取得します。 |
|
POST | /API/v1/NaccsReport/SimpleCargoRegistrations/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/SimpleCargoRegistrations/Register |
帳票:SCRを保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
SIR
SIR_船積指図書(S/I)情報登録
API | Description | ||
---|---|---|---|
POST | /API/v1/NACCS/SIR/Create |
帳票:SIR_船積指図書(S/I)情報登録を作成します。 帳票:SIR_船積指図書(S/I)情報登録を作成します。帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対して、Write権限が必要です。また、取引内に帳票:SIR_船積指図書(S/I)情報登録が存在する場合は、ステータスコード:200となり、Getメソッドと同じ動作となります。 |
|
DELETE | /API/v1/NACCS/SIR/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:SIR_船積指図書(S/I)情報登録を削除します。 帳票:SIR_船積指図書(S/I)情報登録を削除します。帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
GET | /API/v1/NACCS/SIR/Get/{dealReportId} |
帳票:SIR_船積指図書(S/I)情報登録を取得します。 帳票:SIR_船積指図書(S/I)情報登録を取得します。帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対して、Read権限が必要です。 |
SWA
SWA_シングルウィンドウ輸入申告事項登録
API | Description | ||
---|---|---|---|
POST | /API/v1/NACCS/SWA/Create |
帳票:SWA_シングルウィンドウ輸入申告事項登録を作成します。 帳票:SWA_シングルウィンドウ輸入申告事項登録を作成します。帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対して、Write権限が必要です。また、取引内に帳票:SWA_シングルウィンドウ輸入申告事項登録が存在する場合は、ステータスコード:200となり、Getメソッドと同じ動作となります。 |
|
DELETE | /API/v1/NACCS/SWA/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:SWA_シングルウィンドウ輸入申告事項登録を削除します。 帳票:SWA_シングルウィンドウ輸入申告事項登録を削除します。帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
GET | /API/v1/NACCS/SWA/Get/{dealReportId} |
帳票:SWA_シングルウィンドウ輸入申告事項登録を取得します。 帳票:SWA_シングルウィンドウ輸入申告事項登録を取得します。帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対して、Read権限が必要です。 |
Tasks
タスク
API | Description | ||
---|---|---|---|
POST | /API/v1/Tasks/Create |
タスクを作成します。 ## 概要 タスクとは、その帳票に対して、やるべきことを可視化する機能です。 タスクは、1つの帳票に対して、複数作成することができます。帳票に対する作業を共有したり、タスクに対して担当する組織や担当者を設定することで、帳票に対する作業を明確化するのに役立ちます。 ### 必須項目の設定 タスクには、その帳票に対する入力が必要となる項目の設定が可能です。 ***必須項目の設定は、 /API/v1/Master/RequirementsRules で行います。*** 必須項目の設定付きのタスクは、帳票の送信時(***/API/v1/Deals/SendReport***)に、必須項目の入力チェックが実施され、必須項目として設定された項目に何も入っていない場合は、帳票の送信(***/API/v1/Deals/SendReport***)が失敗します。 必須項目の設定付きのタスクは、帳票の入力フィルターのように機能します。 |
|
GET | /API/v1/Tasks/Get/{taskId} |
タスクIDを指定して、タスク(Task)を取得します。 |
|
GET | /API/v1/Tasks/GetAssignedList?filter={filter}&orderby={orderby}&top={top} |
検索条件を指定して、条件に該当する担当タスク(Task)を全て取得します。 |
|
GET | /API/v1/Tasks/GetCount?filter={filter} |
検索条件を指定して、条件に該当するタスク(Task)の件数を取得します。 |
|
GET | /API/v1/Tasks/GetList/{dealNo}?dealReportId={dealReportId} |
検索条件を指定して、条件に該当するタスク(Task)を全て取得します。 |
|
POST | /API/v1/Tasks/Register |
タスクを登録します。 |
|
POST | /API/v1/Tasks/SetAssignee |
タスクを担当する組織を変更します。 |
|
POST | /API/v1/Tasks/SetEmployee |
タスクの担当者を設定します |
|
POST | /API/v1/Tasks/SetStatus |
タスク依頼のステータスを変更します。 |
TerminalInquiry
ターミナル問合せ
API | Description | ||
---|---|---|---|
POST | /API/v1/Report/TerminalInquiry/Create |
帳票:ターミナル問合せを作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対して、Write権限が必要です。 ## 指定するパラメタについて ### 取引管理番号 帳票を作成する取引の取引管理番号(***dealNo***)を指定します。 ### 帳票を作成する組織の組織ID・事業種別ID 帳票を作成する権限のある組織の組織ID(***organizationId***)と事業種別ID(***businessTypeId***)のセットで指定します。 |
|
GET | /API/v1/Report/TerminalInquiry/Get/{dealReportId} |
帳票:ターミナル問合せを取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対して、Read権限が必要です。 ## 指定するパラメタについて ### 取引・帳票ID 取得する帳票の取引・帳票ID(***dealReportId***)を指定します。 |
|
POST | /API/v1/Report/TerminalInquiry/Register |
帳票:ターミナル問合せを保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対して、Write権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(etag)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 ## 指定するパラメタについて ### 取引管理番号 帳票を作成する取引の取引管理番号(***dealNo***)を指定します。 ### 帳票を作成する組織の組織ID・事業種別ID 帳票を作成する権限のある組織の組織ID(***organizationId***)と事業種別ID(***businessTypeId***)のセットで指定します。 |
TerminalPayment
ターミナル支払申込兼入金通知書
API | Description | ||
---|---|---|---|
POST | /API/v1/Report/TerminalPayment/Create |
帳票:ターミナル支払申込兼入金通知書を作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対して、Write権限が必要です。 ## 指定するパラメタについて ### 取引管理番号 帳票を作成する取引の取引管理番号(***dealNo***)を指定します。 ### 帳票を作成する組織の組織ID・事業種別ID 帳票を作成する権限のある組織の組織ID(***organizationId***)と事業種別ID(***businessTypeId***)のセットで指定します。 ### ターミナル問合せの取引・帳票ID 作成されるターミナル支払申込兼入金通知書にデータを引き継ぐ元となる、ターミナル問合せの取引・帳票ID(***terminalInquiryDealReportId***)を指定します。 ### デマレージ支払申込対象の明細番号 ターミナル支払申込兼入金通知書にデータを引き継ぐ際に、支払申込の対象とするターミナル問合せのコンテナ明細の明細番号(インデックス)を配列で指定します。(***demurragePaymentTarget***) このパラメータは必須ではありません。指定されなかった場合は、引継ぎ元のターミナル問合せのコンテナ明細すべてが引き継がれます。 また、引継ぎ元の問合せ項目(***inquiryItem***)がデマレージ(***demurrage***)以外の場合、このパラメータは指定できません。 |
|
DELETE | /API/v1/Report/TerminalPayment/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:ターミナル支払申込兼入金通知書を削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 ## 指定するパラメタについて ### 取引・帳票ID 削除する帳票の取引・帳票ID(***dealReportId***)を指定します。 ### 帳票を削除する組織の組織ID・事業種別ID 帳票を削除する権限のある組織の組織ID(***organizationId***)と事業種別ID(***businessTypeId***)のセットで指定します。 |
|
GET | /API/v1/Report/TerminalPayment/Get/{dealReportId} |
帳票:ターミナル支払申込兼入金通知書を取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対して、Read権限が必要です。 ## 指定するパラメタについて ### 取引・帳票ID 取得する帳票の取引・帳票ID(***dealReportId***)を指定します。 |
|
POST | /API/v1/Report/TerminalPayment/Register |
帳票:ターミナル支払申込兼入金通知書を保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対して、Write権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(etag)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 ## 指定するパラメタについて ### 取引管理番号 帳票を作成する取引の取引管理番号(***dealNo***)を指定します。 ### 帳票を作成する組織の組織ID・事業種別ID 帳票を作成する権限のある組織の組織ID(***organizationId***)と事業種別ID(***businessTypeId***)のセットで指定します。 |
VAE
VAE_バンニング情報登録(輸出管理番号単位)
API | Description | ||
---|---|---|---|
POST | /API/v1/NACCS/VAE/Create |
帳票:VAE_バンニング情報登録(輸出管理番号単位)を作成します。 帳票:VAE_バンニング情報登録(輸出管理番号単位)を作成します。帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対して、Write権限が必要です。また、取引内に帳票:VAE_バンニング情報登録(輸出管理番号単位)が存在する場合は、ステータスコード:200となり、Getメソッドと同じ動作となります。 |
|
DELETE | /API/v1/NACCS/VAE/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:VAE_バンニング情報登録(輸出管理番号単位)を削除します。 帳票:VAE_バンニング情報登録(輸出管理番号単位)を削除します。帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
GET | /API/v1/NACCS/VAE/Get/{dealReportId} |
帳票:VAE_バンニング情報登録(輸出管理番号単位)を取得します。 帳票:VAE_バンニング情報登録(輸出管理番号単位)を取得します。帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対して、Read権限が必要です。 |
VAH
VAH_バンニング・CY搬入情報登録
API | Description | ||
---|---|---|---|
POST | /API/v1/NACCS/VAH/Create |
帳票:VAH_バンニング・CY搬入情報登録を作成します。 帳票:VAH_バンニング・CY搬入情報登録を作成します。帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対して、Write権限が必要です。また、取引内に帳票:VAH_バンニング・CY搬入情報登録が存在する場合は、ステータスコード:200となり、Getメソッドと同じ動作となります。 |
|
DELETE | /API/v1/NACCS/VAH/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:VAH_バンニング・CY搬入情報登録を削除します。 帳票:VAH_バンニング・CY搬入情報登録を削除します。帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
GET | /API/v1/NACCS/VAH/Get/{dealReportId} |
帳票:VAH_バンニング・CY搬入情報登録を取得します。 帳票:VAH_バンニング・CY搬入情報登録を取得します。帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対して、Read権限が必要です。 |
VanningCancellations
VAC
API | Description | ||
---|---|---|---|
POST | /API/v1/NaccsReport/VanningCancellations/Create |
帳票:VACを作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 帳票:VACが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/VanningCancellations/CreateByBlNo |
B/L番号を指定して、帳票:VACを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定されたB/L番号(***blNo***)に該当する取引に対して、帳票:VACを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定されたB/L番号(***blNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:VACが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/VanningCancellations/CreateByBookingNo |
ブッキング番号を指定して、帳票:VACを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:VACを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:VACが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/VanningCancellations/CreateByDomesticNo |
社内管理番号を指定して、帳票:VACを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:VACを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:VACが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/NaccsReport/VanningCancellations/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:VACを削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/NaccsReport/VanningCancellations/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
B/L番号を指定して、帳票:VACを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、帳票:VACを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/VanningCancellations/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId} |
ブッキング番号を指定して、帳票:VACを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:VACを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/VanningCancellations/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
取引管理番号を指定して、帳票:VACを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:VACを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/VanningCancellations/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
社内管理番号を指定して、帳票:VACを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:VACを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/NaccsReport/VanningCancellations/Get/{dealReportId} |
帳票:VACを取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/NaccsReport/VanningCancellations/GetByDealNo/{dealNo} |
取引管理番号を指定して、帳票:VACを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:VACを取得します。 |
|
GET | /API/v1/NaccsReport/VanningCancellations/GetListByBlNo/{blNo} |
B/L番号を指定して、帳票:VACを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、VACを取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が付番されている全ての取引から、帳票:VACを取得します。 |
|
GET | /API/v1/NaccsReport/VanningCancellations/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo} |
ブッキング番号を指定して、帳票:VACを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:VACを取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が付番されている全ての取引から、帳票:VACを取得します。 |
|
GET | /API/v1/NaccsReport/VanningCancellations/GetListByDomesticNo/{domesticNo} |
社内管理番号を指定して、帳票:VACを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:VACを取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:VACを取得します。 |
|
POST | /API/v1/NaccsReport/VanningCancellations/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/VanningCancellations/Register |
帳票:VACを保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
VanningInstructions
バンニング作業依頼書
API | Description | ||
---|---|---|---|
POST | /API/v1/Report/VanningInstructions/Create |
帳票:バンニング作業依頼書を作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 |
|
POST | /API/v1/Report/VanningInstructions/CreateAttachFileMeta |
添付ファイルメタ情報を登録します。 |
|
POST | /API/v1/Report/VanningInstructions/CreateByBlNo |
B/L番号を指定して、帳票:バンニング作業依頼書を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定されたB/L番号(***blNo***)に該当する取引に対して、帳票:バンニング作業依頼書を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定されたB/L番号(***blNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 カスタムID(***customId***)は作成数に制限がない帳票を特定できるように任意に設定できる項目です。 カスタムID(***customId***)に値が設定されていなくても帳票:バンニング作業依頼書は作成可能です。同じカスタムID(***customId***)の帳票:バンニング作業依頼書が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/Report/VanningInstructions/CreateByBookingNo |
ブッキング番号を指定して、帳票:バンニング作業依頼書を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:バンニング作業依頼書を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 カスタムID(***customId***)は作成数に制限がない帳票を特定できるように任意に設定できる項目です。 カスタムID(***customId***)に値が設定されていなくても帳票:バンニング作業依頼書は作成可能です。同じカスタムID(***customId***)の帳票:バンニング作業依頼書が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/Report/VanningInstructions/CreateByDomesticNo |
社内管理番号を指定して、帳票:バンニング作業依頼書を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:バンニング作業依頼書を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 カスタムID(***customId***)は作成数に制限がない帳票を特定できるように任意に設定できる項目です。 カスタムID(***customId***)に値が設定されていなくても帳票:バンニング作業依頼書は作成可能です。同じカスタムID(***customId***)の帳票:バンニング作業依頼書が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/Report/VanningInstructions/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:バンニング作業依頼書を削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/Report/VanningInstructions/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId}&customId={customId} |
B/L番号を指定して、帳票:バンニング作業依頼書を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、帳票:バンニング作業依頼書を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/Report/VanningInstructions/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId}&customId={customId} |
ブッキング番号を指定して、帳票:バンニング作業依頼書を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:バンニング作業依頼書を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/Report/VanningInstructions/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId}&customId={customId} |
取引管理番号を指定して、帳票:バンニング作業依頼書を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:バンニング作業依頼書を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/Report/VanningInstructions/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId}&customId={customId} |
社内管理番号を指定して、帳票:バンニング作業依頼書を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:バンニング作業依頼書を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/Report/VanningInstructions/Get/{dealReportId} |
帳票:バンニング作業依頼書を取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/Report/VanningInstructions/GetAttachFileMetaList/{dealReportId} |
添付ファイル情報一覧を取得します。 |
|
GET | /API/v1/Report/VanningInstructions/GetListByBlNo/{blNo}?customId={customId} |
B/L番号を指定して、帳票:バンニング作業依頼書を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、バンニング作業依頼書を取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が付番されている全ての取引から、帳票:バンニング作業依頼書を取得します。 |
|
GET | /API/v1/Report/VanningInstructions/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&customId={customId} |
ブッキング番号を指定して、帳票:バンニング作業依頼書を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:バンニング作業依頼書を取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が付番されている全ての取引から、帳票:バンニング作業依頼書を取得します。 |
|
GET | /API/v1/Report/VanningInstructions/GetListByDealNo/{dealNo} |
取引管理番号を指定して、帳票:バンニング作業依頼書を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:バンニング作業依頼書を取得します。 |
|
GET | /API/v1/Report/VanningInstructions/GetListByDomesticNo/{domesticNo}?customId={customId} |
社内管理番号を指定して、帳票:バンニング作業依頼書を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:バンニング作業依頼書を取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:バンニング作業依頼書を取得します。 |
|
POST | /API/v1/Report/VanningInstructions/Register |
帳票:バンニング作業依頼書を保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
VanningRegistrationContainerUnitCalls
VAN11
API | Description | ||
---|---|---|---|
POST | /API/v1/NaccsReport/VanningRegistrationContainerUnitCalls/Create |
帳票:VAN11を作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 帳票:VAN11が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/VanningRegistrationContainerUnitCalls/CreateByBlNo |
B/L番号を指定して、帳票:VAN11を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定されたB/L番号(***blNo***)に該当する取引に対して、帳票:VAN11を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定されたB/L番号(***blNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:VAN11が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/VanningRegistrationContainerUnitCalls/CreateByBookingNo |
ブッキング番号を指定して、帳票:VAN11を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:VAN11を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:VAN11が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/VanningRegistrationContainerUnitCalls/CreateByDomesticNo |
社内管理番号を指定して、帳票:VAN11を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:VAN11を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:VAN11が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/NaccsReport/VanningRegistrationContainerUnitCalls/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:VAN11を削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/NaccsReport/VanningRegistrationContainerUnitCalls/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
B/L番号を指定して、帳票:VAN11を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、帳票:VAN11を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/VanningRegistrationContainerUnitCalls/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId} |
ブッキング番号を指定して、帳票:VAN11を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:VAN11を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/VanningRegistrationContainerUnitCalls/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
取引管理番号を指定して、帳票:VAN11を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:VAN11を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/VanningRegistrationContainerUnitCalls/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
社内管理番号を指定して、帳票:VAN11を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:VAN11を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/NaccsReport/VanningRegistrationContainerUnitCalls/Get/{dealReportId} |
帳票:VAN11を取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/NaccsReport/VanningRegistrationContainerUnitCalls/GetByDealNo/{dealNo} |
取引管理番号を指定して、帳票:VAN11を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:VAN11を取得します。 |
|
GET | /API/v1/NaccsReport/VanningRegistrationContainerUnitCalls/GetListByBlNo/{blNo} |
B/L番号を指定して、帳票:VAN11を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、VAN11を取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が付番されている全ての取引から、帳票:VAN11を取得します。 |
|
GET | /API/v1/NaccsReport/VanningRegistrationContainerUnitCalls/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo} |
ブッキング番号を指定して、帳票:VAN11を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:VAN11を取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が付番されている全ての取引から、帳票:VAN11を取得します。 |
|
GET | /API/v1/NaccsReport/VanningRegistrationContainerUnitCalls/GetListByDomesticNo/{domesticNo} |
社内管理番号を指定して、帳票:VAN11を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:VAN11を取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:VAN11を取得します。 |
|
POST | /API/v1/NaccsReport/VanningRegistrationContainerUnitCalls/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/VanningRegistrationContainerUnitCalls/Register |
帳票:VAN11を保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
VanningRegistrationContainerUnits
VAN
API | Description | ||
---|---|---|---|
POST | /API/v1/NaccsReport/VanningRegistrationContainerUnits/Create |
帳票:VANを作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 |
|
POST | /API/v1/NaccsReport/VanningRegistrationContainerUnits/CreateByBlNo |
B/L番号を指定して、帳票:VANを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定されたB/L番号(***blNo***)に該当する取引に対して、帳票:VANを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定されたB/L番号(***blNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 カスタムID(***customId***)は作成数に制限がない帳票を特定できるように任意に設定できる項目です。 カスタムID(***customId***)に値が設定されていなくても帳票:VANは作成可能です。同じカスタムID(***customId***)の帳票:VANが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/VanningRegistrationContainerUnits/CreateByBookingNo |
ブッキング番号を指定して、帳票:VANを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:VANを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 カスタムID(***customId***)は作成数に制限がない帳票を特定できるように任意に設定できる項目です。 カスタムID(***customId***)に値が設定されていなくても帳票:VANは作成可能です。同じカスタムID(***customId***)の帳票:VANが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/VanningRegistrationContainerUnits/CreateByDomesticNo |
社内管理番号を指定して、帳票:VANを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:VANを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 カスタムID(***customId***)は作成数に制限がない帳票を特定できるように任意に設定できる項目です。 カスタムID(***customId***)に値が設定されていなくても帳票:VANは作成可能です。同じカスタムID(***customId***)の帳票:VANが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/NaccsReport/VanningRegistrationContainerUnits/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:VANを削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/NaccsReport/VanningRegistrationContainerUnits/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId}&customId={customId} |
B/L番号を指定して、帳票:VANを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、帳票:VANを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/VanningRegistrationContainerUnits/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId}&customId={customId} |
ブッキング番号を指定して、帳票:VANを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:VANを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/VanningRegistrationContainerUnits/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId}&customId={customId} |
取引管理番号を指定して、帳票:VANを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:VANを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/VanningRegistrationContainerUnits/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId}&customId={customId} |
社内管理番号を指定して、帳票:VANを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:VANを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/NaccsReport/VanningRegistrationContainerUnits/Get/{dealReportId} |
帳票:VANを取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/NaccsReport/VanningRegistrationContainerUnits/GetListByBlNo/{blNo}?customId={customId} |
B/L番号を指定して、帳票:VANを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、VANを取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が付番されている全ての取引から、帳票:VANを取得します。 |
|
GET | /API/v1/NaccsReport/VanningRegistrationContainerUnits/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&customId={customId} |
ブッキング番号を指定して、帳票:VANを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:VANを取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が付番されている全ての取引から、帳票:VANを取得します。 |
|
GET | /API/v1/NaccsReport/VanningRegistrationContainerUnits/GetListByDealNo/{dealNo} |
取引管理番号を指定して、帳票:VANを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:VANを取得します。 |
|
GET | /API/v1/NaccsReport/VanningRegistrationContainerUnits/GetListByDomesticNo/{domesticNo}?customId={customId} |
社内管理番号を指定して、帳票:VANを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:VANを取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:VANを取得します。 |
|
POST | /API/v1/NaccsReport/VanningRegistrationContainerUnits/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/VanningRegistrationContainerUnits/Register |
帳票:VANを保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
VanningRegistrationExportNoUnitCalls
VAE11
API | Description | ||
---|---|---|---|
POST | /API/v1/NaccsReport/VanningRegistrationExportNoUnitCalls/Create |
帳票:VAE11を作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 帳票:VAE11が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/VanningRegistrationExportNoUnitCalls/CreateByBlNo |
B/L番号を指定して、帳票:VAE11を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定されたB/L番号(***blNo***)に該当する取引に対して、帳票:VAE11を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定されたB/L番号(***blNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:VAE11が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/VanningRegistrationExportNoUnitCalls/CreateByBookingNo |
ブッキング番号を指定して、帳票:VAE11を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:VAE11を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:VAE11が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/VanningRegistrationExportNoUnitCalls/CreateByDomesticNo |
社内管理番号を指定して、帳票:VAE11を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:VAE11を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:VAE11が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/NaccsReport/VanningRegistrationExportNoUnitCalls/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:VAE11を削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/NaccsReport/VanningRegistrationExportNoUnitCalls/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
B/L番号を指定して、帳票:VAE11を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、帳票:VAE11を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/VanningRegistrationExportNoUnitCalls/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId} |
ブッキング番号を指定して、帳票:VAE11を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:VAE11を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/VanningRegistrationExportNoUnitCalls/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
取引管理番号を指定して、帳票:VAE11を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:VAE11を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/VanningRegistrationExportNoUnitCalls/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId} |
社内管理番号を指定して、帳票:VAE11を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:VAE11を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/NaccsReport/VanningRegistrationExportNoUnitCalls/Get/{dealReportId} |
帳票:VAE11を取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/NaccsReport/VanningRegistrationExportNoUnitCalls/GetByDealNo/{dealNo} |
取引管理番号を指定して、帳票:VAE11を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:VAE11を取得します。 |
|
GET | /API/v1/NaccsReport/VanningRegistrationExportNoUnitCalls/GetListByBlNo/{blNo} |
B/L番号を指定して、帳票:VAE11を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、VAE11を取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が付番されている全ての取引から、帳票:VAE11を取得します。 |
|
GET | /API/v1/NaccsReport/VanningRegistrationExportNoUnitCalls/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo} |
ブッキング番号を指定して、帳票:VAE11を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:VAE11を取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が付番されている全ての取引から、帳票:VAE11を取得します。 |
|
GET | /API/v1/NaccsReport/VanningRegistrationExportNoUnitCalls/GetListByDomesticNo/{domesticNo} |
社内管理番号を指定して、帳票:VAE11を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:VAE11を取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:VAE11を取得します。 |
|
POST | /API/v1/NaccsReport/VanningRegistrationExportNoUnitCalls/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/VanningRegistrationExportNoUnitCalls/Register |
帳票:VAE11を保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
VanningRegistrationExportNoUnits
VAE
API | Description | ||
---|---|---|---|
POST | /API/v1/NaccsReport/VanningRegistrationExportNoUnits/Create |
帳票:VAEを作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 |
|
POST | /API/v1/NaccsReport/VanningRegistrationExportNoUnits/CreateByBlNo |
B/L番号を指定して、帳票:VAEを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定されたB/L番号(***blNo***)に該当する取引に対して、帳票:VAEを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定されたB/L番号(***blNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 カスタムID(***customId***)は作成数に制限がない帳票を特定できるように任意に設定できる項目です。 カスタムID(***customId***)に値が設定されていなくても帳票:VAEは作成可能です。同じカスタムID(***customId***)の帳票:VAEが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/VanningRegistrationExportNoUnits/CreateByBookingNo |
ブッキング番号を指定して、帳票:VAEを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:VAEを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 カスタムID(***customId***)は作成数に制限がない帳票を特定できるように任意に設定できる項目です。 カスタムID(***customId***)に値が設定されていなくても帳票:VAEは作成可能です。同じカスタムID(***customId***)の帳票:VAEが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/NaccsReport/VanningRegistrationExportNoUnits/CreateByDomesticNo |
社内管理番号を指定して、帳票:VAEを作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:VAEを作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 カスタムID(***customId***)は作成数に制限がない帳票を特定できるように任意に設定できる項目です。 カスタムID(***customId***)に値が設定されていなくても帳票:VAEは作成可能です。同じカスタムID(***customId***)の帳票:VAEが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/NaccsReport/VanningRegistrationExportNoUnits/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:VAEを削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/NaccsReport/VanningRegistrationExportNoUnits/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId}&customId={customId} |
B/L番号を指定して、帳票:VAEを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、帳票:VAEを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/VanningRegistrationExportNoUnits/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId}&customId={customId} |
ブッキング番号を指定して、帳票:VAEを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:VAEを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/VanningRegistrationExportNoUnits/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId}&customId={customId} |
取引管理番号を指定して、帳票:VAEを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:VAEを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/NaccsReport/VanningRegistrationExportNoUnits/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId}&customId={customId} |
社内管理番号を指定して、帳票:VAEを削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:VAEを削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/NaccsReport/VanningRegistrationExportNoUnits/Get/{dealReportId} |
帳票:VAEを取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/NaccsReport/VanningRegistrationExportNoUnits/GetListByBlNo/{blNo}?customId={customId} |
B/L番号を指定して、帳票:VAEを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、VAEを取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が付番されている全ての取引から、帳票:VAEを取得します。 |
|
GET | /API/v1/NaccsReport/VanningRegistrationExportNoUnits/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&customId={customId} |
ブッキング番号を指定して、帳票:VAEを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:VAEを取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が付番されている全ての取引から、帳票:VAEを取得します。 |
|
GET | /API/v1/NaccsReport/VanningRegistrationExportNoUnits/GetListByDealNo/{dealNo} |
取引管理番号を指定して、帳票:VAEを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:VAEを取得します。 |
|
GET | /API/v1/NaccsReport/VanningRegistrationExportNoUnits/GetListByDomesticNo/{domesticNo}?customId={customId} |
社内管理番号を指定して、帳票:VAEを取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:VAEを取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:VAEを取得します。 |
|
POST | /API/v1/NaccsReport/VanningRegistrationExportNoUnits/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/VanningRegistrationExportNoUnits/Register |
帳票:VAEを保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
VerifiedGrossMassReports
コンテナ確定重量報告書
API | Description | ||
---|---|---|---|
POST | /API/v1/Report/VerifiedGrossMassReports/Create |
帳票:コンテナ確定重量報告書を作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ## 帳票の作成単位 帳票:コンテナ確定重量報告書を取引内にコンテナ番号(***containerNo***)の単位で作成します。 同じコンテナ番号(***containerNo***)の帳票:コンテナ確定重量報告書が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/Report/VerifiedGrossMassReports/CreateAttachFileMeta |
添付ファイルメタ情報を登録します。 |
|
POST | /API/v1/Report/VerifiedGrossMassReports/CreateByBlNo |
B/L番号を指定して、帳票:コンテナ確定重量報告書を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定されたB/L番号(***blNo***)に該当する取引に対して、帳票:コンテナ確定重量報告書を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定されたB/L番号(***blNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 ## 帳票の作成単位 帳票:コンテナ確定重量報告書を取引内にコンテナ番号(***containerNo***)の単位で作成します。 同じコンテナ番号(***containerNo***)の帳票:コンテナ確定重量報告書が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/Report/VerifiedGrossMassReports/CreateByBookingNo |
ブッキング番号を指定して、帳票:コンテナ確定重量報告書を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:コンテナ確定重量報告書を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 ## 帳票の作成単位 帳票:コンテナ確定重量報告書を取引内にコンテナ番号(***containerNo***)の単位で作成します。 同じコンテナ番号(***containerNo***)の帳票:コンテナ確定重量報告書が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
POST | /API/v1/Report/VerifiedGrossMassReports/CreateByDomesticNo |
社内管理番号を指定して、帳票:コンテナ確定重量報告書を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された社内管理番号(***domesticNo***)に該当する取引に対して、帳票:コンテナ確定重量報告書を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、社内管理番号に該当する取引が存在しない、または複数存在する場合はエラーとなります。 ## 帳票の作成単位 帳票:コンテナ確定重量報告書を取引内にコンテナ番号(***containerNo***)の単位で作成します。 同じコンテナ番号(***containerNo***)の帳票:コンテナ確定重量報告書が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/Report/VerifiedGrossMassReports/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:コンテナ確定重量報告書を削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
DELETE | /API/v1/Report/VerifiedGrossMassReports/DeleteByBlNo/{blNo}?organizationId={organizationId}&businessTypeId={businessTypeId}&containerNo={containerNo} |
B/L番号を指定して、帳票:コンテナ確定重量報告書を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、帳票:コンテナ確定重量報告書を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/Report/VerifiedGrossMassReports/DeleteByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&organizationId={organizationId}&businessTypeId={businessTypeId}&containerNo={containerNo} |
ブッキング番号を指定して、帳票:コンテナ確定重量報告書を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:コンテナ確定重量報告書を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/Report/VerifiedGrossMassReports/DeleteByDealNo/{dealNo}?organizationId={organizationId}&businessTypeId={businessTypeId}&containerNo={containerNo} |
取引管理番号を指定して、帳票:コンテナ確定重量報告書を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:コンテナ確定重量報告書を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
DELETE | /API/v1/Report/VerifiedGrossMassReports/DeleteByDomesticNo/{domesticNo}?organizationId={organizationId}&businessTypeId={businessTypeId}&containerNo={containerNo} |
社内管理番号を指定して、帳票:コンテナ確定重量報告書を削除します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:コンテナ確定重量報告書を削除します。 帳票を削除できるのは、その帳票を作成した組織に所属するユーザのみです。 指定されたパラメタに該当する帳票が複数存在する場合はエラーとなります。 |
|
GET | /API/v1/Report/VerifiedGrossMassReports/Get/{dealReportId} |
帳票:コンテナ確定重量報告書を取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/Report/VerifiedGrossMassReports/GetAttachFileMetaList/{dealReportId} |
添付ファイル情報一覧を取得します。 |
|
GET | /API/v1/Report/VerifiedGrossMassReports/GetListByBlNo/{blNo}?containerNo={containerNo} |
B/L番号を指定して、帳票:コンテナ確定重量報告書を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、B/L番号(***blNo***)に該当する取引より、コンテナ確定重量報告書を取得します。 取引内に作成する帳票にB/L番号(***blNo***)を設定すると、その帳票が格納された取引はB/L番号(***blNo***)で特定できるようになります。 このAPIでは、指定されたB/L番号(***blNo***)が付番されている全ての取引から、帳票:コンテナ確定重量報告書を取得します。 |
|
GET | /API/v1/Report/VerifiedGrossMassReports/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}&containerNo={containerNo} |
ブッキング番号を指定して、帳票:コンテナ確定重量報告書を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引より、帳票:コンテナ確定重量報告書を取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が付番されている全ての取引から、帳票:コンテナ確定重量報告書を取得します。 |
|
GET | /API/v1/Report/VerifiedGrossMassReports/GetListByDealNo/{dealNo} |
取引管理番号を指定して、帳票:コンテナ確定重量報告書を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、取引管理番号(***dealNo***)に該当する取引より、帳票:コンテナ確定重量報告書を取得します。 |
|
GET | /API/v1/Report/VerifiedGrossMassReports/GetListByDomesticNo/{domesticNo}?containerNo={containerNo} |
社内管理番号を指定して、帳票:コンテナ確定重量報告書を取得します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、社内管理番号(***domesticNo***)に該当する取引より、帳票:コンテナ確定重量報告書を取得します。 社内管理番号(***domesticNo***)は、取引管理番号の別名として機能します。社内管理番号(***domesticNo***)は取引に参加している組織・事業種別毎に付番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号(***domesticNo***)が付番されている全ての取引から、帳票:コンテナ確定重量報告書を取得します。 |
|
POST | /API/v1/Report/VerifiedGrossMassReports/Register |
帳票:コンテナ確定重量報告書を保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
VgmConfirmParties
VGM確定事業者リスト
API | Description | ||
---|---|---|---|
GET | /API/v1/Master/VgmConfirmParties/GetListByNotificationNo/{notificationNo} |
VGM確定事業者マスタから、届出番号・登録番号を指定して、VGM確定事業者の情報を取得します。 ## 概要 APIを呼び出すユーザが所属している会社の法人番号と合致しないVGM確定事業者の情報の場合、参照できる項目は以下だけとなります。 事業種別ID(***businessTypeId***) 法人番号(***corporateNo***) 申請者住所(***corporateNo***) 申請者住所(***notificationAddress***) 届出年月日(***notificationDate***) 申請者名(***notificationName***) 届出番号(***notificationNo***) VGM確定事業者番号(***vgmConfirmPartyNo***) VGM確定方法1(***vgmMethod1***) VGM確定方法2(***vgmMethod2***) |