Accepters
帳票を受け取る事業種別
API | Description | ||
---|---|---|---|
DELETE | /API/v2/Master/StandardProcesses/Accepters/DeleteAdmin/{standardProcessAccepterCode} |
帳票を受け取る事業種別コードを指定して、帳票を受け取る事業種別を削除します。 帳票を受け取る事業種別コード(***standardProcessAccepterCode***)プロセスで取り扱う帳票を受け取る事業種別を取得します。 このAPIはシステム管理者しか呼び出せません。 (*For admin) |
|
GET | /API/v2/Master/StandardProcesses/Accepters/Get/{standardProcessAccepterCode} |
帳票を受け取る事業種別コードを指定して、帳票を受け取る事業種別を取得します 帳票を受け取る事業種別コード(***standardProcessAccepterCode***)を指定して、プロセスで取り扱う帳票を受け取る事業種別を取得します。 グループ配下のプロセスも含めて、取得する場合は、(***/API/v2/Master/StandardProcesses/GetList***)を使用します。 プロセスに関する詳細については、[プロセスについて]()を参照ください。 |
|
POST | /API/v2/Master/StandardProcesses/Accepters/RegisterAdmin |
帳票を受け取る事業種別を登録します。 このAPIはシステム管理者しか呼び出せません。 (*For admin) |
|
POST | /API/v2/Master/StandardProcesses/Accepters/RegisterInternal |
帳票を受け取る事業種別を登録します。 内部呼び出し用。 (*For admin) |
AccessiblePartners
帳票にアクセス可能なパートナー
API | Description | ||
---|---|---|---|
DELETE | /API/v2/Reports/AccessiblePartners/Delete/{accessiblePartnerId} |
帳票にアクセス可能なパートナーを削除します。 アクセス可能なパートナーID(***accessiblePartnerId***)を指定して、アクセス可能なパートナーを削除します。 帳票にアクセス可能なパートナーに関する詳細については、[帳票にアクセス可能なパートナーについて]()を参照ください。 |
|
GET | /API/v2/Reports/AccessiblePartners/Get/{accessiblePartnerId} |
帳票にアクセス可能なパートナーを取得します。 アクセス可能なパートナーID(***accessiblePartnerId***)を指定して、帳票にアクセス可能なパートナーを取得します。 帳票にアクセス可能なパートナーに関する詳細については、[帳票にアクセス可能なパートナーについて]()を参照ください。 |
|
GET | /API/v2/Reports/AccessiblePartners/GetList/{reportId} |
帳票にアクセス可能なパートナーを取得します。 帳票ID(***reportId***)を指定して、帳票にアクセス可能なパートナーを取得します。 帳票にアクセス可能なパートナーに関する詳細については、[帳票にアクセス可能なパートナーについて]()を参照ください。 |
|
POST | /API/v2/Reports/AccessiblePartners/Register |
帳票にアクセス可能なパートナーを登録します。 指定された帳票に、アクセス可能なパートナーを登録します。 登録可能なパートナーは、取引内での帳票アクセス権限(***/API/v2/Trades/Partners/PermissionInTrades***)で、対象となる帳票に対して、RW、もしくは、R権限が付与されている必要があります。 ただし、帳票アクセス権限(***/API/v2/Master/Reports/Permissions***)での設定以上に権限を変更することは出来ません。例えば、帳票アクセス権限(***/API/v2/Master/Reports/Permissions***)での設定で、ある帳票にRead権限までが設定されている場合、これをWrite権限に変更することは出来ません。 帳票にアクセス可能なパートナーに関する詳細については、[帳票にアクセス可能なパートナーについて]()を参照ください。 |
|
POST | /API/v2/Reports/AccessiblePartners/RegisterList |
帳票にアクセス可能なパートナーを登録します。 指定された帳票に、アクセス可能なパートナーをまとめて登録します。 帳票にアクセス可能なパートナーに関する詳細については、[帳票にアクセス可能なパートナーについて]()を参照ください。 |
|
PATCH | /API/v2/Reports/AccessiblePartners/Update/{accessiblePartnerId} |
帳票へのアクセス権限を更新します。 帳票にアクセス可能なパートナーID(***accessiblePartnerId***)を指定して、帳票への帳票アクセス権限を更新します。 ただし、帳票アクセス権限(***/API/v2/Master/Reports/Permissions***)での設定以上に権限を変更することは出来ません。例えば、帳票アクセス権限(***/API/v2/Master/Reports/Permissions***)での設定で、ある帳票にRead権限までが設定されている場合、これをWrite権限に変更することは出来ません。 帳票にアクセス可能なパートナーに関する詳細については、[帳票にアクセス可能なパートナーについて]()を参照ください。 |
AccidentCodes
事故コード
API | Description | ||
---|---|---|---|
DELETE | /API/v2/General/AccidentCodes/DeleteAdmin/{accidentCode} |
事故コードを削除します。 事故コード(***accidentCode***)を指定して、事故コードを削除します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
GET | /API/v2/General/AccidentCodes/Get/{accidentCode} |
事故種別を取得します。 事故コード(***accidentCode***)を指定して、事故種別を取得します。 事故コードに関する詳細については、[事故コードについて]()を参照ください。 |
|
GET | /API/v2/General/AccidentCodes/GetList |
事故種別を全て取得します。 事故コードに関する詳細については、[事故コードについて]()を参照ください。 |
|
POST | /API/v2/General/AccidentCodes/RegisterAdmin |
事故種別を登録します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
POST | /API/v2/General/AccidentCodes/RegisterInternal |
事故種別を登録します。 内部呼び出し用。 (*For admin) |
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でのレスポンスデータを編集し、指定するようにしてください。 |
Administrators
会社の管理者
API | Description | ||
---|---|---|---|
DELETE | /API/v2/Companies/Administrators/Delete/{administratorId} |
会社の管理者を削除します。 管理者ID(***administratorId***)を指定して、会社の管理者を削除します。 このメソッドは会社の管理者(***/API/v2/Companies/Administrators***)として登録された利用者が利用できます。 会社の管理者に関する詳細については、[会社の管理者について]()を参照ください。 |
|
GET | /API/v2/Companies/Administrators/Get/{administratorId} |
会社の管理者を取得します。 管理者ID(***administratorId***)を指定して、会社の管理者を取得します。 会社の管理者に関する詳細については、[会社の管理者について]()を参照ください。 |
|
GET | /API/v2/Companies/Administrators/GetList |
会社の管理者を全て取得します。 ログインしている利用者が所属する会社の管理者を全て取得します。 会社の管理者に関する詳細については、[会社の管理者について]()を参照ください。 |
|
POST | /API/v2/Companies/Administrators/Register |
会社の管理者を登録します。 管理者が所属する会社の中から利用者を指定して、管理者として登録します。 このメソッドは会社の管理者(***/API/v2/Companies/Administrators***)として登録された利用者が利用できます。 会社の管理者に関する詳細については、[会社の管理者について]()を参照ください。 |
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でのレスポンスデータを編集し、指定するようにしてください。 |
ArrivalNotices
到着通知(A/N)
API | Description | ||
---|---|---|---|
POST | /API/v2/Reports/ArrivalNotices/Create |
到着通知(A/N)を作成します。 到着通知(A/N)を作成するには、利用者が到着通知(A/N)を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 到着通知(A/N)に関する詳細については、[到着通知(A/N)について]()を参照ください。 |
|
DELETE | /API/v2/Reports/ArrivalNotices/Delete/{reportId} |
到着通知(A/N)を削除します。 帳票ID(***reportId***)を指定して、到着通知(A/N)を削除します。 到着通知(A/N)を削除しても、ルートドキュメントの内容までは削除されません。 申請種別を使用して、作成した到着通知(A/N)のキャンセルを伝える場合は、キャンセル(***Cancel***)を実施後、帳票の提出(***Submit***)を実施してください。 到着通知(A/N)に関する詳細については、[到着通知(A/N)について]()を参照ください。 |
|
DELETE | /API/v2/Reports/ArrivalNotices/DeleteFile/{fileId} |
到着通知(A/N)の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、到着通知(A/N)の添付ファイルを削除します。 帳票の添付ファイルを削除できるのは、そのファイルを添付したパートナーに所属している利用者だけです。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
GET | /API/v2/Reports/ArrivalNotices/Get/{reportId} |
到着通知(A/N)を取得します。 帳票ID(***reportId***)を指定して、到着通知(A/N)を取得します。 編集が行われていない場合は、ルートドキュメントから最新の到着通知(A/N)を取得します。 編集中の場合は、先に保存した、到着通知(A/N)を取得します。 到着通知(A/N)に関する詳細については、[到着通知(A/N)について]()を参照ください。 |
|
GET | /API/v2/Reports/ArrivalNotices/GetFile/{fileId} |
到着通知(A/N)に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、到着通知(A/N)に添付されたファイルを取得します。 帳票の添付ファイルを獲得できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
GET | /API/v2/Reports/ArrivalNotices/GetList?tradeNo=!{tradeNo}&uniqueNo=!{uniqueNo}&bookingNo=!{bookingNo}&blNo=!{blNo} |
到着通知(A/N)を全て取得します。 検索条件に該当する到着通知(A/N)を全て取得します。 編集が行われていない場合は、ルートドキュメントから最新の到着通知(A/N)を取得します。 編集中の場合は、先に保存した、到着通知(A/N)を取得します。 到着通知(A/N)に関する詳細については、[到着通知(A/N)について]()を参照ください。 |
|
PATCH | /API/v2/Reports/ArrivalNotices/Lock/{reportId} |
編集するため、到着通知(A/N)をロックします 帳票ID(***reportId***)を指定して、到着通知(A/N)をロックします。 到着通知(A/N)を作成(***Create***)した時点では、到着通知(A/N)をロックが掛かりますが、取得(***Get***)したあとで、到着通知(A/N)を編集する場合は、このメソッドを呼び出して、到着通知(A/N)をロックします。 ロックされた到着通知(A/N)は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、到着通知(A/N)をルートドキュメントから参照できますが、編集中(ロック中)の到着通知(A/N)は参照できません。 このロックは、アンロック(***Unlock***)を呼び出すか、帳票の保存後、帳票の提出(***Submit****)を行うと解除されます。 到着通知(A/N)に関する詳細については、[到着通知(A/N)について]()を参照ください。 |
|
PATCH | /API/v2/Reports/ArrivalNotices/SetCancel/{reportId} |
到着通知(A/N)の申請種別をキャンセルします 帳票ID(***reportId***)を指定して、到着通知(A/N)の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 到着通知(A/N)に関する詳細については、[到着通知(A/N)について]()を参照ください。 |
|
PATCH | /API/v2/Reports/ArrivalNotices/Submit/{reportId} |
到着通知(A/N)を提出します 帳票ID(***reportId***)を指定して、更新(***Update***)した到着通知(A/N)を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、到着通知(A/N)が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、到着通知(A/N)もロックされた状態のままなので、ご注意ください。 到着通知(A/N)に関する詳細については、[到着通知(A/N)について]()を参照ください。 |
|
PATCH | /API/v2/Reports/ArrivalNotices/Unlock/{reportId} |
到着通知(A/N)のロックを解除します 帳票ID(***reportId***)を指定して、到着通知(A/N)のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 到着通知(A/N)に関する詳細については、[到着通知(A/N)について]()を参照ください。 |
|
PATCH | /API/v2/Reports/ArrivalNotices/Update/{reportId} |
到着通知(A/N)を更新します。 帳票ID(***reportId***)を指定して、到着通知(A/N)を更新します。 このメソッドでは、到着通知(A/N)の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 到着通知(A/N)に関する詳細については、[到着通知(A/N)について]()を参照ください。 |
|
POST | /API/v2/Reports/ArrivalNotices/UploadFile |
到着通知(A/N)にファイルを添付します。 指定された到着通知(A/N)に、ファイルを添付します。 帳票にファイルを添付できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
AssignedBusinessTypes
組織の事業種別
API | Description | ||
---|---|---|---|
GET | /API/v2/Organizations/AssignedBusinessTypes/GetAssignedBusinessTypeId/{organizationId}/{businessTypeCode} |
組織に割り当てられた事業種別IDを取得します。 組織ID(***organizationId***)と事業種別コード(***businessTypeCode***)を指定して、組織に割り当てられた事業種別ID(***assignedBusinessTypeId***)を取得します。 組織に割り当てられた事業種別に関する詳細については、[組織の事業種別について]()を参照ください。 |
|
GET | /API/v2/Organizations/AssignedBusinessTypes/GetList/{organizationId} |
組織に割り当てられた事業種別を全て取得します。 組織ID(***organizationId***)を指定して、組織に割り当てられた事業種別を全て取得します。 組織に割り当てられた事業種別に関する詳細については、[組織の事業種別について]()を参照ください。 |
|
POST | /API/v2/Organizations/AssignedBusinessTypes/Register |
会社内の組織に割り当てる事業種別を登録します。 会社に割り当てられた事業種別の中から、組織に割り当てる事業種別を登録します。 このメソッドは会社の管理者(***/API/v2/Companies/Administrators***)として登録された利用者が利用できます。 組織に割り当てられた事業種別に関する詳細については、[組織の事業種別について]()を参照ください。 |
|
POST | /API/v2/Organizations/AssignedBusinessTypes/RegisterList |
会社内の組織に割り当てる事業種別を一括で登録します。 会社に割り当てられた事業種別の中から、組織に割り当てる事業種別を一括で登録します。 このメソッドは会社の管理者(***/API/v2/Companies/Administrators***)として登録された利用者が利用できます。 組織に割り当てられた事業種別に関する詳細については、[組織の事業種別について]()を参照ください。 |
AssociatedEmployees
組織に所属する利用者
API | Description | ||
---|---|---|---|
GET | /API/v2/Organizations/AssociatedEmployees/Get/{associatedEmployeeId} |
組織に所属する利用者を取得します。 組織に所属する利用者ID(***associatedEmployeeId***)を指定して、組織に所属する利用者を取得します。 |
|
GET | /API/v2/Organizations/AssociatedEmployees/GetCoworkers/{organizationId} |
組織に所属する利用者を全て取得します。 組織ID(***organizationId***)を指定して、組織に所属する利用者を全て取得します。 |
|
POST | /API/v2/Organizations/AssociatedEmployees/Register |
組織に所属する利用者を登録します。 管理者が所属する会社の組織に、利用者を登録します。 このメソッドは会社の管理者(***/API/v2/Companies/Administrators***)として登録された利用者が利用できます。 |
AttachFiles
帳票の添付ファイル
API | Description | ||
---|---|---|---|
DELETE | /API/v2/Reports/AttachFiles/Delete/{fileId} |
帳票の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、帳票の添付ファイルを削除します。 帳票の添付ファイルを削除できるのは、そのファイルを添付したパートナーに所属している利用者だけです。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
GET | /API/v2/Reports/AttachFiles/Get/{fileId} |
帳票の添付ファイルを取得します。 ファイルID(***fileId***)を指定して、帳票の添付ファイルを取得します。 帳票の添付ファイルを獲得できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
GET | /API/v2/Reports/AttachFiles/GetList/{reportId}?attachedByAccessiblePartnerId=!{attachedByAccessiblePartnerId}&attachedByOrganizationId=!{attachedByOrganizationId}&fileName=!{fileName}&contentType=!{contentType} |
帳票の添付ファイルについてのメタ情報を全て取得します。 帳票ID(***reportId***)を指定して、その帳票の添付ファイルについてのメタ情報を全て取得します。 帳票の添付ファイルを獲得できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
POST | /API/v2/Reports/AttachFiles/Register |
帳票にファイルを添付します。 指定された帳票に、ファイルを添付します。 帳票にファイルを添付できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
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でのレスポンスデータを編集し、指定するようにしてください。 |
BerthCodes
バースコード
API | Description | ||
---|---|---|---|
GET | /API/v2/General/BerthCodes/Get/{portCode}/{berthCode} |
バースコードを取得します。 港コード(***portCode***)とバースコード(***berthCode***)を指定して、バースコードを取得します。 NACCSから連携されるマスターデータに関する詳細については、[NACCSから連携されるマスターデータについて]()を参照ください。 |
|
GET | /API/v2/General/BerthCodes/GetList?portCode=!{portCode}&berthCode=!{berthCode}&berthNameJa=!{berthNameJa}&berthName=!{berthName} |
バースコードを取得します。 検索条件に該当するバースコードを全て取得します。 NACCSから連携されるマスターデータに関する詳細については、[NACCSから連携されるマスターデータについて]()を参照ください。 |
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でのレスポンスデータを編集し、指定するようにしてください。 |
BillOfLadingNumberNotices
B/L番号通知書
API | Description | ||
---|---|---|---|
POST | /API/v2/Reports/BillOfLadingNumberNotices/Create |
B/L番号通知書を作成します。 B/L番号通知書を作成するには、利用者がB/L番号通知書を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 B/L番号通知書に関する詳細については、[B/L番号通知書について]()を参照ください。 |
|
DELETE | /API/v2/Reports/BillOfLadingNumberNotices/Delete/{reportId} |
B/L番号通知書を削除します。 帳票ID(***reportId***)を指定して、B/L番号通知書を削除します。 B/L番号通知書を削除しても、ルートドキュメントの内容までは削除されません。 申請種別を使用して、作成したB/L番号通知書のキャンセルを伝える場合は、キャンセル(***Cancel***)を実施後、帳票の提出(***Submit***)を実施してください。 B/L番号通知書に関する詳細については、[B/L番号通知書について]()を参照ください。 |
|
DELETE | /API/v2/Reports/BillOfLadingNumberNotices/DeleteFile/{fileId} |
B/L番号通知書の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、B/L番号通知書の添付ファイルを削除します。 帳票の添付ファイルを削除できるのは、そのファイルを添付したパートナーに所属している利用者だけです。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
GET | /API/v2/Reports/BillOfLadingNumberNotices/Get/{reportId} |
B/L番号通知書を取得します。 帳票ID(***reportId***)を指定して、B/L番号通知書を取得します。 編集が行われていない場合は、ルートドキュメントから最新のB/L番号通知書を取得します。 編集中の場合は、先に保存した、B/L番号通知書を取得します。 B/L番号通知書に関する詳細については、[B/L番号通知書について]()を参照ください。 |
|
GET | /API/v2/Reports/BillOfLadingNumberNotices/GetFile/{fileId} |
B/L番号通知書に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、B/L番号通知書に添付されたファイルを取得します。 帳票の添付ファイルを獲得できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
GET | /API/v2/Reports/BillOfLadingNumberNotices/GetList?tradeNo=!{tradeNo}&uniqueNo=!{uniqueNo}&bookingNo=!{bookingNo}&blNo=!{blNo} |
B/L番号通知書を全て取得します。 検索条件に該当するB/L番号通知書を全て取得します。 編集が行われていない場合は、ルートドキュメントから最新のB/L番号通知書を取得します。 編集中の場合は、先に保存した、B/L番号通知書を取得します。 B/L番号通知書に関する詳細については、[B/L番号通知書について]()を参照ください。 |
|
PATCH | /API/v2/Reports/BillOfLadingNumberNotices/Lock/{reportId} |
編集するため、B/L番号通知書をロックします 帳票ID(***reportId***)を指定して、B/L番号通知書をロックします。 B/L番号通知書を作成(***Create***)した時点では、B/L番号通知書をロックが掛かりますが、取得(***Get***)したあとで、B/L番号通知書を編集する場合は、このメソッドを呼び出して、B/L番号通知書をロックします。 ロックされたB/L番号通知書は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、B/L番号通知書をルートドキュメントから参照できますが、編集中(ロック中)の船荷証券(B/L)は参照できません。 このロックは、アンロック(***Unlock***)を呼び出すか、帳票の保存後、帳票の提出(***Submit****)を行うと解除されます。 B/L番号通知書に関する詳細については、[B/L番号通知書について]()を参照ください。 |
|
PATCH | /API/v2/Reports/BillOfLadingNumberNotices/SetCancel/{reportId} |
B/L番号通知書の申請種別をキャンセルします 帳票ID(***reportId***)を指定して、B/L番号通知書の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 B/L番号通知書に関する詳細については、[B/L番号通知書について]()を参照ください。 |
|
PATCH | /API/v2/Reports/BillOfLadingNumberNotices/Submit/{reportId} |
B/L番号通知書を提出します 帳票ID(***reportId***)を指定して、更新(***Update***)したB/L番号通知書を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、B/L番号通知書が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、B/L番号通知書もロックされた状態のままなので、ご注意ください。 B/L番号通知書に関する詳細については、[B/L番号通知書について]()を参照ください。 |
|
PATCH | /API/v2/Reports/BillOfLadingNumberNotices/Unlock/{reportId} |
B/L番号通知書のロックを解除します 帳票ID(***reportId***)を指定して、B/L番号通知書のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 B/L番号通知書に関する詳細については、[B/L番号通知書について]()を参照ください。 |
|
PATCH | /API/v2/Reports/BillOfLadingNumberNotices/Update/{reportId} |
B/L番号通知書を更新します。 帳票ID(***reportId***)を指定して、B/L番号通知書を更新します。 このメソッドでは、B/L番号通知書の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 B/L番号通知書に関する詳細については、[B/L番号通知書について]()を参照ください。 |
|
POST | /API/v2/Reports/BillOfLadingNumberNotices/UploadFile |
B/L番号通知書にファイルを添付します。 指定されたB/L番号通知書に、ファイルを添付します。 帳票にファイルを添付できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
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でのレスポンスデータを編集し、指定するようにしてください。 |
BillOfLadings
船荷証券(B/L)
API | Description | ||
---|---|---|---|
POST | /API/v2/Reports/BillOfLadings/Create |
船荷証券(B/L)を作成します。 船荷証券(B/L)を作成するには、利用者が船荷証券(B/L)を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 船荷証券(B/L)に関する詳細については、[船荷証券(B/L)について]()を参照ください。 |
|
DELETE | /API/v2/Reports/BillOfLadings/Delete/{reportId} |
船荷証券(B/L) を削除します。 帳票ID(***reportId***)を指定して、船荷証券(B/L)を削除します。 船荷証券(B/L)を削除しても、ルートドキュメントの内容までは削除されません。 申請種別を使用して、作成した船荷証券(B/L)のキャンセルを伝える場合は、キャンセル(***Cancel***)を実施後、帳票の提出(***Submit***)を実施してください。 船荷証券(B/L)に関する詳細については、[船荷証券(B/L)について]()を参照ください。 |
|
DELETE | /API/v2/Reports/BillOfLadings/DeleteFile/{fileId} |
船荷証券(B/L) の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、船荷証券(B/L) の添付ファイルを削除します。 帳票の添付ファイルを削除できるのは、そのファイルを添付したパートナーに所属している利用者だけです。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
GET | /API/v2/Reports/BillOfLadings/Get/{reportId} |
船荷証券(B/L)を取得します。 帳票ID(***reportId***)を指定して、船荷証券(B/L)を取得します。 編集が行われていない場合は、ルートドキュメントから最新の船荷証券(B/L)を取得します。 編集中の場合は、先に保存した、船荷証券(B/L)を取得します。 船荷証券(B/L)に関する詳細については、[船荷証券(B/L)について]()を参照ください。 |
|
GET | /API/v2/Reports/BillOfLadings/GetFile/{fileId} |
船荷証券(B/L)に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、船荷証券(B/L)に添付されたファイルを取得します。 帳票の添付ファイルを獲得できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
GET | /API/v2/Reports/BillOfLadings/GetList?tradeNo=!{tradeNo}&uniqueNo=!{uniqueNo}&bookingNo=!{bookingNo}&blNo=!{blNo} |
船荷証券(B/L)を全て取得します。 検索条件に該当する船荷証券(B/L)を全て取得します。 編集が行われていない場合は、ルートドキュメントから最新の船荷証券(B/L)を取得します。 編集中の場合は、先に保存した、船荷証券(B/L)を取得します。 船荷証券(B/L)に関する詳細については、[船荷証券(B/L)について]()を参照ください。 |
|
PATCH | /API/v2/Reports/BillOfLadings/Lock/{reportId} |
編集するため、船荷証券(B/L)をロックします 帳票ID(***reportId***)を指定して、船荷証券(B/L)をロックします。 船荷証券(B/L)を作成(***Create***)した時点では、船荷証券(B/L)をロックが掛かりますが、取得(***Get***)したあとで、船荷証券(B/L)を編集する場合は、このメソッドを呼び出して、船荷証券(B/L)をロックします。 ロックされた船荷証券(B/L)は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、船荷証券(B/L)をルートドキュメントから参照できますが、編集中(ロック中)の船荷証券(B/L)は参照できません。 このロックは、アンロック(***Unlock***)を呼び出すか、帳票の保存後、帳票の提出(***Submit****)を行うと解除されます。 船荷証券(B/L)に関する詳細については、[船荷証券(B/L)について]()を参照ください。 |
|
PATCH | /API/v2/Reports/BillOfLadings/SetCancel/{reportId} |
船荷証券(B/L)の申請種別をキャンセルします 帳票ID(***reportId***)を指定して、船荷証券(B/L)の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 船荷証券(B/L)に関する詳細については、[船荷証券(B/L)について]()を参照ください。 |
|
PATCH | /API/v2/Reports/BillOfLadings/Submit/{reportId} |
船荷証券(B/L)を提出します 帳票ID(***reportId***)を指定して、更新(***Update***)した船荷証券(B/L)を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、船荷証券(B/L)が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、船荷証券(B/L)もロックされた状態のままなので、ご注意ください。 船荷証券(B/L)に関する詳細については、[船荷証券(B/L)について]()を参照ください。 |
|
PATCH | /API/v2/Reports/BillOfLadings/Unlock/{reportId} |
船荷証券(B/L)のロックを解除します 帳票ID(***reportId***)を指定して、船荷証券(B/L)のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 船荷証券(B/L)に関する詳細については、[船荷証券(B/L)について]()を参照ください。 |
|
PATCH | /API/v2/Reports/BillOfLadings/Update/{reportId} |
船荷証券(B/L)を更新します。 帳票ID(***reportId***)を指定して、船荷証券(B/L)を更新します。 このメソッドでは、船荷証券(B/L)の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 船荷証券(B/L)に関する詳細については、[船荷証券(B/L)について]()を参照ください。 |
|
POST | /API/v2/Reports/BillOfLadings/UploadFile |
船荷証券(B/L)にファイルを添付します。 指定された船荷証券(B/L)に、ファイルを添付します。 帳票にファイルを添付できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
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でのレスポンスデータを編集し、指定するようにしてください。 |
BookingConfirmations
船腹予約確認書
API | Description | ||
---|---|---|---|
POST | /API/v2/Reports/BookingConfirmations/Create |
船腹予約確認書を作成します。 船腹予約確認書を作成するには、利用者が船腹予約確認書を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 船腹予約確認書に関する詳細については、[船腹予約確認書について]()を参照ください。 |
|
DELETE | /API/v2/Reports/BookingConfirmations/Delete/{reportId} |
船腹予約確認書を削除します。 帳票ID(***reportId***)を指定して、船腹予約確認書を削除します。 船腹予約確認書を削除しても、ルートドキュメントの内容までは削除されません。 申請種別を使用して、作成した船腹予約確認書のキャンセルを伝える場合は、キャンセル(***Cancel***)を実施後、帳票の提出(***Submit***)を実施してください。 船腹予約確認書に関する詳細については、[船腹予約確認書について]()を参照ください。 |
|
DELETE | /API/v2/Reports/BookingConfirmations/DeleteFile/{fileId} |
船腹予約確認書の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、船腹予約確認書の添付ファイルを削除します。 帳票の添付ファイルを削除できるのは、そのファイルを添付したパートナーに所属している利用者だけです。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
GET | /API/v2/Reports/BookingConfirmations/Get/{reportId} |
船腹予約確認書を取得します。 帳票ID(***reportId***)を指定して、船腹予約確認書を取得します。 編集が行われていない場合は、ルートドキュメントから最新の船腹予約確認書を取得します。 編集中の場合は、先に保存した、船腹予約確認書を取得します。 船腹予約確認書に関する詳細については、[船腹予約確認書について]()を参照ください。 |
|
GET | /API/v2/Reports/BookingConfirmations/GetFile/{fileId} |
船腹予約確認書に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、船腹予約確認書に添付されたファイルを取得します。 帳票の添付ファイルを獲得できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
GET | /API/v2/Reports/BookingConfirmations/GetList?tradeNo=!{tradeNo}&uniqueNo=!{uniqueNo}&bookingNo=!{bookingNo}&blNo=!{blNo} |
船腹予約確認書を全て取得します。 検索条件に該当する船腹予約確認書を全て取得します。 編集が行われていない場合は、ルートドキュメントから最新の船腹予約確認書を取得します。 編集中の場合は、先に保存した、船腹予約確認書を取得します。 船腹予約確認書に関する詳細については、[船腹予約確認書について]()を参照ください。 |
|
PATCH | /API/v2/Reports/BookingConfirmations/Lock/{reportId} |
編集するため、船腹予約確認書をロックします 帳票ID(***reportId***)を指定して、船腹予約確認書をロックします。 船腹予約確認書を作成(***Create***)した時点では、船腹予約確認書をロックが掛かりますが、取得(***Get***)したあとで、船腹予約確認書を編集する場合は、このメソッドを呼び出して、船腹予約確認書をロックします。 ロックされた船腹予約確認書は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、船腹予約確認書をルートドキュメントから参照できますが、編集中(ロック中)の船腹予約確認書は参照できません。 このロックは、アンロック(***Unlock***)を呼び出すか、帳票の保存後、帳票の提出(***Submit****)を行うと解除されます。 船腹予約確認書に関する詳細については、[船腹予約確認書について]()を参照ください。 |
|
PATCH | /API/v2/Reports/BookingConfirmations/SetCancel/{reportId} |
船腹予約確認書の申請種別をキャンセルします 帳票ID(***reportId***)を指定して、船腹予約確認書の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 船腹予約確認書に関する詳細については、[船腹予約確認書について]()を参照ください。 |
|
PATCH | /API/v2/Reports/BookingConfirmations/Submit/{reportId} |
船腹予約確認書を提出します 帳票ID(***reportId***)を指定して、更新(***Update***)した船腹予約確認書を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、船腹予約確認書が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、船腹予約確認書もロックされた状態のままなので、ご注意ください。 船腹予約確認書に関する詳細については、[船腹予約確認書について]()を参照ください。 |
|
PATCH | /API/v2/Reports/BookingConfirmations/Unlock/{reportId} |
船腹予約確認書のロックを解除します 帳票ID(***reportId***)を指定して、船腹予約確認書のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 船腹予約確認書に関する詳細については、[船腹予約確認書について]()を参照ください。 |
|
PATCH | /API/v2/Reports/BookingConfirmations/Update/{reportId} |
船腹予約確認書を更新します。 帳票ID(***reportId***)を指定して、船腹予約確認書を更新します。 このメソッドでは、船腹予約確認書の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 船腹予約確認書に関する詳細については、[船腹予約確認書について]()を参照ください。 |
|
POST | /API/v2/Reports/BookingConfirmations/UploadFile |
船腹予約確認書にファイルを添付します。 指定された船腹予約確認書に、ファイルを添付します。 帳票にファイルを添付できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
BookingContainerNoChangeCalls
BCC11
API | Description | ||
---|---|---|---|
POST | /API/v1/NaccsReport/BookingContainerNoChangeCalls/Create |
帳票:BCC11を作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 帳票:BCC11が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/NaccsReport/BookingContainerNoChangeCalls/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:BCC11を削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
GET | /API/v1/NaccsReport/BookingContainerNoChangeCalls/Get/{dealReportId} |
帳票:BCC11を取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/NaccsReport/BookingContainerNoChangeCalls/GetAttachFileMetaList/{dealReportId} |
添付ファイル情報一覧を取得します。 |
|
POST | /API/v1/NaccsReport/BookingContainerNoChangeCalls/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/BookingContainerNoChangeCalls/Register |
帳票:BCC11を保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
BookingContainerNoChanges
BCC
API | Description | ||
---|---|---|---|
POST | /API/v1/NaccsReport/BookingContainerNoChanges/Create |
帳票:BCCを作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 |
|
DELETE | /API/v1/NaccsReport/BookingContainerNoChanges/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:BCCを削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
GET | /API/v1/NaccsReport/BookingContainerNoChanges/Get/{dealReportId} |
帳票:BCCを取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/NaccsReport/BookingContainerNoChanges/GetAttachFileMetaList/{dealReportId} |
添付ファイル情報一覧を取得します。 |
|
POST | /API/v1/NaccsReport/BookingContainerNoChanges/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/BookingContainerNoChanges/Register |
帳票:BCCを保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対して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***) |
BookingRequests
ブッキング依頼書
API | Description | ||
---|---|---|---|
POST | /API/v2/Reports/BookingRequests/Create |
ブッキング依頼書を作成します。 ブッキング依頼書を作成するには、利用者がブッキング依頼書を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 ブッキング依頼書に関する詳細については、[ブッキング依頼書について]()を参照ください。 |
|
DELETE | /API/v2/Reports/BookingRequests/Delete/{reportId} |
ブッキング依頼書を削除します。 帳票ID(***reportId***)を指定して、ブッキング依頼書を削除します。 ブッキング依頼書を削除しても、ルートドキュメントの内容までは削除されません。 申請種別を使用して、作成したブッキング依頼書のキャンセルを伝える場合は、キャンセル(***Cancel***)を実施後、帳票の提出(***Submit***)を実施してください。 ブッキング依頼書に関する詳細については、[ブッキング依頼書について]()を参照ください。 |
|
DELETE | /API/v2/Reports/BookingRequests/DeleteFile/{fileId} |
ブッキング依頼書の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、ブッキング依頼書の添付ファイルを削除します。 帳票の添付ファイルを削除できるのは、そのファイルを添付したパートナーに所属している利用者だけです。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
GET | /API/v2/Reports/BookingRequests/Get/{reportId} |
ブッキング依頼書を取得します。 帳票ID(***reportId***)を指定して、ブッキング依頼書を取得します。 編集が行われていない場合は、ルートドキュメントから最新のブッキング依頼書を取得します。 編集中の場合は、先に保存した、ブッキング依頼書を取得します。 ブッキング依頼書に関する詳細については、[ブッキング依頼書について]()を参照ください。 |
|
GET | /API/v2/Reports/BookingRequests/GetFile/{fileId} |
ブッキング依頼書に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、ブッキング依頼書に添付されたファイルを取得します。 帳票の添付ファイルを獲得できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
GET | /API/v2/Reports/BookingRequests/GetList?tradeNo=!{tradeNo}&uniqueNo=!{uniqueNo}&bookingNo=!{bookingNo}&blNo=!{blNo} |
ブッキング依頼書を全て取得します。 検索条件に該当するブッキング依頼書を全て取得します。 編集が行われていない場合は、ルートドキュメントから最新のブッキング依頼書を取得します。 編集中の場合は、先に保存した、ブッキング依頼書を取得します。 ブッキング依頼書に関する詳細については、[ブッキング依頼書について]()を参照ください。 |
|
PATCH | /API/v2/Reports/BookingRequests/Lock/{reportId} |
編集するため、ブッキング依頼書をロックします 帳票ID(***reportId***)を指定して、ブッキング依頼書をロックします。 ブッキング依頼書を作成(***Create***)した時点では、ブッキング依頼書をロックが掛かりますが、取得(***Get***)したあとで、ブッキング依頼書を編集する場合は、このメソッドを呼び出して、ブッキング依頼書をロックします。 ロックされたブッキング依頼書は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、ブッキング依頼書をルートドキュメントから参照できますが、編集中(ロック中)のブッキング依頼書は参照できません。 このロックは、アンロック(***Unlock***)を呼び出すか、帳票の保存後、帳票の提出(***Submit****)を行うと解除されます。 ブッキング依頼書に関する詳細については、[ブッキング依頼書について]()を参照ください。 |
|
PATCH | /API/v2/Reports/BookingRequests/SetCancel/{reportId} |
ブッキング依頼書の申請種別をキャンセルします 帳票ID(***reportId***)を指定して、ブッキング依頼書の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 ブッキング依頼書に関する詳細については、[ブッキング依頼書について]()を参照ください。 |
|
PATCH | /API/v2/Reports/BookingRequests/Submit/{reportId} |
ブッキング依頼書を提出します 帳票ID(***reportId***)を指定して、更新(***Update***)したブッキング依頼書を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、ブッキング依頼書が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ブッキング依頼書もロックされた状態のままなので、ご注意ください。 ブッキング依頼書に関する詳細については、[ブッキング依頼書について]()を参照ください。 |
|
PATCH | /API/v2/Reports/BookingRequests/Unlock/{reportId} |
ブッキング依頼書のロックを解除します 帳票ID(***reportId***)を指定して、ブッキング依頼書のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 ブッキング依頼書に関する詳細については、[ブッキング依頼書について]()を参照ください。 |
|
PATCH | /API/v2/Reports/BookingRequests/Update/{reportId} |
ブッキング依頼書を更新します。 帳票ID(***reportId***)を指定して、ブッキング依頼書を更新します。 このメソッドでは、ブッキング依頼書の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 ブッキング依頼書に関する詳細については、[ブッキング依頼書について]()を参照ください。 |
|
POST | /API/v2/Reports/BookingRequests/UploadFile |
ブッキング依頼書にファイルを添付します。 指定されたブッキング依頼書に、ファイルを添付します。 帳票にファイルを添付できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
BpApplicationReasonCodes
BP申請事由コード
API | Description | ||
---|---|---|---|
DELETE | /API/v2/General/BpApplicationReasonCodes/DeleteAdmin/{bpApplicationReasonCode} |
BP申請事由コードを削除します。 BP申請事由コード(***bpApplicationReasonCode***)を指定して、BP申請事由コードを削除します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
GET | /API/v2/General/BpApplicationReasonCodes/Get/{bpApplicationReasonCode} |
BP申請事由を取得します。 BP申請事由コード(***bpApplicationReasonCode***)を指定して、BP申請事由を取得します。 BP申請事由コードに関する詳細については、[BP申請事由コードについて]()を参照ください。 |
|
GET | /API/v2/General/BpApplicationReasonCodes/GetList |
BP申請事由を全て取得します。 BP申請事由コードに関する詳細については、[BP申請事由コードについて]()を参照ください。 |
|
POST | /API/v2/General/BpApplicationReasonCodes/RegisterAdmin |
BP申請事由を登録します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
POST | /API/v2/General/BpApplicationReasonCodes/RegisterInternal |
BP申請事由を登録します。 内部呼び出し用。 (*For admin) |
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***)を指定します。 |
BusinessTypes
事業種別
API | Description | ||
---|---|---|---|
DELETE | /API/v2/Master/BusinessTypes/DeleteAdmin/{businessTypeCode} |
事業種別を削除します。 事業種別ID(***businessTypeId***)を指定して、事業種別を削除します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
GET | /API/v2/Master/BusinessTypes/Get/{businessTypeCode} |
事業種別を取得します。 事業種別コード(***businessTypeCode***)を指定して、事業種別を取得します。 |
|
GET | /API/v2/Master/BusinessTypes/GetList |
事業種別を全て取得します。 サイバーポートで定義している事業種別を全て取得します。 |
|
POST | /API/v2/Master/BusinessTypes/RegisterAdmin |
事業種別を登録します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
POST | /API/v2/Master/BusinessTypes/RegisterInternal |
事業種別を登録します。 内部呼び出し用。 (*For admin) |
Callsigns
コールサイン
API | Description | ||
---|---|---|---|
GET | /API/v2/General/Callsigns/Get/{callSignCode} |
コールサインを取得します。 コールサインコード(***callSignCode***)を指定して、コールサインを取得します。 NACCSから連携されるマスターデータに関する詳細については、[NACCSから連携されるマスターデータについて]()を参照ください。 |
|
GET | /API/v2/General/Callsigns/GetList?callSignCode=!{callSignCode}&callSignName=!{callSignName}&vesselOperatorCode=!{vesselOperatorCode}&lastUpdatedBy=!{lastUpdatedBy} |
コールサインを取得します。 検索条件に該当するコールサインを全て取得します。 NACCSから連携されるマスターデータに関する詳細については、[NACCSから連携されるマスターデータについて]()を参照ください。 |
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でのレスポンスデータを編集し、指定するようにしてください。 |
CargoClearanceAndDeliveryInstructions
輸入貨物荷捌依頼書
API | Description | ||
---|---|---|---|
POST | /API/v2/Reports/CargoClearanceAndDeliveryInstructions/Create |
輸入貨物荷捌依頼書を作成します。 輸入貨物荷捌依頼書を作成するには、利用者が輸入貨物荷捌依頼書を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 輸入貨物荷捌依頼書に関する詳細については、[輸入貨物荷捌依頼書について]()を参照ください。 |
|
DELETE | /API/v2/Reports/CargoClearanceAndDeliveryInstructions/Delete/{reportId} |
輸入貨物荷捌依頼書を削除します。 帳票ID(***reportId***)を指定して、輸入貨物荷捌依頼書を削除します。 輸入貨物荷捌依頼書を削除しても、ルートドキュメントの内容までは削除されません。 申請種別を使用して、作成した輸入貨物荷捌依頼書のキャンセルを伝える場合は、キャンセル(***Cancel***)を実施後、帳票の提出(***Submit***)を実施してください。 輸入貨物荷捌依頼書に関する詳細については、[輸入貨物荷捌依頼書について]()を参照ください。 |
|
DELETE | /API/v2/Reports/CargoClearanceAndDeliveryInstructions/DeleteFile/{fileId} |
輸入貨物荷捌依頼書の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、輸入貨物荷捌依頼書の添付ファイルを削除します。 帳票の添付ファイルを削除できるのは、そのファイルを添付したパートナーに所属している利用者だけです。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
GET | /API/v2/Reports/CargoClearanceAndDeliveryInstructions/Get/{reportId} |
輸入貨物荷捌依頼書を取得します。 帳票ID(***reportId***)を指定して、輸入貨物荷捌依頼書を取得します。 編集が行われていない場合は、ルートドキュメントから最新の輸入貨物荷捌依頼書を取得します。 編集中の場合は、先に保存した、輸入貨物荷捌依頼書を取得します。 輸入貨物荷捌依頼書に関する詳細については、[輸入貨物荷捌依頼書について]()を参照ください。 |
|
GET | /API/v2/Reports/CargoClearanceAndDeliveryInstructions/GetFile/{fileId} |
輸入貨物荷捌依頼書に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、輸入貨物荷捌依頼書に添付されたファイルを取得します。 帳票の添付ファイルを獲得できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
GET | /API/v2/Reports/CargoClearanceAndDeliveryInstructions/GetList?tradeNo=!{tradeNo}&uniqueNo=!{uniqueNo}&bookingNo=!{bookingNo}&blNo=!{blNo} |
輸入貨物荷捌依頼書を全て取得します。 検索条件に該当する輸入貨物荷捌依頼書を全て取得します。 編集が行われていない場合は、ルートドキュメントから最新の輸入貨物荷捌依頼書を取得します。 編集中の場合は、先に保存した、輸入貨物荷捌依頼書を取得します。 輸入貨物荷捌依頼書に関する詳細については、[輸入貨物荷捌依頼書について]()を参照ください。 |
|
PATCH | /API/v2/Reports/CargoClearanceAndDeliveryInstructions/Lock/{reportId} |
編集するため、輸入貨物荷捌依頼書をロックします 帳票ID(***reportId***)を指定して、輸入貨物荷捌依頼書をロックします。 輸入貨物荷捌依頼書を作成(***Create***)した時点では、輸入貨物荷捌依頼書をロックが掛かりますが、取得(***Get***)したあとで、輸入貨物荷捌依頼書を編集する場合は、このメソッドを呼び出して、輸入貨物荷捌依頼書をロックします。 ロックされた輸入貨物荷捌依頼書は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、輸入貨物荷捌依頼書をルートドキュメントから参照できますが、編集中(ロック中)の輸入貨物荷捌依頼書は参照できません。 このロックは、アンロック(***Unlock***)を呼び出すか、帳票の保存後、帳票の提出(***Submit****)を行うと解除されます。 輸入貨物荷捌依頼書に関する詳細については、[輸入貨物荷捌依頼書について]()を参照ください。 |
|
PATCH | /API/v2/Reports/CargoClearanceAndDeliveryInstructions/SetCancel/{reportId} |
輸入貨物荷捌依頼書の申請種別をキャンセルします 帳票ID(***reportId***)を指定して、輸入貨物荷捌依頼書の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 輸入貨物荷捌依頼書に関する詳細については、[輸入貨物荷捌依頼書について]()を参照ください。 |
|
PATCH | /API/v2/Reports/CargoClearanceAndDeliveryInstructions/Submit/{reportId} |
輸入貨物荷捌依頼書を提出します 帳票ID(***reportId***)を指定して、更新(***Update***)した輸入貨物荷捌依頼書を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、輸入貨物荷捌依頼書が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、輸入貨物荷捌依頼書もロックされた状態のままなので、ご注意ください。 輸入貨物荷捌依頼書に関する詳細については、[輸入貨物荷捌依頼書について]()を参照ください。 |
|
PATCH | /API/v2/Reports/CargoClearanceAndDeliveryInstructions/Unlock/{reportId} |
輸入貨物荷捌依頼書のロックを解除します 帳票ID(***reportId***)を指定して、輸入貨物荷捌依頼書のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 輸入貨物荷捌依頼書に関する詳細については、[輸入貨物荷捌依頼書について]()を参照ください。 |
|
PATCH | /API/v2/Reports/CargoClearanceAndDeliveryInstructions/Update/{reportId} |
輸入貨物荷捌依頼書を更新します。 帳票ID(***reportId***)を指定して、輸入貨物荷捌依頼書を更新します。 このメソッドでは、輸入貨物荷捌依頼書の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 輸入貨物荷捌依頼書に関する詳細については、[輸入貨物荷捌依頼書について]()を参照ください。 |
|
POST | /API/v2/Reports/CargoClearanceAndDeliveryInstructions/UploadFile |
輸入貨物荷捌依頼書にファイルを添付します。 指定された輸入貨物荷捌依頼書に、ファイルを添付します。 帳票にファイルを添付できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
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でのレスポンスデータを編集し、指定するようにしてください。 |
Categories
帳票カテゴリ
API | Description | ||
---|---|---|---|
DELETE | /API/v2/Master/Reports/Categories/DeleteAdmin/{reportCategoryCode} |
帳票のカテゴリを削除します。 帳票カテゴリコード(***reportCategoryCode***)を指定して、帳票のカテゴリを削除します。 このAPIはシステム管理者しか呼び出せません。 (*For admin) |
|
GET | /API/v2/Master/Reports/Categories/Get/{reportCategoryCode} |
帳票のカテゴリを取得します。 帳票カテゴリコード(***reportCategoryCode***)を指定して、帳票のカテゴリを取得します。 帳票カテゴリに関する詳細については、[帳票カテゴリについて]()を参照ください。 |
|
GET | /API/v2/Master/Reports/Categories/GetList |
帳票のカテゴリを全て取得します。 帳票のカテゴリを全て取得します。 帳票カテゴリに関する詳細については、[帳票カテゴリについて]()を参照ください。 |
|
POST | /API/v2/Master/Reports/Categories/RegisterAdmin |
帳票のカテゴリを登録します。 このAPIはシステム管理者しか呼び出せません。 (*For admin) |
|
POST | /API/v2/Master/Reports/Categories/RegisterInternal |
帳票のカテゴリを登録します。 内部呼び出し用。 (*For admin) |
CertificateOfOriginIdentificationCodes
原産地証明書識別コード
API | Description | ||
---|---|---|---|
DELETE | /API/v2/General/CertificateOfOriginIdentificationCodes/DeleteAdmin/{certificateOfOriginIdentificationCode} |
原産地証明書識別コードを削除します。 原産地証明書識別コード(***certificateOfOriginIdentificationCode***)を指定して、原産地証明書識別コードを削除します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
GET | /API/v2/General/CertificateOfOriginIdentificationCodes/Get/{certificateOfOriginIdentificationCode} |
原産地証明書識別を取得します。 原産地証明書識別コード(***certificateOfOriginIdentificationCode***)を指定して、原産地証明書識別を取得します。 原産地証明書識別コードに関する詳細については、[原産地証明書識別コードについて]()を参照ください。 |
|
GET | /API/v2/General/CertificateOfOriginIdentificationCodes/GetList |
原産地証明書識別を全て取得します。 原産地証明書識別コードに関する詳細については、[原産地証明書識別コードについて]()を参照ください。 |
|
POST | /API/v2/General/CertificateOfOriginIdentificationCodes/RegisterAdmin |
原産地証明書識別を登録します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
POST | /API/v2/General/CertificateOfOriginIdentificationCodes/RegisterInternal |
原産地証明書識別を登録します。 内部呼び出し用。 (*For admin) |
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でのレスポンスデータを編集し、指定するようにしてください。 |
CfsDispatchOrders
CFS搬出票
API | Description | ||
---|---|---|---|
POST | /API/v2/Reports/CfsDispatchOrders/Create |
CFS搬出票を作成します。 CFS搬出票を作成するには、利用者がCFS搬出票を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 CFS搬出票に関する詳細については、[CFS搬出票について]()を参照ください。 |
|
DELETE | /API/v2/Reports/CfsDispatchOrders/Delete/{reportId} |
CFS搬出票を削除します。 帳票ID(***reportId***)を指定して、CFS搬出票を削除します。 CFS搬出票を削除しても、ルートドキュメントの内容までは削除されません。 申請種別を使用して、作成したCFS搬出票のキャンセルを伝える場合は、キャンセル(***Cancel***)を実施後、帳票の提出(***Submit***)を実施してください。 CFS搬出票に関する詳細については、[CFS搬出票について]()を参照ください。 |
|
DELETE | /API/v2/Reports/CfsDispatchOrders/DeleteFile/{fileId} |
CFS搬出票の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、CFS搬出票の添付ファイルを削除します。 帳票の添付ファイルを削除できるのは、そのファイルを添付したパートナーに所属している利用者だけです。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
GET | /API/v2/Reports/CfsDispatchOrders/Get/{reportId} |
CFS搬出票を取得します。 帳票ID(***reportId***)を指定して、CFS搬出票を取得します。 編集が行われていない場合は、ルートドキュメントから最新のCFS搬出票を取得します。 編集中の場合は、先に保存した、CFS搬出票を取得します。 CFS搬出票に関する詳細については、[CFS搬出票について]()を参照ください。 |
|
GET | /API/v2/Reports/CfsDispatchOrders/GetFile/{fileId} |
CFS搬出票に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、CFS搬出票に添付されたファイルを取得します。 帳票の添付ファイルを獲得できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
GET | /API/v2/Reports/CfsDispatchOrders/GetList?tradeNo=!{tradeNo}&uniqueNo=!{uniqueNo}&bookingNo=!{bookingNo}&blNo=!{blNo} |
CFS搬出票を全て取得します。 検索条件に該当するCFS搬出票を全て取得します。 編集が行われていない場合は、ルートドキュメントから最新のCFS搬出票を取得します。 編集中の場合は、先に保存した、CFS搬出票を取得します。 CFS搬出票に関する詳細については、[CFS搬出票について]()を参照ください。 |
|
PATCH | /API/v2/Reports/CfsDispatchOrders/Lock/{reportId} |
編集するため、CFS搬出票をロックします 帳票ID(***reportId***)を指定して、CFS搬出票をロックします。 CFS搬出票を作成(***Create***)した時点では、CFS搬出票をロックが掛かりますが、取得(***Get***)したあとで、CFS搬出票を編集する場合は、このメソッドを呼び出して、CFS搬出票をロックします。 ロックされたCFS搬出票は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、CFS搬出票をルートドキュメントから参照できますが、編集中(ロック中)のCFS搬出票は参照できません。 このロックは、アンロック(***Unlock***)を呼び出すか、帳票の保存後、帳票の提出(***Submit****)を行うと解除されます。 CFS搬出票に関する詳細については、[CFS搬出票について]()を参照ください。 |
|
PATCH | /API/v2/Reports/CfsDispatchOrders/SetCancel/{reportId} |
CFS搬出票の申請種別をキャンセルします 帳票ID(***reportId***)を指定して、CFS搬出票の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 CFS搬出票に関する詳細については、[CFS搬出票について]()を参照ください。 |
|
PATCH | /API/v2/Reports/CfsDispatchOrders/Submit/{reportId} |
CFS搬出票を提出します 帳票ID(***reportId***)を指定して、更新(***Update***)したCFS搬出票を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、CFS搬出票が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、コンテナ貨物搬入票もロックされた状態のままなので、ご注意ください。 CFS搬出票に関する詳細については、[CFS搬出票について]()を参照ください。 |
|
PATCH | /API/v2/Reports/CfsDispatchOrders/Unlock/{reportId} |
CFS搬出票のロックを解除します 帳票ID(***reportId***)を指定して、CFS搬出票のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 CFS搬出票に関する詳細については、[CFS搬出票について]()を参照ください。 |
|
PATCH | /API/v2/Reports/CfsDispatchOrders/Update/{reportId} |
CFS搬出票を更新します。 帳票ID(***reportId***)を指定して、CFS搬出票を更新します。 このメソッドでは、CFS搬出票の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 CFS搬出票に関する詳細については、[CFS搬出票について]()を参照ください。 |
|
POST | /API/v2/Reports/CfsDispatchOrders/UploadFile |
CFS搬出票にファイルを添付します。 指定されたCFS搬出票に、ファイルを添付します。 帳票にファイルを添付できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
ChangeHistories
マスタ更新履歴
API | Description | ||
---|---|---|---|
GET | /API/v1/Master/ChangeHistories/GetListByDatetime?startDatetime={startDatetime} |
指定したstartDatetime以降のマスタ変更履歴リストを取得します。 ## 概要 マスタデータの更新リストを取得します。取得対象は指定した日時(***startDatetime***) 以降のデータとなります。 ## 指定するパラメタについて ### 日時 日時(***startDatetime***)は、マスタ更新履歴作成時の日時が設定されています |
|
GET | /API/v1/Master/ChangeHistories/GetListBySeqNo/{startSeqNo} |
指定したseqNo以降のマスタ変更履歴リストを取得します。 ## 概要 マスタデータの更新リストを取得します。取得対象は指定したシーケンス番号(***seqNo***) 以降のデータとなります。 ## 指定するパラメタについて ### シーケンス番号 シーケンス番号(***seqNo***)は、マスタ更新履歴作成時に昇順で連番が振られます |
CheckStatuses
操作履歴の確認状況
API | Description | ||
---|---|---|---|
GET | /API/v2/Trades/Histories/CheckStatuses/GetUnreadCount?tradeNo=!{tradeNo}&reportId=!{reportId} |
未確認の操作履歴の件数を取得します。 取引内の操作について、未確認の操作履歴の件数を取得します。 取引内での操作履歴に関する詳細については、[取引内での操作履歴について]()を参照ください。 |
|
PATCH | /API/v2/Trades/Histories/CheckStatuses/MarkAllAsChecked |
全ての確認状況を確認済みにします。 全ての確認状況を確認済みにします。 ※どのように実装するか要検討。 |
|
PATCH | /API/v2/Trades/Histories/CheckStatuses/MarkAsChecked/{checkStatusId} |
取引内の操作についての確認状況を確認済みにします。 確認状況ID(***checkStatusId***)を指定して、確認状況を確認済みにします。 取引内での操作履歴に関する詳細については、[取引内での操作履歴について]()を参照ください。 |
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でのレスポンスデータを編集し、指定するようにしてください。 |
Columns
帳票の項目
API | Description | ||
---|---|---|---|
DELETE | /API/v2/Master/ReportTypes/Columns/DeleteAdmin/{reportColumnCode} |
帳票の項目を削除します。 帳票の項目コード(***reportColumnCode***)を指定して、帳票の種類を削除します。 このAPIはシステム管理者しか呼び出せません。 (*For admin) |
|
GET | /API/v2/Master/ReportTypes/Columns/Get/{reportCode} |
帳票コードを指定して、帳票の項目を全て取得します。 帳票コード(***reportCode***)を指定して、帳票の項目を全て取得します。 帳票の項目とルートドキュメントに関する詳細については、[帳票の項目とルートドキュメントについて]()を参照ください。 |
|
GET | /API/v2/Master/ReportTypes/Columns/GetList/{reportCode} |
帳票コードを指定して、帳票の項目を全て取得します。 帳票コード(***reportCode***)を指定して、帳票の項目を全て取得します。 帳票の項目とルートドキュメントに関する詳細については、[帳票の項目とルートドキュメントについて]()を参照ください。 |
|
POST | /API/v2/Master/ReportTypes/Columns/RegisterAdmin |
帳票の種類と項目を登録します。 このAPIはシステム管理者しか呼び出せません。 (*For admin) |
|
POST | /API/v2/Master/ReportTypes/Columns/RegisterInternal |
帳票の種類と項目を登録します。 内部呼び出し用。 (*For admin) |
ColumnTemplates
項目テンプレート
API | Description | ||
---|---|---|---|
DELETE | /API/v2/Organizations/ColumnTemplates/Delete/{columnTemplateId} |
項目テンプレートを削除します。 項目テンプレートID(***columnTemplateId***)を指定して、項目テンプレートを削除します。 項目テンプレートに関する詳細については、[項目テンプレートについて]()を参照ください。 |
|
GET | /API/v2/Organizations/ColumnTemplates/Get/{columnTemplateId} |
項目テンプレートを取得します。 項目テンプレートID(***columnTemplateId***)を指定して、項目テンプレートを取得します。 項目テンプレートに関する詳細については、[項目テンプレートについて]()を参照ください。 |
|
GET | /API/v2/Organizations/ColumnTemplates/GetList?columnTemplateId=!{columnTemplateId}&columnTemplateName=!{columnTemplateName}&organizationId=!{organizationId}&columnCode=!{columnCode} |
検索条件に該当する項目テンプレートを全て取得します。 検索条件を指定して、ログインしている利用者が所属する組織が所有する項目テンプレートを全て取得します。 項目テンプレートに関する詳細については、[項目テンプレートについて]()を参照ください。 |
|
POST | /API/v2/Organizations/ColumnTemplates/Register |
項目テンプレートを登録します。 組織で使用する帳票の項目テンプレートを登録します。 項目テンプレートは、帳票を編集する際に入力した情報を保存し、次回、同じ項目を入力する際のテンプレートとして機能します。 登録した項目テンプレートは、利用者が所属する指定された組織内で共有されます。 項目テンプレートに関する詳細については、[項目テンプレートについて]()を参照ください。 |
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でのレスポンスデータを編集し、指定するようにしてください。 |
CommercialInvoices
商業送り状(I/V)
API | Description | ||
---|---|---|---|
POST | /API/v2/Reports/CommercialInvoices/Create |
商業送り状(I/V)を作成します。 商業送り状(I/V)を作成するには、利用者が商業送り状(I/V)を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 商業送り状(I/V)に関する詳細については、[商業送り状(I/V)について]()を参照ください。 |
|
DELETE | /API/v2/Reports/CommercialInvoices/Delete/{reportId} |
商業送り状(I/V)を削除します。 帳票ID(***reportId***)を指定して、商業送り状(I/V)を削除します。 商業送り状(I/V)を削除しても、ルートドキュメントの内容までは削除されません。 申請種別を使用して、作成した商業送り状(I/V)のキャンセルを伝える場合は、キャンセル(***Cancel***)を実施後、帳票の提出(***Submit***)を実施してください。 商業送り状(I/V)に関する詳細については、[商業送り状(I/V)について]()を参照ください。 |
|
DELETE | /API/v2/Reports/CommercialInvoices/DeleteFile/{fileId} |
商業送り状(I/V)の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、商業送り状(I/V)の添付ファイルを削除します。 帳票の添付ファイルを削除できるのは、そのファイルを添付したパートナーに所属している利用者だけです。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
GET | /API/v2/Reports/CommercialInvoices/Get/{reportId} |
商業送り状(I/V)を取得します。 帳票ID(***reportId***)を指定して、商業送り状(I/V)を取得します。 編集が行われていない場合は、ルートドキュメントから最新のブッキング依頼書を取得します。 編集中の場合は、先に保存した、商業送り状(I/V)を取得します。 商業送り状(I/V)に関する詳細については、[商業送り状(I/V)について]()を参照ください。 |
|
GET | /API/v2/Reports/CommercialInvoices/GetFile/{fileId} |
商業送り状(I/V)に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、商業送り状(I/V)に添付されたファイルを取得します。 帳票の添付ファイルを獲得できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
GET | /API/v2/Reports/CommercialInvoices/GetList?tradeNo=!{tradeNo}&uniqueNo=!{uniqueNo}&bookingNo=!{bookingNo}&blNo=!{blNo} |
商業送り状(I/V)を全て取得します。 検索条件に該当する商業送り状(I/V)を全て取得します。 編集が行われていない場合は、ルートドキュメントから最新の商業送り状(I/V)を取得します。 編集中の場合は、先に保存した、商業送り状(I/V)を取得します。 商業送り状(I/V)に関する詳細については、[商業送り状(I/V)について]()を参照ください。 |
|
PATCH | /API/v2/Reports/CommercialInvoices/Lock/{reportId} |
編集するため、商業送り状(I/V)をロックします 帳票ID(***reportId***)を指定して、商業送り状(I/V)をロックします。 商業送り状(I/V)を作成(***Create***)した時点では、商業送り状(I/V)をロックが掛かりますが、取得(***Get***)したあとで、商業送り状(I/V)を編集する場合は、このメソッドを呼び出して、商業送り状(I/V)をロックします。 ロックされた商業送り状(I/V)は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、商業送り状(I/V)をルートドキュメントから参照できますが、編集中(ロック中)の商業送り状(I/V)は参照できません。 このロックは、アンロック(***Unlock***)を呼び出すか、帳票の保存後、帳票の提出(***Submit****)を行うと解除されます。 商業送り状(I/V)に関する詳細については、[商業送り状(I/V)について]()を参照ください。 |
|
PATCH | /API/v2/Reports/CommercialInvoices/SetCancel/{reportId} |
商業送り状(I/V)の申請種別をキャンセルします 帳票ID(***reportId***)を指定して、商業送り状(I/V)の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 商業送り状(I/V)に関する詳細については、[商業送り状(I/V)について]()を参照ください。 |
|
PATCH | /API/v2/Reports/CommercialInvoices/Submit/{reportId} |
商業送り状(I/V)を提出します 帳票ID(***reportId***)を指定して、更新(***Update***)した商業送り状(I/V)を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、商業送り状(I/V)が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、商業送り状(I/V)もロックされた状態のままなので、ご注意ください。 商業送り状(I/V)に関する詳細については、[商業送り状(I/V)について]()を参照ください。 |
|
PATCH | /API/v2/Reports/CommercialInvoices/Unlock/{reportId} |
商業送り状(I/V)のロックを解除します 帳票ID(***reportId***)を指定して、商業送り状(I/V)のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 商業送り状(I/V)に関する詳細については、[商業送り状(I/V)について]()を参照ください。 |
|
PATCH | /API/v2/Reports/CommercialInvoices/Update/{reportId} |
商業送り状(I/V)を更新します。 帳票ID(***reportId***)を指定して、商業送り状(I/V)を更新します。 このメソッドでは、商業送り状(I/V)の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 商業送り状(I/V)に関する詳細については、[商業送り状(I/V)について]()を参照ください。 |
|
POST | /API/v2/Reports/CommercialInvoices/UploadFile |
商業送り状(I/V)にファイルを添付します。 指定された商業送り状(I/V)に、ファイルを添付します。 帳票にファイルを添付できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
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) |
Companies
会社
API | Description | ||
---|---|---|---|
DELETE | /API/v2/Companies/DeleteLogoImage/{companyId} |
会社のロゴイメージを削除します。 ログインしている利用者が所属する会社のロゴイメージを削除します。 このメソッドは会社の管理者(***/API/v2/Companies/Administrators***)として登録された利用者が利用できます。 会社に関する詳細については、[会社について]()を参照ください。 |
|
GET | /API/v2/Companies/Get |
会社を取得します。 ログインしている利用者が所属する会社を取得します。 会社に関する詳細については、[会社について]()を参照ください。 |
|
GET | /API/v2/Companies/GetLogoImage/{corporateNo} |
会社のロゴイメージを取得します。 会社に登録されているロゴイメージを取得します。 ロゴイメージはBase64形式でエンコードされた形で返却します。 |
|
GET | /API/v2/Companies/Search?corporateNo=!{corporateNo}&companyName=!{companyName}&companyNameEn=!{companyNameEn}&businessTypeCodeList=!{businessTypeCodeList} |
検索条件に該当する会社を取得します。 ログインしている利用者が所属する会社以外の検索条件に該当する会社を全て取得します。 会社に関する詳細については、[会社について]()を参照ください。 |
|
PATCH | /API/v2/Companies/Update/{companyId} |
会社を更新します。 ログインしている利用者が所属する会社を更新します。 このメソッドは会社の管理者(***/API/v2/Companies/Administrators***)として登録された利用者が利用できます。 会社に関する詳細については、[会社について]()を参照ください。 |
|
PATCH | /API/v2/Companies/UploadLogoImage/{companyId} |
会社のロゴイメージを登録・更新します。 ログインしている利用者が所属する会社のロゴイメージを登録・更新します。 このメソッドは会社の管理者(***/API/v2/Companies/Administrators***)として登録された利用者が利用できます。 会社に関する詳細については、[会社について]()を参照ください。 |
CompanyProducts
会社商品マスタ
API | Description | ||
---|---|---|---|
DELETE | /API/v1/Master/CompanyProducts/Delete/{companyProductId} |
会社商品を削除します。 |
|
GET | /API/v1/Master/CompanyProducts/Get/{companyProductId} |
会社商品を取得します。 APIを呼び出すユーザが所属している会社の商品以外は取得できません。 |
|
GET | /API/v1/Master/CompanyProducts/GetList?filter={filter}&orderby={orderby} |
検索条件を指定して、条件に該当する会社商品情報を全て取得します。 APIを呼び出すユーザが所属している会社の商品以外は取得できません。 |
|
POST | /API/v1/Master/CompanyProducts/Register |
会社商品を登録します。 |
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でのレスポンスデータを編集し、指定するようにしてください。 |
ContainerDeliveryReceipts
コンテナ貨物搬出票
API | Description | ||
---|---|---|---|
POST | /API/v2/Reports/ContainerDeliveryReceipts/Create |
コンテナ貨物受領書を作成します。 コンテナ貨物受領書を作成するには、利用者がコンテナ貨物受領書を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 コンテナ貨物受領書に関する詳細については、[コンテナ貨物受領書について]()を参照ください。 |
|
DELETE | /API/v2/Reports/ContainerDeliveryReceipts/Delete/{reportId} |
コンテナ貨物受領書を削除します。 帳票ID(***reportId***)を指定して、コンテナ貨物受領書を削除します。 コンテナ貨物受領書を削除しても、ルートドキュメントの内容までは削除されません。 申請種別を使用して、作成したコンテナ貨物受領書のキャンセルを伝える場合は、キャンセル(***Cancel***)を実施後、帳票の提出(***Submit***)を実施してください。 コンテナ貨物受領書に関する詳細については、[コンテナ貨物受領書について]()を参照ください。 |
|
DELETE | /API/v2/Reports/ContainerDeliveryReceipts/DeleteFile/{fileId} |
コンテナ貨物受領書の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、コンテナ貨物受領書の添付ファイルを削除します。 帳票の添付ファイルを削除できるのは、そのファイルを添付したパートナーに所属している利用者だけです。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
GET | /API/v2/Reports/ContainerDeliveryReceipts/Get/{reportId} |
コンテナ貨物受領書を取得します。 帳票ID(***reportId***)を指定して、コンテナ貨物受領書を取得します。 編集が行われていない場合は、ルートドキュメントから最新のコンテナ貨物受領書を取得します。 編集中の場合は、先に保存した、コンテナ貨物受領書を取得します。 コンテナ貨物受領書に関する詳細については、[コンテナ貨物受領書について]()を参照ください。 |
|
GET | /API/v2/Reports/ContainerDeliveryReceipts/GetFile/{fileId} |
コンテナ貨物受領書に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、コンテナ貨物受領書に添付されたファイルを取得します。 帳票の添付ファイルを獲得できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
GET | /API/v2/Reports/ContainerDeliveryReceipts/GetList?tradeNo=!{tradeNo}&uniqueNo=!{uniqueNo}&bookingNo=!{bookingNo}&blNo=!{blNo} |
コンテナ貨物受領書を全て取得します。 検索条件に該当するコンテナ貨物受領書を全て取得します。 編集が行われていない場合は、ルートドキュメントから最新のコンテナ貨物受領書を取得します。 編集中の場合は、先に保存した、コンテナ貨物受領書を取得します。 コンテナ貨物受領書に関する詳細については、[コンテナ貨物受領書について]()を参照ください。 |
|
PATCH | /API/v2/Reports/ContainerDeliveryReceipts/Lock/{reportId} |
編集するため、コンテナ貨物受領書をロックします 帳票ID(***reportId***)を指定して、コンテナ貨物受領書をロックします。 コンテナ貨物受領書を作成(***Create***)した時点では、コンテナ貨物受領書をロックが掛かりますが、取得(***Get***)したあとで、コンテナ貨物受領書を編集する場合は、このメソッドを呼び出して、コンテナ貨物受領書をロックします。 ロックされたコンテナ貨物受領書は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、コンテナ貨物受領書をルートドキュメントから参照できますが、編集中(ロック中)のコンテナ貨物受領書は参照できません。 このロックは、アンロック(***Unlock***)を呼び出すか、帳票の保存後、帳票の提出(***Submit****)を行うと解除されます。 コンテナ貨物受領書に関する詳細については、[コンテナ貨物受領書について]()を参照ください。 |
|
PATCH | /API/v2/Reports/ContainerDeliveryReceipts/SetCancel/{reportId} |
コンテナ貨物受領書の申請種別をキャンセルします 帳票ID(***reportId***)を指定して、コンテナ貨物受領書の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 コンテナ貨物受領書に関する詳細については、[コンテナ貨物受領書について]()を参照ください。 |
|
PATCH | /API/v2/Reports/ContainerDeliveryReceipts/Submit/{reportId} |
コンテナ貨物受領書を提出します 帳票ID(***reportId***)を指定して、更新(***Update***)したコンテナ貨物受領書を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、コンテナ貨物受領書が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、コンテナ貨物受領書もロックされた状態のままなので、ご注意ください。 コンテナ貨物受領書に関する詳細については、[コンテナ貨物受領書について]()を参照ください。 |
|
PATCH | /API/v2/Reports/ContainerDeliveryReceipts/Unlock/{reportId} |
コンテナ貨物受領書のロックを解除します 帳票ID(***reportId***)を指定して、コンテナ貨物受領書のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 コンテナ貨物受領書に関する詳細については、[コンテナ貨物受領書について]()を参照ください。 |
|
PATCH | /API/v2/Reports/ContainerDeliveryReceipts/Update/{reportId} |
コンテナ貨物受領書を更新します。 帳票ID(***reportId***)を指定して、コンテナ貨物受領書を更新します。 このメソッドでは、コンテナ貨物受領書の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 コンテナ貨物受領書に関する詳細については、[コンテナ貨物受領書について]()を参照ください。 |
|
POST | /API/v2/Reports/ContainerDeliveryReceipts/UploadFile |
コンテナ貨物受領書にファイルを添付します。 指定されたコンテナ貨物受領書に、ファイルを添付します。 帳票にファイルを添付できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
ContainerGateInMatchings-Result
搬入情報マッチング結果
API | Description | ||
---|---|---|---|
POST | /API/v2/Reports/ContainerGateInMatchings-Result/Create |
搬入情報マッチング結果を作成します。 搬入情報マッチング結果を作成するには、利用者が搬入情報マッチング結果を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 搬入情報マッチング結果に関する詳細については、[搬入情報マッチング結果について]()を参照ください。 |
|
DELETE | /API/v2/Reports/ContainerGateInMatchings-Result/Delete/{reportId} |
搬入情報マッチング結果を削除します。 帳票ID(***reportId***)を指定して、搬入情報マッチング結果を削除します。 搬入情報マッチング結果を削除しても、ルートドキュメントの内容までは削除されません。 申請種別を使用して、作成したコンテナ貨物搬入票のキャンセルを伝える場合は、キャンセル(***Cancel***)を実施後、帳票の提出(***Submit***)を実施してください。 搬入情報マッチング結果に関する詳細については、[搬入情報マッチング結果について]()を参照ください。 |
|
DELETE | /API/v2/Reports/ContainerGateInMatchings-Result/DeleteFile/{fileId} |
搬入情報マッチング結果の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、搬入情報マッチング結果の添付ファイルを削除します。 帳票の添付ファイルを削除できるのは、そのファイルを添付したパートナーに所属している利用者だけです。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
GET | /API/v2/Reports/ContainerGateInMatchings-Result/Get/{reportId} |
搬入情報マッチング結果を取得します。 帳票ID(***reportId***)を指定して、搬入情報マッチング結果を取得します。 編集が行われていない場合は、ルートドキュメントから最新の搬入情報マッチング結果を取得します。 編集中の場合は、先に保存した、搬入情報マッチング結果を取得します。 搬入情報マッチング結果に関する詳細については、[搬入情報マッチング結果について]()を参照ください。 |
|
GET | /API/v2/Reports/ContainerGateInMatchings-Result/GetFile/{fileId} |
搬入情報マッチング結果に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、搬入情報マッチング結果に添付されたファイルを取得します。 帳票の添付ファイルを獲得できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
GET | /API/v2/Reports/ContainerGateInMatchings-Result/GetList?tradeNo=!{tradeNo}&uniqueNo=!{uniqueNo}&bookingNo=!{bookingNo}&blNo=!{blNo} |
搬入情報マッチング結果を全て取得します。 検索条件に該当する搬入情報マッチング結果を全て取得します。 編集が行われていない場合は、ルートドキュメントから最新の搬入情報マッチング結果を取得します。 編集中の場合は、先に保存した、搬入情報マッチング結果を取得します。 搬入情報マッチング結果に関する詳細については、[搬入情報マッチング結果について]()を参照ください。 |
|
PATCH | /API/v2/Reports/ContainerGateInMatchings-Result/Lock/{reportId} |
編集するため、搬入情報マッチング結果をロックします 帳票ID(***reportId***)を指定して、搬入情報マッチング結果をロックします。 搬入情報マッチング結果を作成(***Create***)した時点では、搬入情報マッチング結果をロックが掛かりますが、取得(***Get***)したあとで、搬入情報マッチング結果を編集する場合は、このメソッドを呼び出して、搬入情報マッチング結果をロックします。 ロックされた搬入情報マッチング結果は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、搬入情報マッチング結果をルートドキュメントから参照できますが、編集中(ロック中)の搬入情報マッチング結果は参照できません。 このロックは、アンロック(***Unlock***)を呼び出すか、帳票の保存後、帳票の提出(***Submit****)を行うと解除されます。 搬入情報マッチング結果に関する詳細については、[搬入情報マッチング結果について]()を参照ください。 |
|
PATCH | /API/v2/Reports/ContainerGateInMatchings-Result/SetCancel/{reportId} |
搬入情報マッチング結果の申請種別をキャンセルします 帳票ID(***reportId***)を指定して、搬入情報マッチング結果の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 搬入情報マッチング結果に関する詳細については、[搬入情報マッチング結果について]()を参照ください。 |
|
PATCH | /API/v2/Reports/ContainerGateInMatchings-Result/Submit/{reportId} |
搬入情報マッチング結果を提出します 帳票ID(***reportId***)を指定して、更新(***Update***)したコンテナ貨物搬出票を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、搬入情報マッチング結果が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、搬入情報マッチング結果もロックされた状態のままなので、ご注意ください。 搬入情報マッチング結果に関する詳細については、[搬入情報マッチング結果について]()を参照ください。 |
|
PATCH | /API/v2/Reports/ContainerGateInMatchings-Result/Unlock/{reportId} |
搬入情報マッチング結果のロックを解除します 帳票ID(***reportId***)を指定して、搬入情報マッチング結果のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 搬入情報マッチング結果に関する詳細については、[搬入情報マッチング結果について]()を参照ください。 |
|
PATCH | /API/v2/Reports/ContainerGateInMatchings-Result/Update/{reportId} |
搬入情報マッチング結果を更新します。 帳票ID(***reportId***)を指定して、搬入情報マッチング結果を更新します。 このメソッドでは、搬入情報マッチング結果の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 搬入情報マッチング結果に関する詳細については、[搬入情報マッチング結果について]()を参照ください。 |
|
POST | /API/v2/Reports/ContainerGateInMatchings-Result/UploadFile |
搬入情報マッチング結果にファイルを添付します。 指定された搬入情報マッチング結果に、ファイルを添付します。 帳票にファイルを添付できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
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でのレスポンスデータを編集し、指定するようにしてください。 |
ContainerGateInSlips
コンテナ貨物搬入票
API | Description | ||
---|---|---|---|
POST | /API/v2/Reports/ContainerGateInSlips/Create |
コンテナ貨物搬入票を作成します。 コンテナ貨物搬入票を作成するには、利用者がコンテナ貨物搬入票を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 コンテナ貨物搬入票に関する詳細については、[コンテナ貨物搬入票について]()を参照ください。 |
|
DELETE | /API/v2/Reports/ContainerGateInSlips/Delete/{reportId} |
コンテナ貨物搬入票を削除します。 帳票ID(***reportId***)を指定して、コンテナ貨物搬入票を削除します。 コンテナ貨物搬入票を削除しても、ルートドキュメントの内容までは削除されません。 申請種別を使用して、作成したコンテナ貨物搬入票のキャンセルを伝える場合は、キャンセル(***Cancel***)を実施後、帳票の提出(***Submit***)を実施してください。 コンテナ貨物搬入票に関する詳細については、[コンテナ貨物搬入票について]()を参照ください。 |
|
DELETE | /API/v2/Reports/ContainerGateInSlips/DeleteFile/{fileId} |
コンテナ貨物搬入票の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、コンテナ貨物搬入票の添付ファイルを削除します。 帳票の添付ファイルを削除できるのは、そのファイルを添付したパートナーに所属している利用者だけです。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
GET | /API/v2/Reports/ContainerGateInSlips/Get/{reportId} |
コンテナ貨物搬入票を取得します。 帳票ID(***reportId***)を指定して、コンテナ貨物搬入票を取得します。 編集が行われていない場合は、ルートドキュメントから最新のコンテナ貨物搬入票を取得します。 編集中の場合は、先に保存した、コンテナ貨物搬入票を取得します。 コンテナ貨物搬入票に関する詳細については、[コンテナ貨物搬入票について]()を参照ください。 |
|
GET | /API/v2/Reports/ContainerGateInSlips/GetFile/{fileId} |
コンテナ貨物搬入票に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、コンテナ貨物搬入票に添付されたファイルを取得します。 帳票の添付ファイルを獲得できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
GET | /API/v2/Reports/ContainerGateInSlips/GetList?tradeNo=!{tradeNo}&uniqueNo=!{uniqueNo}&bookingNo=!{bookingNo}&blNo=!{blNo} |
コンテナ貨物搬入票を全て取得します。 検索条件に該当するコンテナ貨物搬入票を全て取得します。 編集が行われていない場合は、ルートドキュメントから最新のコンテナ貨物搬入票を取得します。 編集中の場合は、先に保存した、コンテナ貨物搬入票を取得します。 コンテナ貨物搬入票に関する詳細については、[コンテナ貨物搬入票について]()を参照ください。 |
|
PATCH | /API/v2/Reports/ContainerGateInSlips/Lock/{reportId} |
編集するため、コンテナ貨物搬入票をロックします 帳票ID(***reportId***)を指定して、コンテナ貨物搬入票をロックします。 コンテナ貨物搬入票を作成(***Create***)した時点では、コンテナ貨物搬入票をロックが掛かりますが、取得(***Get***)したあとで、コンテナ貨物搬入票を編集する場合は、このメソッドを呼び出して、コンテナ貨物搬入票をロックします。 ロックされたコンテナ貨物搬入票は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、コンテナ貨物搬入票をルートドキュメントから参照できますが、編集中(ロック中)のコンテナ貨物搬入票は参照できません。 このロックは、アンロック(***Unlock***)を呼び出すか、帳票の保存後、帳票の提出(***Submit****)を行うと解除されます。 コンテナ貨物搬入票に関する詳細については、[コンテナ貨物搬入票について]()を参照ください。 |
|
PATCH | /API/v2/Reports/ContainerGateInSlips/SetCancel/{reportId} |
コンテナ貨物搬入票の申請種別をキャンセルします 帳票ID(***reportId***)を指定して、コンテナ貨物搬入票の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 コンテナ貨物搬入票に関する詳細については、[コンテナ貨物搬入票について]()を参照ください。 |
|
PATCH | /API/v2/Reports/ContainerGateInSlips/Submit/{reportId} |
コンテナ貨物搬入票を提出します 帳票ID(***reportId***)を指定して、更新(***Update***)したコンテナ貨物搬入票を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、コンテナ貨物搬入票が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、コンテナ貨物搬入票もロックされた状態のままなので、ご注意ください。 コンテナ貨物搬入票に関する詳細については、[コンテナ貨物搬入票について]()を参照ください。 |
|
PATCH | /API/v2/Reports/ContainerGateInSlips/Unlock/{reportId} |
コンテナ貨物搬入票のロックを解除します 帳票ID(***reportId***)を指定して、コンテナ貨物搬入票のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 コンテナ貨物搬入票に関する詳細については、[コンテナ貨物搬入票について]()を参照ください。 |
|
PATCH | /API/v2/Reports/ContainerGateInSlips/Update/{reportId} |
コンテナ貨物搬入票を更新します。 帳票ID(***reportId***)を指定して、コンテナ貨物搬入票を更新します。 このメソッドでは、コンテナ貨物搬入票の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 コンテナ貨物搬入票に関する詳細については、[コンテナ貨物搬入票について]()を参照ください。 |
|
POST | /API/v2/Reports/ContainerGateInSlips/UploadFile |
コンテナ貨物搬入票にファイルを添付します。 指定されたコンテナ貨物搬入票に、ファイルを添付します。 帳票にファイルを添付できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
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でのレスポンスデータを編集し、指定するようにしてください。 |
ContainerInspectionTypes
コンテナ検査種別
API | Description | ||
---|---|---|---|
DELETE | /API/v2/General/ContainerInspectionTypes/DeleteAdmin/{containerInspectionTypeCode} |
コンテナ検査種別コードを削除します。 コンテナ検査種別コード(***containerInspectionTypeCode***)を指定して、コンテナ検査種別コードを削除します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
GET | /API/v2/General/ContainerInspectionTypes/Get/{containerInspectionTypeCode} |
コンテナ検査種別を取得します。 コンテナ検査種別コード(***containerInspectionTypeCode***)を指定して、コンテナ検査種別を取得します。 コンテナ検査種別コードに関する詳細については、[コンテナ検査種別コードについて]()を参照ください。 |
|
GET | /API/v2/General/ContainerInspectionTypes/GetList |
コンテナ検査種別を全て取得します。 コンテナ検査種別コードに関する詳細については、[コンテナ検査種別コードについて]()を参照ください。 |
|
POST | /API/v2/General/ContainerInspectionTypes/RegisterAdmin |
コンテナ検査種別を登録します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
POST | /API/v2/General/ContainerInspectionTypes/RegisterInternal |
コンテナ検査種別を登録します。 内部呼び出し用。 (*For admin) |
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でのレスポンスデータを編集し、指定するようにしてください。 |
ContainerLoadPlans
コンテナ内積付書(CLP)
API | Description | ||
---|---|---|---|
POST | /API/v2/Reports/ContainerLoadPlans/Create |
コンテナ内積付書(CLP)を作成します。 コンテナ内積付書(CLP)を作成するには、利用者がコンテナ内積付書(CLP)を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 コンテナ内積付書(CLP)に関する詳細については、[コンテナ内積付書(CLP)について]()を参照ください。 |
|
DELETE | /API/v2/Reports/ContainerLoadPlans/Delete/{reportId} |
コンテナ内積付書(CLP)を削除します。 帳票ID(***reportId***)を指定して、コンテナ内積付書(CLP)を削除します。 コンテナ内積付書(CLP)を削除しても、ルートドキュメントの内容までは削除されません。 申請種別を使用して、作成したコンテナ内積付書(CLP)のキャンセルを伝える場合は、キャンセル(***Cancel***)を実施後、帳票の提出(***Submit***)を実施してください。 コンテナ内積付書(CLP)に関する詳細については、[コンテナ内積付書(CLP)について]()を参照ください。 |
|
DELETE | /API/v2/Reports/ContainerLoadPlans/DeleteFile/{fileId} |
コンテナ内積付書(CLP)の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、コンテナ内積付書(CLP)の添付ファイルを削除します。 帳票の添付ファイルを削除できるのは、そのファイルを添付したパートナーに所属している利用者だけです。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
GET | /API/v2/Reports/ContainerLoadPlans/Get/{reportId} |
コンテナ内積付書(CLP)を取得します。 帳票ID(***reportId***)を指定して、コンテナ内積付書(CLP)を取得します。 編集が行われていない場合は、ルートドキュメントから最新のコンテナ内積付書(CLP)を取得します。 編集中の場合は、先に保存した、コンテナ内積付書(CLP)を取得します。 コンテナ内積付書(CLP)に関する詳細については、[コンテナ内積付書(CLP)について]()を参照ください。 |
|
GET | /API/v2/Reports/ContainerLoadPlans/GetFile/{fileId} |
コンテナ内積付書(CLP)に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、コンテナ内積付書(CLP)に添付されたファイルを取得します。 帳票の添付ファイルを獲得できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
GET | /API/v2/Reports/ContainerLoadPlans/GetList?tradeNo=!{tradeNo}&uniqueNo=!{uniqueNo}&bookingNo=!{bookingNo}&blNo=!{blNo} |
コンテナ内積付書(CLP)を全て取得します。 検索条件に該当するコンテナ内積付書(CLP)を全て取得します。 編集が行われていない場合は、ルートドキュメントから最新の船積依頼書を取得します。 編集中の場合は、先に保存した、コンテナ内積付書(CLP)を取得します。 コンテナ内積付書(CLP)に関する詳細については、[コンテナ内積付書(CLP)について]()を参照ください。 |
|
PATCH | /API/v2/Reports/ContainerLoadPlans/Lock/{reportId} |
編集するため、コンテナ内積付書(CLP)をロックします 帳票ID(***reportId***)を指定して、コンテナ内積付書(CLP)をロックします。 コンテナ内積付書(CLP)を作成(***Create***)した時点では、コンテナ内積付書(CLP)をロックが掛かりますが、取得(***Get***)したあとで、コンテナ内積付書(CLP)を編集する場合は、このメソッドを呼び出して、コンテナ内積付書(CLP)をロックします。 ロックされたコンテナ内積付書(CLP)は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、コンテナ内積付書(CLP)をルートドキュメントから参照できますが、編集中(ロック中)のコンテナ内積付書(CLP)は参照できません。 このロックは、アンロック(***Unlock***)を呼び出すか、帳票の保存後、帳票の提出(***Submit****)を行うと解除されます。 コンテナ内積付書(CLP)に関する詳細については、[コンテナ内積付書(CLP)について]()を参照ください。 |
|
PATCH | /API/v2/Reports/ContainerLoadPlans/SetCancel/{reportId} |
コンテナ内積付書(CLP)の申請種別をキャンセルします 帳票ID(***reportId***)を指定して、コンテナ内積付書(CLP)の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 コンテナ内積付書(CLP)に関する詳細については、[コンテナ内積付書(CLP)について]()を参照ください。 |
|
PATCH | /API/v2/Reports/ContainerLoadPlans/Submit/{reportId} |
コンテナ内積付書(CLP)を提出します 帳票ID(***reportId***)を指定して、更新(***Update***)したコンテナ内積付書(CLP)を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、コンテナ内積付書(CLP)が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、船積依頼書もロックされた状態のままなので、ご注意ください。 コンテナ内積付書(CLP)に関する詳細については、[コンテナ内積付書(CLP)について]()を参照ください。 |
|
PATCH | /API/v2/Reports/ContainerLoadPlans/Unlock/{reportId} |
コンテナ内積付書(CLP)のロックを解除します 帳票ID(***reportId***)を指定して、コンテナ内積付書(CLP)のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 コンテナ内積付書(CLP)に関する詳細については、[コンテナ内積付書(CLP)について]()を参照ください。 |
|
PATCH | /API/v2/Reports/ContainerLoadPlans/Update/{reportId} |
コンテナ内積付書(CLP)を更新します。 帳票ID(***reportId***)を指定して、コンテナ内積付書(CLP)を更新します。 このメソッドでは、コンテナ内積付書(CLP)の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 コンテナ内積付書(CLP)に関する詳細については、[コンテナ内積付書(CLP)について]()を参照ください。 |
|
POST | /API/v2/Reports/ContainerLoadPlans/UploadFile |
コンテナ内積付書(CLP)にファイルを添付します。 指定されたコンテナ内積付書(CLP)に、ファイルを添付します。 帳票にファイルを添付できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
ContainerSizeHeights
コンテナサイズ(高さ)
API | Description | ||
---|---|---|---|
DELETE | /API/v2/General/ContainerSizeHeights/DeleteAdmin/{heightCode} |
コンテナサイズ(高さ)を削除します。 コンテナサイズ(高さ)(***heightCode***)を指定して、コンテナサイズ(長さ)を削除します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
GET | /API/v2/General/ContainerSizeHeights/Get/{heightCode} |
コンテナサイズ(高さ)を取得します。 コンテナサイズ(高さ)(***heightCode***)を指定して、コンテナサイズ(高さ)を取得します。 コンテナタイプやサイズに関する詳細については、[コンテナタイプやサイズについて]()を参照ください。 |
|
GET | /API/v2/General/ContainerSizeHeights/GetList |
コンテナサイズ(高さ)を取得します。 コンテナサイズ(高さ)を全て取得します。 コンテナタイプやサイズに関する詳細については、[コンテナタイプやサイズについて]()を参照ください。 |
|
POST | /API/v2/General/ContainerSizeHeights/RegisterAdmin |
コンテナサイズ(高さ)を登録します。 このAPIはシステム管理者しか呼び出せません。 (*For admin) |
|
POST | /API/v2/General/ContainerSizeHeights/RegisterInternal |
コンテナサイズ(高さ)を登録します。 内部呼び出し用。 (*For admin) |
ContainerSizeLengths
コンテナサイズ(長さ)
API | Description | ||
---|---|---|---|
DELETE | /API/v2/General/ContainerSizeLengths/DeleteAdmin/{lengthCode} |
コンテナサイズ(長さ)を削除します。 コンテナサイズ(長さ)(***lengthCode***)を指定して、コンテナサイズ(長さ)を削除します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
GET | /API/v2/General/ContainerSizeLengths/Get/{lengthCode} |
コンテナサイズ(長さ)を取得します。 コンテナサイズ(長さ)(***lengthCode***)を指定して、コンテナサイズ(長さ)を取得します。 コンテナタイプやサイズに関する詳細については、[コンテナタイプやサイズについて]()を参照ください。 |
|
GET | /API/v2/General/ContainerSizeLengths/GetList |
コンテナサイズ(長さ)を取得します。 コンテナサイズ(長さ)を全て取得します。 コンテナタイプやサイズに関する詳細については、[コンテナタイプやサイズについて]()を参照ください。 |
|
POST | /API/v2/General/ContainerSizeLengths/RegisterAdmin |
コンテナサイズ(長さ)を登録します。 このAPIはシステム管理者しか呼び出せません。 (*For admin) |
|
POST | /API/v2/General/ContainerSizeLengths/RegisterInternal |
コンテナサイズ(長さ)を登録します。 内部呼び出し用。 (*For admin) |
ContainerTerminals
コンテナターミナル
API | Description | ||
---|---|---|---|
GET | /API/v2/General/ContainerTerminals/Get/{containerTerminalCode} |
コンテナターミナルコードを取得します。 コンテナターミナルコード(***containerTerminalCode***)を指定して、コンテナターミナルコード(保税地域コード)を取得します。 NACCSから連携されるマスターデータに関する詳細については、[NACCSから連携されるマスターデータについて]()を参照ください。 |
|
GET | /API/v2/General/ContainerTerminals/GetList?containerTerminalCode=!{containerTerminalCode}&containerTerminalName=!{containerTerminalName}&userCode=!{userCode}&joinAsSea=!{joinAsSea}&joinAsAir=!{joinAsAir}&postIsCargoManage=!{postIsCargoManage}&isCompanyFacilities=!{isCompanyFacilities} |
コンテナターミナルコードを取得します。 検索条件に該当するコンテナターミナルコード(保税地域コード)を全て取得します。 NACCSから連携されるマスターデータに関する詳細については、[NACCSから連携されるマスターデータについて]()を参照ください。 |
ContainerTypes
コンテナタイプ
API | Description | ||
---|---|---|---|
DELETE | /API/v2/General/ContainerTypes/DeleteAdmin/{containerTypeCode} |
コンテナタイプを削除します。 コンテナタイプコード(***containerTypeCode***)を指定して、コンテナタイプを削除します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
GET | /API/v2/General/ContainerTypes/Get/{containerTypeCode} |
コンテナタイプを取得します。 コンテナタイプコード(***containerTypeCode***)を指定して、コンテナタイプを取得します。 コンテナタイプやサイズに関する詳細については、[コンテナタイプやサイズについて]()を参照ください。 |
|
GET | /API/v2/General/ContainerTypes/GetList |
コンテナタイプを取得します。 コンテナタイプを全て取得します。 コンテナタイプやサイズに関する詳細については、[コンテナタイプやサイズについて]()を参照ください。 |
|
POST | /API/v2/General/ContainerTypes/RegisterAdmin |
コンテナタイプを登録します。 このAPIはシステム管理者しか呼び出せません。 (*For admin) |
|
POST | /API/v2/General/ContainerTypes/RegisterInternal |
コンテナタイプを登録します。 内部呼び出し用。 (*For admin) |
ContractIncotermsCodes
価格条件コード
API | Description | ||
---|---|---|---|
DELETE | /API/v2/General/ContractIncotermsCodes/DeleteAdmin/{contractIncotermsCode} |
価格条件コードを削除します。 価格条件コード(***contractIncotermsCode***)を指定して、価格条件コードを削除します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
GET | /API/v2/General/ContractIncotermsCodes/Get/{contractIncotermsCode} |
価格条件種別を取得します。 価格条件コード(***contractIncotermsCode***)を指定して、価格条件種別を取得します。 価格条件コードに関する詳細については、[価格条件コードについて]()を参照ください。 |
|
GET | /API/v2/General/ContractIncotermsCodes/GetList |
価格条件種別を全て取得します。 価格条件コードに関する詳細については、[価格条件コードについて]()を参照ください。 |
|
POST | /API/v2/General/ContractIncotermsCodes/RegisterAdmin |
価格条件種別を登録します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
POST | /API/v2/General/ContractIncotermsCodes/RegisterInternal |
価格条件種別を登録します。 内部呼び出し用。 (*For admin) |
ConversionUnitCodeForCustoms
通関用数量換算単位コード
API | Description | ||
---|---|---|---|
DELETE | /API/v2/General/ConversionUnitCodeForCustoms/DeleteAdmin/{conversionUnitCode} |
通関用数量換算単位コードを削除します。 通関用数量換算単位コード(***conversionUnitCode***)を指定して、通関用数量換算単位コードを削除します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
GET | /API/v2/General/ConversionUnitCodeForCustoms/Get/{conversionUnitCode} |
通関用数量換算単位を取得します。 通関用数量換算単位コード(***conversionUnitCode***)を指定して、通関用数量換算単位を取得します。 通関用数量換算単位コードに関する詳細については、[通関用数量換算単位コードについて]()を参照ください。 |
|
GET | /API/v2/General/ConversionUnitCodeForCustoms/GetList |
通関用数量換算単位を全て取得します。 通関用数量換算単位コードに関する詳細については、[通関用数量換算単位コードについて]()を参照ください。 |
|
POST | /API/v2/General/ConversionUnitCodeForCustoms/RegisterAdmin |
通関用数量換算単位を登録します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
POST | /API/v2/General/ConversionUnitCodeForCustoms/RegisterInternal |
通関用数量換算単位を登録します。 内部呼び出し用。 (*For admin) |
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でのレスポンスデータを編集し、指定するようにしてください。 |
CorrectionReasonCodes
訂正理由コード
API | Description | ||
---|---|---|---|
DELETE | /API/v2/General/CorrectionReasonCodes/DeleteAdmin/{correctionReasonCode} |
訂正理由コードを削除します。 訂正理由コード(***correctionReasonCode***)を指定して、訂正理由コードを削除します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
GET | /API/v2/General/CorrectionReasonCodes/Get/{correctionReasonCode} |
訂正理由を取得します。 訂正理由コード(***correctionReasonCode***)を指定して、訂正理由を取得します。 訂正理由コードに関する詳細については、[通関用数量換算単位コードについて]()を参照ください。 |
|
GET | /API/v2/General/CorrectionReasonCodes/GetList |
訂正理由を全て取得します。 訂正理由コードに関する詳細については、[訂正理由コードについて]()を参照ください。 |
|
POST | /API/v2/General/CorrectionReasonCodes/RegisterAdmin |
訂正理由を登録します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
POST | /API/v2/General/CorrectionReasonCodes/RegisterInternal |
訂正理由を登録します。 内部呼び出し用。 (*For admin) |
Countries
国
API | Description | ||
---|---|---|---|
DELETE | /API/v2/General/Countries/DeleteAdmin/{countryCode} |
国を削除します。 国(***countryCode***)を指定して、国を削除します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
GET | /API/v2/General/Countries/Get/{countryCode} |
国を取得します。 国コード(***countryCode***)を指定して、国を取得します。 |
|
GET | /API/v2/General/Countries/GetList?countryCode=!{countryCode}&countryCodeAlfa3=!{countryCodeAlfa3}&countryCodeNumeric=!{countryCodeNumeric}&countryName=!{countryName}&countryNameEn=!{countryNameEn} |
国を取得します。 検索条件に該当する国を全て取得します。 |
|
POST | /API/v2/General/Countries/RegisterAdmin |
国を登録します。 このAPIはシステム管理者しか呼び出せません。 (*For admin) |
|
POST | /API/v2/General/Countries/RegisterInternal |
国を登録します。 内部呼び出し用。 (*For admin) |
Currencies
通貨
API | Description | ||
---|---|---|---|
DELETE | /API/v2/General/Currencies/DeleteAdmin/{currencyCode} |
通貨を削除します。 通貨コード(***currencyCode***)を指定して、通貨を削除します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
GET | /API/v2/General/Currencies/Get/{currencyCode} |
通貨を取得します。 通貨コード(***currencyCode***)を指定して、国を取得します。 |
|
GET | /API/v2/General/Currencies/GetList?currencyCode=!{currencyCode}&countryName=!{countryName}&isTaxableValueConversionRate=!{isTaxableValueConversionRate}&isExchangeRate=!{isExchangeRate} |
通貨を取得します。 検索条件に該当する通貨を全て取得します。 |
|
POST | /API/v2/General/Currencies/RegisterAdmin |
通貨を登録します。 このAPIはシステム管理者しか呼び出せません。 (*For admin) |
|
POST | /API/v2/General/Currencies/RegisterInternal |
通貨を登録します。 内部呼び出し用。 (*For admin) |
CustomizedProcesses
カスタマイズしたプロセス
API | Description | ||
---|---|---|---|
DELETE | /API/v2/Organizations/CustomizedProcesses/Delete/{customizedProcessCode} |
カスタマイズしたプロセスを削除します。 カスタマイズプロセスコード(***customizedProcessCode***)を指定して、カスタマイズしたプロセスを削除します。 尚、カスタマイズしたプロセスを削除しても、そのプロセスが開始している取引には影響はありませんが、プロセスの名称や説明は、カスタマイズしたプロセスの基となった標準プロセスの名称や説明が使用されます。 プロセスのカスタマイズに関する詳細については、[プロセスのカスタマイズについて]()を参照ください。 |
|
GET | /API/v2/Organizations/CustomizedProcesses/Get/{customizedProcessCode} |
カスタマイズプロセスコードを指定して、カスタマイズしたプロセスコードを取得します。 カスタマイズプロセスコード(***customizedProcessCode***)を指定して、カスタマイズしたプロセスを取得します。 プロセスのカスタマイズに関する詳細については、[プロセスのカスタマイズについて]()を参照ください。 |
|
GET | /API/v2/Organizations/CustomizedProcesses/GetList?processGroupCode=!{processGroupCode}&processCode=!{processCode}&customizedProcessCode=!{customizedProcessCode}&customizedProcessName=!{customizedProcessName}&customizedProcessNameEn=!{customizedProcessNameEn}&organizationId=!{organizationId}&processType=!{processType}&tradeType=!{tradeType} |
検索条件を指定して、カスタマイズしたプロセスコードを取得します。 検索条件を指定して、カスタマイズしたプロセスコードを取得します。 取引タイプ(***tradeNo***)、事業種別コード(***businessTypeCode***)、組織ID(***organizationId***)は、必須の検索条件となります。 プロセスのカスタマイズに関する詳細については、[プロセスのカスタマイズについて]()を参照ください。 |
|
POST | /API/v2/Organizations/CustomizedProcesses/Register |
カスタマイズした標準プロセスを登録します。 指定された組織・事業種別に、そのカスタマイズした標準プロセスを登録します。 サイバーポートの標準としてのプロセス(***/API/v2/Master/StandardProcesses***)をカスタマイズし、このプロセスで必要となる項目や帳票毎に必須項目を設定します。 カスタマイズした標準プロセスでは、プロセス種別(帳票を提出するのか、帳票を受け取るのか)やプロセスで取り扱う帳票、その帳票における必須項目が設定できます。 頻繫に使用する標準プロセスをカスタマイズしたプロセスとして登録しておくと、取引でのプロセス開始時に、操作を簡略化することが可能です。 カスタマイズしたプロセスは、自社、及び、その組織・事業種別(***assignedBusinessTypeId***)でプロセス種別が選択可能なプロセスについて、登録できます。 プロセスのカスタマイズに関する詳細については、[プロセスのカスタマイズについて]()を参照ください。 |
|
PATCH | /API/v2/Organizations/CustomizedProcesses/Update/{customizedProcessCode} |
カスタマイズしたプロセスを更新します。 カスタマイズプロセスコード(***customizedProcessCode***)を指定して、カスタマイズしたプロセスの名称や説明を更新します。 カスタマイズしたプロセスを作成し直す場合は、削除を行ってから、作成し直してください。 プロセスのカスタマイズに関する詳細については、[プロセスのカスタマイズについて]()を参照ください。 |
CustomsDutyReductionAndExemptionCodes
関税減免税コード
API | Description | ||
---|---|---|---|
DELETE | /API/v2/General/CustomsDutyReductionAndExemptionCodes/DeleteAdmin/{customsDutyReductionAndExemptionCode} |
関税減免税コードを削除します。 関税減免税コード(***customsDutyReductionAndExemptionCode***)を指定して、関税減免税コードを削除します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
GET | /API/v2/General/CustomsDutyReductionAndExemptionCodes/Get/{customsDutyReductionAndExemptionCode} |
関税減免税種別を取得します。 関税減免税コード(***customsDutyReductionAndExemptionCode***)を指定して、関税減免税種別を取得します。 関税減免税コードに関する詳細については、[関税減免税コードについて]()を参照ください。 |
|
GET | /API/v2/General/CustomsDutyReductionAndExemptionCodes/GetList |
関税減免税種別を全て取得します。 関税減免税コードに関する詳細については、[関税減免税コードについて]()を参照ください。 |
|
POST | /API/v2/General/CustomsDutyReductionAndExemptionCodes/RegisterAdmin |
関税減免税種別を登録します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
POST | /API/v2/General/CustomsDutyReductionAndExemptionCodes/RegisterInternal |
関税減免税種別を登録します。 内部呼び出し用。 (*For admin) |
CustomsDutyReductionAndExemptionTaxCodes
関税減免戻税コード
API | Description | ||
---|---|---|---|
DELETE | /API/v2/General/CustomsDutyReductionAndExemptionTaxCodes/DeleteAdmin/{customsDutyReductionAndExemptionTaxCode} |
関税減免戻税コードを削除します。 関税減免戻税コード(***customsDutyReductionAndExemptionTaxCode***)を指定して、関税減免戻税コードを削除します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
GET | /API/v2/General/CustomsDutyReductionAndExemptionTaxCodes/Get/{customsDutyReductionAndExemptionTaxCode} |
関税減免戻税種別を取得します。 関税減免戻税コード(***customsDutyReductionAndExemptionTaxCode***)を指定して、関税減免戻税種別を取得します。 関税減免戻税コードに関する詳細については、[関税減免戻税コードについて]()を参照ください。 |
|
GET | /API/v2/General/CustomsDutyReductionAndExemptionTaxCodes/GetList |
関税減免戻税種別を全て取得します。 関税減免戻税コードに関する詳細については、[関税減免戻税コードについて]()を参照ください。 |
|
POST | /API/v2/General/CustomsDutyReductionAndExemptionTaxCodes/RegisterAdmin |
関税減免戻税種別を登録します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
POST | /API/v2/General/CustomsDutyReductionAndExemptionTaxCodes/RegisterInternal |
関税減免戻税種別を登録します。 内部呼び出し用。 (*For admin) |
CustomsOfficeCodes
税関官署コード
API | Description | ||
---|---|---|---|
DELETE | /API/v2/General/CustomsOfficeCodes/DeleteAdmin/{customsOfficeCode} |
税関官署コードを削除します。 税関官署コード(***customsOfficeCode***)を指定して、税関官署コードを削除します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
GET | /API/v2/General/CustomsOfficeCodes/Get/{customsOfficeCode} |
税関官署を取得します。 税関官署コード(***customsOfficeCode***)を指定して、税関官署を取得します。 税関官署コードに関する詳細については、[税関官署コードについて]()を参照ください。 |
|
GET | /API/v2/General/CustomsOfficeCodes/GetList |
税関官署を全て取得します。 税関官署コードに関する詳細については、[税関官署コードについて]()を参照ください。 |
|
POST | /API/v2/General/CustomsOfficeCodes/RegisterAdmin |
税関官署を登録します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
POST | /API/v2/General/CustomsOfficeCodes/RegisterInternal |
税関官署を登録します。 内部呼び出し用。 (*For admin) |
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でのレスポンスデータを編集し、指定するようにしてください。 |
CyCarryInRegistrationCalls
CYH11
API | Description | ||
---|---|---|---|
POST | /API/v1/NaccsReport/CyCarryInRegistrationCalls/Create |
帳票:CYH11を作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 帳票:CYH11が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/NaccsReport/CyCarryInRegistrationCalls/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:CYH11を削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
GET | /API/v1/NaccsReport/CyCarryInRegistrationCalls/Get/{dealReportId} |
帳票:CYH11を取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/NaccsReport/CyCarryInRegistrationCalls/GetAttachFileMetaList/{dealReportId} |
添付ファイル情報一覧を取得します。 |
|
POST | /API/v1/NaccsReport/CyCarryInRegistrationCalls/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/CyCarryInRegistrationCalls/Register |
帳票:CYH11を保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
CyCarryInRegistrations
CYH
API | Description | ||
---|---|---|---|
POST | /API/v1/NaccsReport/CyCarryInRegistrations/Create |
帳票:CYHを作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 |
|
DELETE | /API/v1/NaccsReport/CyCarryInRegistrations/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:CYHを削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
GET | /API/v1/NaccsReport/CyCarryInRegistrations/Get/{dealReportId} |
帳票:CYHを取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/NaccsReport/CyCarryInRegistrations/GetAttachFileMetaList/{dealReportId} |
添付ファイル情報一覧を取得します。 |
|
POST | /API/v1/NaccsReport/CyCarryInRegistrations/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/CyCarryInRegistrations/Register |
帳票:CYHを保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対して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でのレスポンスデータを編集し、指定するようにしてください。 |
CyDispatchOrders
コンテナ貨物搬出票
API | Description | ||
---|---|---|---|
POST | /API/v2/Reports/CyDispatchOrders/Create |
コンテナ貨物搬出票を作成します。 コンテナ貨物搬出票を作成するには、利用者がコンテナ貨物搬出票を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 コンテナ貨物搬出票に関する詳細については、[コンテナ貨物搬出票について]()を参照ください。 |
|
DELETE | /API/v2/Reports/CyDispatchOrders/Delete/{reportId} |
コンテナ貨物搬出票を削除します。 帳票ID(***reportId***)を指定して、コンテナ貨物搬出票を削除します。 コンテナ貨物搬出票を削除しても、ルートドキュメントの内容までは削除されません。 申請種別を使用して、作成したコンテナ貨物搬入票のキャンセルを伝える場合は、キャンセル(***Cancel***)を実施後、帳票の提出(***Submit***)を実施してください。 コンテナ貨物搬出票に関する詳細については、[コンテナ貨物搬出票について]()を参照ください。 |
|
DELETE | /API/v2/Reports/CyDispatchOrders/DeleteFile/{fileId} |
コンテナ貨物搬出票の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、コンテナ貨物搬出票の添付ファイルを削除します。 帳票の添付ファイルを削除できるのは、そのファイルを添付したパートナーに所属している利用者だけです。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
GET | /API/v2/Reports/CyDispatchOrders/Get/{reportId} |
コンテナ貨物搬出票を取得します。 帳票ID(***reportId***)を指定して、コンテナ貨物搬出票を取得します。 編集が行われていない場合は、ルートドキュメントから最新のコンテナ貨物搬出票を取得します。 編集中の場合は、先に保存した、コンテナ貨物搬出票を取得します。 コンテナ貨物搬出票に関する詳細については、[コンテナ貨物搬出票について]()を参照ください。 |
|
GET | /API/v2/Reports/CyDispatchOrders/GetFile/{fileId} |
コンテナ貨物搬出票に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、コンテナ貨物搬出票に添付されたファイルを取得します。 帳票の添付ファイルを獲得できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
GET | /API/v2/Reports/CyDispatchOrders/GetList?tradeNo=!{tradeNo}&uniqueNo=!{uniqueNo}&bookingNo=!{bookingNo}&blNo=!{blNo} |
コンテナ貨物搬出票を全て取得します。 検索条件に該当するコンテナ貨物搬出票を全て取得します。 編集が行われていない場合は、ルートドキュメントから最新のコンテナ貨物搬出票を取得します。 編集中の場合は、先に保存した、コンテナ貨物搬出票を取得します。 コンテナ貨物搬出票に関する詳細については、[コンテナ貨物搬出票について]()を参照ください。 |
|
PATCH | /API/v2/Reports/CyDispatchOrders/Lock/{reportId} |
編集するため、コンテナ貨物搬出票をロックします 帳票ID(***reportId***)を指定して、コンテナ貨物搬出票をロックします。 コンテナ貨物搬出票を作成(***Create***)した時点では、コンテナ貨物搬出票をロックが掛かりますが、取得(***Get***)したあとで、コンテナ貨物搬出票を編集する場合は、このメソッドを呼び出して、コンテナ貨物搬出票をロックします。 ロックされたコンテナ貨物搬出票は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、コンテナ貨物搬出票をルートドキュメントから参照できますが、編集中(ロック中)のコンテナ貨物搬出票は参照できません。 このロックは、アンロック(***Unlock***)を呼び出すか、帳票の保存後、帳票の提出(***Submit****)を行うと解除されます。 コンテナ貨物搬出票に関する詳細については、[コンテナ貨物搬出票について]()を参照ください。 |
|
PATCH | /API/v2/Reports/CyDispatchOrders/SetCancel/{reportId} |
コンテナ貨物搬出票の申請種別をキャンセルします 帳票ID(***reportId***)を指定して、コンテナ貨物搬出票の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 コンテナ貨物搬出票に関する詳細については、[コンテナ貨物搬出票について]()を参照ください。 |
|
PATCH | /API/v2/Reports/CyDispatchOrders/Submit/{reportId} |
コンテナ貨物搬出票を提出します 帳票ID(***reportId***)を指定して、更新(***Update***)したコンテナ貨物搬出票を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、コンテナ貨物搬出票が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、コンテナ貨物搬入票もロックされた状態のままなので、ご注意ください。 コンテナ貨物搬出票に関する詳細については、[コンテナ貨物搬出票について]()を参照ください。 |
|
PATCH | /API/v2/Reports/CyDispatchOrders/Unlock/{reportId} |
コンテナ貨物搬出票のロックを解除します 帳票ID(***reportId***)を指定して、コンテナ貨物搬出票のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 コンテナ貨物搬出票に関する詳細については、[コンテナ貨物搬出票について]()を参照ください。 |
|
PATCH | /API/v2/Reports/CyDispatchOrders/Update/{reportId} |
コンテナ貨物搬出票を更新します。 帳票ID(***reportId***)を指定して、コンテナ貨物搬出票を更新します。 このメソッドでは、コンテナ貨物搬出票の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 コンテナ貨物搬出票に関する詳細については、[コンテナ貨物搬出票について]()を参照ください。 |
|
POST | /API/v2/Reports/CyDispatchOrders/UploadFile |
コンテナ貨物搬入票にファイルを添付します。 指定されたコンテナ貨物搬入票に、ファイルを添付します。 帳票にファイルを添付できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
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権限が必要です。 |
DangerousGoodsAdvanceNotices
危険物又は有害物事前連絡票
API | Description | ||
---|---|---|---|
POST | /API/v2/Reports/DangerousGoodsAdvanceNotices/Create |
危険物又は有害物事前連絡票を作成します。 危険物又は有害物事前連絡票を作成するには、利用者が危険物又は有害物事前連絡票を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 危険物又は有害物事前連絡票に関する詳細については、[危険物又は有害物事前連絡票について]()を参照ください。 |
|
DELETE | /API/v2/Reports/DangerousGoodsAdvanceNotices/Delete/{reportId} |
危険物又は有害物事前連絡票を削除します。 帳票ID(***reportId***)を指定して、危険物又は有害物事前連絡票を削除します。 危険物又は有害物事前連絡票を削除しても、ルートドキュメントの内容までは削除されません。 申請種別を使用して、作成した危険物又は有害物事前連絡票のキャンセルを伝える場合は、キャンセル(***Cancel***)を実施後、帳票の提出(***Submit***)を実施してください。 危険物又は有害物事前連絡票に関する詳細については、[危険物又は有害物事前連絡票について]()を参照ください。 |
|
DELETE | /API/v2/Reports/DangerousGoodsAdvanceNotices/DeleteFile/{fileId} |
危険物又は有害物事前連絡票の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、危険物又は有害物事前連絡票の添付ファイルを削除します。 帳票の添付ファイルを削除できるのは、そのファイルを添付したパートナーに所属している利用者だけです。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
GET | /API/v2/Reports/DangerousGoodsAdvanceNotices/Get/{reportId} |
危険物又は有害物事前連絡票を取得します。 帳票ID(***reportId***)を指定して、危険物又は有害物事前連絡票を取得します。 編集が行われていない場合は、ルートドキュメントから最新のブッキング依頼書を取得します。 編集中の場合は、先に保存した、危険物又は有害物事前連絡票を取得します。 危険物又は有害物事前連絡票に関する詳細については、[危険物又は有害物事前連絡票について]()を参照ください。 |
|
GET | /API/v2/Reports/DangerousGoodsAdvanceNotices/GetFile/{fileId} |
危険物又は有害物事前連絡票に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、危険物又は有害物事前連絡票に添付されたファイルを取得します。 帳票の添付ファイルを獲得できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
GET | /API/v2/Reports/DangerousGoodsAdvanceNotices/GetList?tradeNo=!{tradeNo}&uniqueNo=!{uniqueNo}&bookingNo=!{bookingNo}&blNo=!{blNo} |
危険物又は有害物事前連絡票を全て取得します。 検索条件に該当する危険物又は有害物事前連絡票を全て取得します。 編集が行われていない場合は、ルートドキュメントから最新の危険物明細書を取得します。 編集中の場合は、先に保存した、危険物又は有害物事前連絡票を取得します。 危険物又は有害物事前連絡票に関する詳細については、[危険物又は有害物事前連絡票について]()を参照ください。 |
|
PATCH | /API/v2/Reports/DangerousGoodsAdvanceNotices/Lock/{reportId} |
編集するため、危険物又は有害物事前連絡票をロックします 帳票ID(***reportId***)を指定して、危険物又は有害物事前連絡票をロックします。 危険物又は有害物事前連絡票を作成(***Create***)した時点では、危険物又は有害物事前連絡票をロックが掛かりますが、取得(***Get***)したあとで、危険物又は有害物事前連絡票を編集する場合は、このメソッドを呼び出して、危険物又は有害物事前連絡票をロックします。 ロックされた危険物又は有害物事前連絡票は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、危険物又は有害物事前連絡票をルートドキュメントから参照できますが、編集中(ロック中)の危険物又は有害物事前連絡票は参照できません。 このロックは、アンロック(***Unlock***)を呼び出すか、帳票の保存後、帳票の提出(***Submit****)を行うと解除されます。 危険物又は有害物事前連絡票に関する詳細については、[危険物又は有害物事前連絡票について]()を参照ください。 |
|
PATCH | /API/v2/Reports/DangerousGoodsAdvanceNotices/SetCancel/{reportId} |
危険物又は有害物事前連絡票の申請種別をキャンセルします 帳票ID(***reportId***)を指定して、危険物又は有害物事前連絡票の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 危険物又は有害物事前連絡票に関する詳細については、[危険物又は有害物事前連絡票について]()を参照ください。 |
|
PATCH | /API/v2/Reports/DangerousGoodsAdvanceNotices/Submit/{reportId} |
危険物又は有害物事前連絡票を提出します 帳票ID(***reportId***)を指定して、更新(***Update***)したブッキング依頼書を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、危険物又は有害物事前連絡票が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ブッキング依頼書もロックされた状態のままなので、ご注意ください。 危険物又は有害物事前連絡票に関する詳細については、[危険物又は有害物事前連絡票について]()を参照ください。 |
|
PATCH | /API/v2/Reports/DangerousGoodsAdvanceNotices/Unlock/{reportId} |
危険物又は有害物事前連絡票のロックを解除します 帳票ID(***reportId***)を指定して、危険物又は有害物事前連絡票のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 危険物又は有害物事前連絡票に関する詳細については、[危険物又は有害物事前連絡票について]()を参照ください。 |
|
PATCH | /API/v2/Reports/DangerousGoodsAdvanceNotices/Update/{reportId} |
危険物又は有害物事前連絡票を更新します。 帳票ID(***reportId***)を指定して、危険物又は有害物事前連絡票を更新します。 このメソッドでは、危険物又は有害物事前連絡票の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 危険物又は有害物事前連絡票に関する詳細については、[危険物又は有害物事前連絡票について]()を参照ください。 |
|
POST | /API/v2/Reports/DangerousGoodsAdvanceNotices/UploadFile |
危険物又は有害物事前連絡票にファイルを添付します。 指定された危険物又は有害物事前連絡票に、ファイルを添付します。 帳票にファイルを添付できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
DangerousGoodsCargoListCalls
DLR11
API | Description | ||
---|---|---|---|
POST | /API/v1/NaccsReport/DangerousGoodsCargoListCalls/Create |
帳票:DLR11を作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 帳票:DLR11が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/NaccsReport/DangerousGoodsCargoListCalls/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:DLR11を削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
GET | /API/v1/NaccsReport/DangerousGoodsCargoListCalls/Get/{dealReportId} |
帳票:DLR11を取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/NaccsReport/DangerousGoodsCargoListCalls/GetAttachFileMetaList/{dealReportId} |
添付ファイル情報一覧を取得します。 |
|
POST | /API/v1/NaccsReport/DangerousGoodsCargoListCalls/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/DangerousGoodsCargoListCalls/Register |
帳票:DLR11を保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
DangerousGoodsCargoLists
DLR
API | Description | ||
---|---|---|---|
POST | /API/v1/NaccsReport/DangerousGoodsCargoLists/Create |
帳票:DLRを作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 |
|
DELETE | /API/v1/NaccsReport/DangerousGoodsCargoLists/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:DLRを削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
GET | /API/v1/NaccsReport/DangerousGoodsCargoLists/Get/{dealReportId} |
帳票:DLRを取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/NaccsReport/DangerousGoodsCargoLists/GetAttachFileMetaList/{dealReportId} |
添付ファイル情報一覧を取得します。 |
|
POST | /API/v1/NaccsReport/DangerousGoodsCargoLists/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/DangerousGoodsCargoLists/Register |
帳票:DLRを保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
DangerousGoodsDescriptionAndAdvanceNoticeCommons
危険物明細書・危険物又は有害物事前連絡表 共通帳票
API | Description | ||
---|---|---|---|
POST | /API/v2/Reports/DangerousGoodsDescriptionAndAdvanceNoticeCommons/Create |
危険物明細書・危険物又は有害物事前連絡表 共通帳票を作成します。 危険物明細書・危険物又は有害物事前連絡表 共通帳票を作成するには、利用者が危険物又は有害物事前連絡票を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 危険物明細書・危険物又は有害物事前連絡表 共通帳票に関する詳細については、[危険物明細書・危険物又は有害物事前連絡表 共通帳票について]()を参照ください。 |
|
DELETE | /API/v2/Reports/DangerousGoodsDescriptionAndAdvanceNoticeCommons/Delete/{reportId} |
危険物明細書・危険物又は有害物事前連絡表 共通帳票を削除します。 帳票ID(***reportId***)を指定して、危険物明細書・危険物又は有害物事前連絡表 共通帳票を削除します。 危険物明細書・危険物又は有害物事前連絡表 共通帳票を削除しても、ルートドキュメントの内容までは削除されません。 申請種別を使用して、作成した危険物明細書・危険物又は有害物事前連絡表 共通帳票のキャンセルを伝える場合は、キャンセル(***Cancel***)を実施後、帳票の提出(***Submit***)を実施してください。 危険物明細書・危険物又は有害物事前連絡表 共通帳票に関する詳細については、[危険物明細書・危険物又は有害物事前連絡表 共通帳票について]()を参照ください。 |
|
DELETE | /API/v2/Reports/DangerousGoodsDescriptionAndAdvanceNoticeCommons/DeleteFile/{fileId} |
危険物明細書・危険物又は有害物事前連絡表 共通帳票の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、危険物明細書・危険物又は有害物事前連絡表 共通帳票の添付ファイルを削除します。 帳票の添付ファイルを削除できるのは、そのファイルを添付したパートナーに所属している利用者だけです。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
GET | /API/v2/Reports/DangerousGoodsDescriptionAndAdvanceNoticeCommons/Get/{reportId} |
危険物明細書・危険物又は有害物事前連絡表 共通帳票を取得します。 帳票ID(***reportId***)を指定して、危険物明細書・危険物又は有害物事前連絡表 共通帳票を取得します。 編集が行われていない場合は、ルートドキュメントから最新のブッキング依頼書を取得します。 編集中の場合は、先に保存した、危険物明細書・危険物又は有害物事前連絡表 共通帳票を取得します。 危険物明細書・危険物又は有害物事前連絡表 共通帳票に関する詳細については、[危険物明細書・危険物又は有害物事前連絡表 共通帳票について]()を参照ください。 |
|
GET | /API/v2/Reports/DangerousGoodsDescriptionAndAdvanceNoticeCommons/GetFile/{fileId} |
危険物明細書・危険物又は有害物事前連絡表 共通帳票に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、危険物明細書・危険物又は有害物事前連絡表 共通帳票に添付されたファイルを取得します。 帳票の添付ファイルを獲得できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
GET | /API/v2/Reports/DangerousGoodsDescriptionAndAdvanceNoticeCommons/GetList?tradeNo=!{tradeNo}&uniqueNo=!{uniqueNo}&bookingNo=!{bookingNo}&blNo=!{blNo} |
危険物明細書・危険物又は有害物事前連絡表 共通帳票を全て取得します。 検索条件に該当する危険物明細書・危険物又は有害物事前連絡表 共通帳票を全て取得します。 編集が行われていない場合は、ルートドキュメントから最新の危険物明細書・危険物又は有害物事前連絡表 共通帳票を取得します。 編集中の場合は、先に保存した、危険物明細書・危険物又は有害物事前連絡表 共通帳票を取得します。 危険物明細書・危険物又は有害物事前連絡表 共通帳票に関する詳細については、[危険物明細書・危険物又は有害物事前連絡表 共通帳票について]()を参照ください。 |
|
PATCH | /API/v2/Reports/DangerousGoodsDescriptionAndAdvanceNoticeCommons/Lock/{reportId} |
編集するため、危険物明細書・危険物又は有害物事前連絡表 共通帳票をロックします 帳票ID(***reportId***)を指定して、危険物明細書・危険物又は有害物事前連絡表 共通帳票をロックします。 危険物明細書・危険物又は有害物事前連絡表 共通帳票を作成(***Create***)した時点では、危険物明細書・危険物又は有害物事前連絡表 共通帳票をロックが掛かりますが、取得(***Get***)したあとで、危険物明細書・危険物又は有害物事前連絡表 共通帳票を編集する場合は、このメソッドを呼び出して、危険物明細書・危険物又は有害物事前連絡表 共通帳票をロックします。 ロックされた危険物明細書・危険物又は有害物事前連絡表 共通帳票は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、危険物明細書・危険物又は有害物事前連絡表 共通帳票をルートドキュメントから参照できますが、編集中(ロック中)の危険物明細書・危険物又は有害物事前連絡表 共通帳票は参照できません。 このロックは、アンロック(***Unlock***)を呼び出すか、帳票の保存後、帳票の提出(***Submit****)を行うと解除されます。 危険物又は有害物事前連絡票に関する詳細については、[危険物又は有害物事前連絡票について]()を参照ください。 |
|
PATCH | /API/v2/Reports/DangerousGoodsDescriptionAndAdvanceNoticeCommons/SetCancel/{reportId} |
危険物明細書・危険物又は有害物事前連絡表 共通帳票の申請種別をキャンセルします 帳票ID(***reportId***)を指定して、危険物明細書・危険物又は有害物事前連絡表 共通帳票の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 危険物明細書・危険物又は有害物事前連絡表 共通帳票に関する詳細については、[危険物明細書・危険物又は有害物事前連絡表 共通帳票について]()を参照ください。 |
|
PATCH | /API/v2/Reports/DangerousGoodsDescriptionAndAdvanceNoticeCommons/Submit/{reportId} |
危険物明細書・危険物又は有害物事前連絡表 共通帳票を提出します 帳票ID(***reportId***)を指定して、更新(***Update***)したブッキング依頼書を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、危険物明細書・危険物又は有害物事前連絡表 共通帳票が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、危険物明細書・危険物又は有害物事前連絡表 共通帳票もロックされた状態のままなので、ご注意ください。 危険物明細書・危険物又は有害物事前連絡表 共通帳票に関する詳細については、[危険物明細書・危険物又は有害物事前連絡表 共通帳票について]()を参照ください。 |
|
PATCH | /API/v2/Reports/DangerousGoodsDescriptionAndAdvanceNoticeCommons/Unlock/{reportId} |
危険物明細書・危険物又は有害物事前連絡表 共通帳票のロックを解除します 帳票ID(***reportId***)を指定して、危険物明細書・危険物又は有害物事前連絡表 共通帳票のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 危険物明細書・危険物又は有害物事前連絡表 共通帳票に関する詳細については、[危険物明細書・危険物又は有害物事前連絡表 共通帳票について]()を参照ください。 |
|
PATCH | /API/v2/Reports/DangerousGoodsDescriptionAndAdvanceNoticeCommons/Update/{reportId} |
危険物明細書・危険物又は有害物事前連絡表 共通帳票を更新します。 帳票ID(***reportId***)を指定して、危険物明細書・危険物又は有害物事前連絡表 共通帳票を更新します。 このメソッドでは、危険物明細書・危険物又は有害物事前連絡表 共通帳票の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 危険物明細書・危険物又は有害物事前連絡表 共通帳票に関する詳細については、[危険物明細書・危険物又は有害物事前連絡表 共通帳票について]()を参照ください。 |
|
POST | /API/v2/Reports/DangerousGoodsDescriptionAndAdvanceNoticeCommons/UploadFile |
危険物明細書・危険物又は有害物事前連絡表 共通帳票にファイルを添付します。 指定された危険物明細書・危険物又は有害物事前連絡表 共通帳票に、ファイルを添付します。 帳票にファイルを添付できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
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でのレスポンスデータを編集し、指定するようにしてください。 |
DangerousGoodsDescriptions
危険物明細書
API | Description | ||
---|---|---|---|
POST | /API/v2/Reports/DangerousGoodsDescriptions/Create |
危険物明細書を作成します。 危険物明細書を作成するには、利用者が危険物明細書を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 危険物明細書に関する詳細については、[危険物明細書について]()を参照ください。 |
|
DELETE | /API/v2/Reports/DangerousGoodsDescriptions/Delete/{reportId} |
危険物明細書を削除します。 帳票ID(***reportId***)を指定して、危険物明細書を削除します。 危険物明細書を削除しても、ルートドキュメントの内容までは削除されません。 申請種別を使用して、作成した危険物明細書のキャンセルを伝える場合は、キャンセル(***Cancel***)を実施後、帳票の提出(***Submit***)を実施してください。 危険物明細書に関する詳細については、[危険物明細書について]()を参照ください。 |
|
DELETE | /API/v2/Reports/DangerousGoodsDescriptions/DeleteFile/{fileId} |
危険物明細書の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、危険物明細書の添付ファイルを削除します。 帳票の添付ファイルを削除できるのは、そのファイルを添付したパートナーに所属している利用者だけです。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
GET | /API/v2/Reports/DangerousGoodsDescriptions/Get/{reportId} |
危険物明細書を取得します。 帳票ID(***reportId***)を指定して、危険物明細書を取得します。 編集が行われていない場合は、ルートドキュメントから最新のブッキング依頼書を取得します。 編集中の場合は、先に保存した、危険物明細書を取得します。 危険物明細書に関する詳細については、[危険物明細書について]()を参照ください。 |
|
GET | /API/v2/Reports/DangerousGoodsDescriptions/GetFile/{fileId} |
危険物明細書に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、危険物明細書に添付されたファイルを取得します。 帳票の添付ファイルを獲得できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
GET | /API/v2/Reports/DangerousGoodsDescriptions/GetList?tradeNo=!{tradeNo}&uniqueNo=!{uniqueNo}&bookingNo=!{bookingNo}&blNo=!{blNo} |
危険物明細書を全て取得します。 検索条件に該当する危険物明細書を全て取得します。 編集が行われていない場合は、ルートドキュメントから最新の危険物明細書を取得します。 編集中の場合は、先に保存した、危険物明細書を取得します。 危険物明細書に関する詳細については、[危険物明細書について]()を参照ください。 |
|
PATCH | /API/v2/Reports/DangerousGoodsDescriptions/Lock/{reportId} |
編集するため、危険物明細書をロックします 帳票ID(***reportId***)を指定して、危険物明細書をロックします。 危険物明細書を作成(***Create***)した時点では、危険物明細書をロックが掛かりますが、取得(***Get***)したあとで、危険物明細書を編集する場合は、このメソッドを呼び出して、ブッキング依頼書をロックします。 ロックされた危険物明細書は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、危険物明細書をルートドキュメントから参照できますが、編集中(ロック中)の危険物明細書は参照できません。 このロックは、アンロック(***Unlock***)を呼び出すか、帳票の保存後、帳票の提出(***Submit****)を行うと解除されます。 危険物明細書に関する詳細については、[危険物明細書について]()を参照ください。 |
|
PATCH | /API/v2/Reports/DangerousGoodsDescriptions/SetCancel/{reportId} |
危険物明細書の申請種別をキャンセルします 帳票ID(***reportId***)を指定して、危険物明細書の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 危険物明細書に関する詳細については、[危険物明細書について]()を参照ください。 |
|
PATCH | /API/v2/Reports/DangerousGoodsDescriptions/Submit/{reportId} |
危険物明細書を提出します 帳票ID(***reportId***)を指定して、更新(***Update***)したブッキング依頼書を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、危険物明細書が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ブッキング依頼書もロックされた状態のままなので、ご注意ください。 危険物明細書に関する詳細については、[危険物明細書について]()を参照ください。 |
|
PATCH | /API/v2/Reports/DangerousGoodsDescriptions/Unlock/{reportId} |
危険物明細書のロックを解除します 帳票ID(***reportId***)を指定して、危険物明細書のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 危険物明細書に関する詳細については、[危険物明細書について]()を参照ください。 |
|
PATCH | /API/v2/Reports/DangerousGoodsDescriptions/Update/{reportId} |
危険物明細書を更新します。 帳票ID(***reportId***)を指定して、危険物明細書を更新します。 このメソッドでは、危険物明細書の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 危険物明細書に関する詳細については、[危険物明細書について]()を参照ください。 |
|
POST | /API/v2/Reports/DangerousGoodsDescriptions/UploadFile |
危険物明細書にファイルを添付します。 指定された危険物明細書に、ファイルを添付します。 帳票にファイルを添付できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
DangerousGoodsDetailsConfirmCalls
DDC11
API | Description | ||
---|---|---|---|
POST | /API/v1/NaccsReport/DangerousGoodsDetailsConfirmCalls/Create |
帳票:DDC11を作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 帳票:DDC11が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/NaccsReport/DangerousGoodsDetailsConfirmCalls/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:DDC11を削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
GET | /API/v1/NaccsReport/DangerousGoodsDetailsConfirmCalls/Get/{dealReportId} |
帳票:DDC11を取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/NaccsReport/DangerousGoodsDetailsConfirmCalls/GetAttachFileMetaList/{dealReportId} |
添付ファイル情報一覧を取得します。 |
|
POST | /API/v1/NaccsReport/DangerousGoodsDetailsConfirmCalls/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/DangerousGoodsDetailsConfirmCalls/Register |
帳票:DDC11を保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
DangerousGoodsDetailsConfirms
DDC
API | Description | ||
---|---|---|---|
POST | /API/v1/NaccsReport/DangerousGoodsDetailsConfirms/Create |
帳票:DDCを作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 帳票:DDCが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/NaccsReport/DangerousGoodsDetailsConfirms/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:DDCを削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
GET | /API/v1/NaccsReport/DangerousGoodsDetailsConfirms/Get/{dealReportId} |
帳票:DDCを取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/NaccsReport/DangerousGoodsDetailsConfirms/GetAttachFileMetaList/{dealReportId} |
添付ファイル情報一覧を取得します。 |
|
POST | /API/v1/NaccsReport/DangerousGoodsDetailsConfirms/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/DangerousGoodsDetailsConfirms/Register |
帳票:DDCを保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
DangerousGoodsDetailsInquiries
IDR
API | Description | ||
---|---|---|---|
POST | /API/v1/NaccsReport/DangerousGoodsDetailsInquiries/Create |
帳票:IDRを作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 帳票:IDRが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/NaccsReport/DangerousGoodsDetailsInquiries/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:IDRを削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
GET | /API/v1/NaccsReport/DangerousGoodsDetailsInquiries/Get/{dealReportId} |
帳票:IDRを取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/NaccsReport/DangerousGoodsDetailsInquiries/GetAttachFileMetaList/{dealReportId} |
添付ファイル情報一覧を取得します。 |
|
POST | /API/v1/NaccsReport/DangerousGoodsDetailsInquiries/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/DangerousGoodsDetailsInquiries/Register |
帳票:IDRを保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
DangerousGoodsDetailsReceptionCalls
DCR11
API | Description | ||
---|---|---|---|
POST | /API/v1/NaccsReport/DangerousGoodsDetailsReceptionCalls/Create |
帳票:DCR11を作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 帳票:DCR11が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/NaccsReport/DangerousGoodsDetailsReceptionCalls/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:DCR11を削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
GET | /API/v1/NaccsReport/DangerousGoodsDetailsReceptionCalls/Get/{dealReportId} |
帳票:DCR11を取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/NaccsReport/DangerousGoodsDetailsReceptionCalls/GetAttachFileMetaList/{dealReportId} |
添付ファイル情報一覧を取得します。 |
|
POST | /API/v1/NaccsReport/DangerousGoodsDetailsReceptionCalls/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/DangerousGoodsDetailsReceptionCalls/Register |
帳票:DCR11を保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
DangerousGoodsDetailsReceptions
DCR
API | Description | ||
---|---|---|---|
POST | /API/v1/NaccsReport/DangerousGoodsDetailsReceptions/Create |
帳票:DCRを作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 帳票:DCRが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/NaccsReport/DangerousGoodsDetailsReceptions/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:DCRを削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
GET | /API/v1/NaccsReport/DangerousGoodsDetailsReceptions/Get/{dealReportId} |
帳票:DCRを取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/NaccsReport/DangerousGoodsDetailsReceptions/GetAttachFileMetaList/{dealReportId} |
添付ファイル情報一覧を取得します。 |
|
POST | /API/v1/NaccsReport/DangerousGoodsDetailsReceptions/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/DangerousGoodsDetailsReceptions/Register |
帳票:DCRを保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
DangerousGoodsDetailsRegistrationCalls
DDR11
API | Description | ||
---|---|---|---|
POST | /API/v1/NaccsReport/DangerousGoodsDetailsRegistrationCalls/Create |
帳票:DDR11を作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 帳票:DDR11が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/NaccsReport/DangerousGoodsDetailsRegistrationCalls/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:DDR11を削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
GET | /API/v1/NaccsReport/DangerousGoodsDetailsRegistrationCalls/Get/{dealReportId} |
帳票:DDR11を取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/NaccsReport/DangerousGoodsDetailsRegistrationCalls/GetAttachFileMetaList/{dealReportId} |
添付ファイル情報一覧を取得します。 |
|
POST | /API/v1/NaccsReport/DangerousGoodsDetailsRegistrationCalls/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/DangerousGoodsDetailsRegistrationCalls/Register |
帳票:DDR11を保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
DangerousGoodsDetailsRegistrationNotifications
DDR01
API | Description | ||
---|---|---|---|
POST | /API/v1/NaccsReport/DangerousGoodsDetailsRegistrationNotifications/Create |
帳票:DDR01を作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 |
|
DELETE | /API/v1/NaccsReport/DangerousGoodsDetailsRegistrationNotifications/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:DDR01を削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
GET | /API/v1/NaccsReport/DangerousGoodsDetailsRegistrationNotifications/Get/{dealReportId} |
帳票:DDR01を取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/NaccsReport/DangerousGoodsDetailsRegistrationNotifications/GetAttachFileMetaList/{dealReportId} |
添付ファイル情報一覧を取得します。 |
|
POST | /API/v1/NaccsReport/DangerousGoodsDetailsRegistrationNotifications/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識別番号で無い場合エラーとなります。 ### 検索条件項目 呼出業務、照会業務の場合は、業務毎に必要なパラメータを指定します。 指定したパラメータから電文が生成されます。 未指定の場合は空白埋めとなります。 ### 索引引継情報(登録業務継続処理対象) 索引引継情報を直接指定する場合は、索引引継情報(***indexTakeOverInfo***)を指定します。 CyberPortに蓄積されているデータより索引引継情報を設定する場合は以下の項目に値を設定して下さい。 ・索引引継情報検索キー_NACCS業務コード(***indexTakeOverInfoSerchKeyNaccsBusinessCode***) ・索引引継情報検索キー_NACCS出力情報コード(***indexTakeOverInfoSerchKeyNaccsOutputInfoCode***) ・索引引継情報検索キー_入力特定番号(***indexTakeOverInfoSerchKeyInputInfoSpecificNo***) ## 取引外照会について 取引外照会を行う場合、以下項目を空文字を指定してください ・取引管理番号(***dealNo***) ・取引・帳票ID(***dealReportId***) |
|
POST | /API/v1/NaccsReport/DangerousGoodsDetailsRegistrationNotifications/Register |
帳票:DDR01を保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
DangerousGoodsDetailsRegistrations
DDR
API | Description | ||
---|---|---|---|
POST | /API/v1/NaccsReport/DangerousGoodsDetailsRegistrations/Create |
帳票:DDRを作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 帳票:DDRが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/NaccsReport/DangerousGoodsDetailsRegistrations/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:DDRを削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
GET | /API/v1/NaccsReport/DangerousGoodsDetailsRegistrations/Get/{dealReportId} |
帳票:DDRを取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/NaccsReport/DangerousGoodsDetailsRegistrations/GetAttachFileMetaList/{dealReportId} |
添付ファイル情報一覧を取得します。 |
|
POST | /API/v1/NaccsReport/DangerousGoodsDetailsRegistrations/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/DangerousGoodsDetailsRegistrations/Register |
帳票:DDRを保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対して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でのレスポンスデータを編集し、指定するようにしてください。 |
DeliveryConfirmationRequests
搬入確認依頼票
API | Description | ||
---|---|---|---|
POST | /API/v2/Reports/DeliveryConfirmationRequests/Create |
搬入確認依頼票を作成します。 搬入確認依頼票を作成するには、利用者が搬入確認依頼票を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 搬入確認依頼票に関する詳細については、[搬入確認依頼票について]()を参照ください。 |
|
DELETE | /API/v2/Reports/DeliveryConfirmationRequests/Delete/{reportId} |
搬入確認依頼票を削除します。 帳票ID(***reportId***)を指定して、搬入確認依頼票を削除します。 搬入確認依頼票を削除しても、ルートドキュメントの内容までは削除されません。 申請種別を使用して、作成した搬入確認依頼票のキャンセルを伝える場合は、キャンセル(***Cancel***)を実施後、帳票の提出(***Submit***)を実施してください。 搬入確認依頼票に関する詳細については、[搬入確認依頼票について]()を参照ください。 |
|
DELETE | /API/v2/Reports/DeliveryConfirmationRequests/DeleteFile/{fileId} |
搬入確認依頼票の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、搬入確認依頼票の添付ファイルを削除します。 帳票の添付ファイルを削除できるのは、そのファイルを添付したパートナーに所属している利用者だけです。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
GET | /API/v2/Reports/DeliveryConfirmationRequests/Get/{reportId} |
搬入確認依頼票を取得します。 帳票ID(***reportId***)を指定して、搬入確認依頼票を取得します。 編集が行われていない場合は、ルートドキュメントから最新の搬入確認依頼票を取得します。 編集中の場合は、先に保存した、搬入確認依頼票を取得します。 搬入確認依頼票に関する詳細については、[搬入確認依頼票について]()を参照ください。 |
|
GET | /API/v2/Reports/DeliveryConfirmationRequests/GetFile/{fileId} |
搬入確認依頼票に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、搬入確認依頼票に添付されたファイルを取得します。 帳票の添付ファイルを獲得できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
GET | /API/v2/Reports/DeliveryConfirmationRequests/GetList?tradeNo=!{tradeNo}&uniqueNo=!{uniqueNo}&bookingNo=!{bookingNo}&blNo=!{blNo} |
搬入確認依頼票を全て取得します。 検索条件に該当する搬入確認依頼票を全て取得します。 編集が行われていない場合は、ルートドキュメントから最新の搬入確認依頼票を取得します。 編集中の場合は、先に保存した、搬入確認依頼票を取得します。 搬入確認依頼票に関する詳細については、[搬入確認依頼票について]()を参照ください。 |
|
PATCH | /API/v2/Reports/DeliveryConfirmationRequests/Lock/{reportId} |
編集するため、搬入確認依頼票をロックします 帳票ID(***reportId***)を指定して、搬入確認依頼票をロックします。 搬入確認依頼票を作成(***Create***)した時点では、搬入確認依頼票をロックが掛かりますが、取得(***Get***)したあとで、搬入確認依頼票を編集する場合は、このメソッドを呼び出して、搬入確認依頼票をロックします。 ロックされた搬入確認依頼票は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、搬入確認依頼票をルートドキュメントから参照できますが、編集中(ロック中)のブッキング依頼書は参照できません。 このロックは、アンロック(***Unlock***)を呼び出すか、帳票の保存後、帳票の提出(***Submit****)を行うと解除されます。 搬入確認依頼票に関する詳細については、[搬入確認依頼票について]()を参照ください。 |
|
PATCH | /API/v2/Reports/DeliveryConfirmationRequests/SetCancel/{reportId} |
搬入確認依頼票の申請種別をキャンセルします 帳票ID(***reportId***)を指定して、搬入確認依頼票の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 搬入確認依頼票に関する詳細については、[搬入確認依頼票について]()を参照ください。 |
|
PATCH | /API/v2/Reports/DeliveryConfirmationRequests/Submit/{reportId} |
搬入確認依頼票を提出します 帳票ID(***reportId***)を指定して、更新(***Update***)した搬入確認依頼票を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、搬入確認依頼票が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、搬入確認依頼票もロックされた状態のままなので、ご注意ください。 搬入確認依頼票に関する詳細については、[搬入確認依頼票について]()を参照ください。 |
|
PATCH | /API/v2/Reports/DeliveryConfirmationRequests/Unlock/{reportId} |
搬入確認依頼票のロックを解除します 帳票ID(***reportId***)を指定して、搬入確認依頼票のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 搬入確認依頼票に関する詳細については、[搬入確認依頼票について]()を参照ください。 |
|
PATCH | /API/v2/Reports/DeliveryConfirmationRequests/Update/{reportId} |
搬入確認依頼票を更新します。 帳票ID(***reportId***)を指定して、搬入確認依頼票を更新します。 このメソッドでは、搬入確認依頼票の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 搬入確認依頼票に関する詳細については、[搬入確認依頼票について]()を参照ください。 |
|
POST | /API/v2/Reports/DeliveryConfirmationRequests/UploadFile |
搬入確認依頼票にファイルを添付します。 指定された搬入確認依頼票に、ファイルを添付します。 帳票にファイルを添付できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
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でのレスポンスデータを編集し、指定するようにしてください。 |
DeliveryDocuments
貨物輸送送り状
API | Description | ||
---|---|---|---|
POST | /API/v2/Reports/DeliveryDocuments/Create |
貨物輸送送り状を作成します。 貨物輸送送り状を作成するには、利用者が貨物輸送送り状を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 貨物輸送送り状に関する詳細については、[貨物輸送送り状について]()を参照ください。 |
|
DELETE | /API/v2/Reports/DeliveryDocuments/Delete/{reportId} |
貨物輸送送り状を削除します。 帳票ID(***reportId***)を指定して、貨物輸送送り状を削除します。 貨物輸送送り状を削除しても、ルートドキュメントの内容までは削除されません。 申請種別を使用して、作成したCFS搬出票のキャンセルを伝える場合は、キャンセル(***Cancel***)を実施後、帳票の提出(***Submit***)を実施してください。 貨物輸送送り状に関する詳細については、[貨物輸送送り状について]()を参照ください。 |
|
DELETE | /API/v2/Reports/DeliveryDocuments/DeleteFile/{fileId} |
貨物輸送送り状の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、貨物輸送送り状の添付ファイルを削除します。 帳票の添付ファイルを削除できるのは、そのファイルを添付したパートナーに所属している利用者だけです。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
GET | /API/v2/Reports/DeliveryDocuments/Get/{reportId} |
貨物輸送送り状を取得します。 帳票ID(***reportId***)を指定して、貨物輸送送り状を取得します。 編集が行われていない場合は、ルートドキュメントから最新の貨物輸送送り状を取得します。 編集中の場合は、先に保存した、貨物輸送送り状を取得します。 貨物輸送送り状に関する詳細については、[貨物輸送送り状について]()を参照ください。 |
|
GET | /API/v2/Reports/DeliveryDocuments/GetFile/{fileId} |
貨物輸送送り状に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、貨物輸送送り状に添付されたファイルを取得します。 帳票の添付ファイルを獲得できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
GET | /API/v2/Reports/DeliveryDocuments/GetList?tradeNo=!{tradeNo}&uniqueNo=!{uniqueNo}&bookingNo=!{bookingNo}&blNo=!{blNo} |
貨物輸送送り状を全て取得します。 検索条件に該当する貨物輸送送り状を全て取得します。 編集が行われていない場合は、ルートドキュメントから最新の貨物輸送送り状を取得します。 編集中の場合は、先に保存した、貨物輸送送り状を取得します。 貨物輸送送り状に関する詳細については、[貨物輸送送り状について]()を参照ください。 |
|
PATCH | /API/v2/Reports/DeliveryDocuments/Lock/{reportId} |
編集するため、貨物輸送送り状をロックします 帳票ID(***reportId***)を指定して、貨物輸送送り状をロックします。 貨物輸送送り状を作成(***Create***)した時点では、貨物輸送送り状をロックが掛かりますが、取得(***Get***)したあとで、貨物輸送送り状を編集する場合は、このメソッドを呼び出して、貨物輸送送り状をロックします。 ロックされた貨物輸送送り状は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、貨物輸送送り状をルートドキュメントから参照できますが、編集中(ロック中)の貨物輸送送り状は参照できません。 このロックは、アンロック(***Unlock***)を呼び出すか、帳票の保存後、帳票の提出(***Submit****)を行うと解除されます。 貨物輸送送り状に関する詳細については、[貨物輸送送り状について]()を参照ください。 |
|
PATCH | /API/v2/Reports/DeliveryDocuments/SetCancel/{reportId} |
貨物輸送送り状の申請種別をキャンセルします 帳票ID(***reportId***)を指定して、貨物輸送送り状の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 貨物輸送送り状に関する詳細については、[貨物輸送送り状について]()を参照ください。 |
|
PATCH | /API/v2/Reports/DeliveryDocuments/Submit/{reportId} |
貨物輸送送り状を提出します 帳票ID(***reportId***)を指定して、更新(***Update***)した貨物輸送送り状を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、貨物輸送送り状が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、コンテナ貨物搬入票もロックされた状態のままなので、ご注意ください。 貨物輸送送り状に関する詳細については、[貨物輸送送り状について]()を参照ください。 |
|
PATCH | /API/v2/Reports/DeliveryDocuments/Unlock/{reportId} |
貨物輸送送り状のロックを解除します 帳票ID(***reportId***)を指定して、貨物輸送送り状のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 貨物輸送送り状に関する詳細については、[貨物輸送送り状について]()を参照ください。 |
|
PATCH | /API/v2/Reports/DeliveryDocuments/Update/{reportId} |
貨物輸送送り状を更新します。 帳票ID(***reportId***)を指定して、貨物輸送送り状を更新します。 このメソッドでは、貨物輸送送り状の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 貨物輸送送り状に関する詳細については、[貨物輸送送り状について]()を参照ください。 |
|
POST | /API/v2/Reports/DeliveryDocuments/UploadFile |
貨物輸送送り状にファイルを添付します。 指定された貨物輸送送り状に、ファイルを添付します。 帳票にファイルを添付できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
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でのレスポンスデータを編集し、指定するようにしてください。 |
DeliveryInstructions-EmptyContainerDelivery
運送依頼書(空コンテナ返却)
API | Description | ||
---|---|---|---|
POST | /API/v2/Reports/DeliveryInstructions-EmptyContainerDelivery/Create |
運送依頼書(空コンテナ返却)を作成します。 運送依頼書(空コンテナ返却)を作成するには、利用者が運送依頼書(空コンテナ返却)を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 運送依頼書(空コンテナ返却)に関する詳細については、[運送依頼書(空コンテナ返却)について]()を参照ください。 |
|
DELETE | /API/v2/Reports/DeliveryInstructions-EmptyContainerDelivery/Delete/{reportId} |
運送依頼書(空コンテナ返却)を削除します。 帳票ID(***reportId***)を指定して、運送依頼書(空コンテナ返却)を削除します。 運送依頼書(空コンテナ返却)を削除しても、ルートドキュメントの内容までは削除されません。 申請種別を使用して、作成した運送依頼書(空コンテナ返却)のキャンセルを伝える場合は、キャンセル(***Cancel***)を実施後、帳票の提出(***Submit***)を実施してください。 運送依頼書(空コンテナ返却)に関する詳細については、[運送依頼書(空コンテナ返却)について]()を参照ください。 |
|
DELETE | /API/v2/Reports/DeliveryInstructions-EmptyContainerDelivery/DeleteFile/{fileId} |
運送依頼書(空コンテナ返却)の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、運送依頼書(空コンテナ返却)の添付ファイルを削除します。 帳票の添付ファイルを削除できるのは、そのファイルを添付したパートナーに所属している利用者だけです。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
GET | /API/v2/Reports/DeliveryInstructions-EmptyContainerDelivery/Get/{reportId} |
運送依頼書(空コンテナ返却)を取得します。 帳票ID(***reportId***)を指定して、運送依頼書(空コンテナ返却)を取得します。 編集が行われていない場合は、ルートドキュメントから最新の運送依頼書(空コンテナ返却)を取得します。 編集中の場合は、先に保存した、運送依頼書(空コンテナ返却)を取得します。 運送依頼書(空コンテナ返却)に関する詳細については、[運送依頼書(空コンテナ返却)について]()を参照ください。 |
|
GET | /API/v2/Reports/DeliveryInstructions-EmptyContainerDelivery/GetFile/{fileId} |
運送依頼書(空コンテナ返却)に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、運送依頼書(空コンテナ返却)に添付されたファイルを取得します。 帳票の添付ファイルを獲得できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
GET | /API/v2/Reports/DeliveryInstructions-EmptyContainerDelivery/GetList?tradeNo=!{tradeNo}&uniqueNo=!{uniqueNo}&bookingNo=!{bookingNo}&blNo=!{blNo} |
運送依頼書(空コンテナ返却)を全て取得します。 検索条件に該当する運送依頼書(空コンテナ返却)を全て取得します。 編集が行われていない場合は、ルートドキュメントから最新の運送依頼書(空コンテナ返却)を取得します。 編集中の場合は、先に保存した、運送依頼書(空コンテナ返却)を取得します。 運送依頼書(空コンテナ返却)に関する詳細については、[運送依頼書(空コンテナ返却)について]()を参照ください。 |
|
PATCH | /API/v2/Reports/DeliveryInstructions-EmptyContainerDelivery/Lock/{reportId} |
編集するため、運送依頼書(空コンテナ返却)をロックします 帳票ID(***reportId***)を指定して、運送依頼書(空コンテナ返却)をロックします。 運送依頼書(空コンテナ返却)を作成(***Create***)した時点では、運送依頼書(空コンテナ返却)をロックが掛かりますが、取得(***Get***)したあとで、運送依頼書(空コンテナ返却)を編集する場合は、このメソッドを呼び出して、運送依頼書(空コンテナ返却)をロックします。 ロックされた運送依頼書(空コンテナ返却)は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、運送依頼書(空コンテナ返却)をルートドキュメントから参照できますが、編集中(ロック中)の運送依頼書(空コンテナ返却)は参照できません。 このロックは、アンロック(***Unlock***)を呼び出すか、帳票の保存後、帳票の提出(***Submit****)を行うと解除されます。 運送依頼書(空コンテナ返却)に関する詳細については、[運送依頼書(空コンテナ返却)について]()を参照ください。 |
|
PATCH | /API/v2/Reports/DeliveryInstructions-EmptyContainerDelivery/SetCancel/{reportId} |
運送依頼書(空コンテナ返却)の申請種別をキャンセルします 帳票ID(***reportId***)を指定して、運送依頼書(空コンテナ返却)の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 運送依頼書(空コンテナ返却)に関する詳細については、[運送依頼書(空コンテナ返却)について]()を参照ください。 |
|
PATCH | /API/v2/Reports/DeliveryInstructions-EmptyContainerDelivery/Submit/{reportId} |
運送依頼書(空コンテナ返却)を提出します 帳票ID(***reportId***)を指定して、更新(***Update***)した運送依頼書(空コンテナ返却)を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、運送依頼書(空コンテナ返却)が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、運送依頼書(空コンテナ返却)もロックされた状態のままなので、ご注意ください。 運送依頼書(空コンテナ返却)に関する詳細については、[運送依頼書(空コンテナ返却)について]()を参照ください。 |
|
PATCH | /API/v2/Reports/DeliveryInstructions-EmptyContainerDelivery/Unlock/{reportId} |
運送依頼書(空コンテナ返却)のロックを解除します 帳票ID(***reportId***)を指定して、運送依頼書(空コンテナ返却)のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 運送依頼書(空コンテナ返却)に関する詳細については、[運送依頼書(空コンテナ返却)について]()を参照ください。 |
|
PATCH | /API/v2/Reports/DeliveryInstructions-EmptyContainerDelivery/Update/{reportId} |
運送依頼書(空コンテナ返却)を更新します。 帳票ID(***reportId***)を指定して、運送依頼書(空コンテナ返却)を更新します。 このメソッドでは、運送依頼書(空コンテナ返却)の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 運送依頼書(空コンテナ返却)に関する詳細については、[運送依頼書(空コンテナ返却)について]()を参照ください。 |
|
POST | /API/v2/Reports/DeliveryInstructions-EmptyContainerDelivery/UploadFile |
運送依頼書(空コンテナ返却)にファイルを添付します。 指定された運送依頼書(空コンテナ返却)に、ファイルを添付します。 帳票にファイルを添付できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
DeliveryInstructions-EmptyContainerPickup
運送依頼書(空コンテナ搬出)
API | Description | ||
---|---|---|---|
POST | /API/v2/Reports/DeliveryInstructions-EmptyContainerPickup/Create |
運送依頼書(空コンテナ搬出)を作成します。 運送依頼書(空コンテナ搬出)を作成するには、利用者が運送依頼書(空コンテナ搬出)を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 運送依頼書(空コンテナ搬出)に関する詳細については、[運送依頼書(空コンテナ搬出)について]()を参照ください。 |
|
DELETE | /API/v2/Reports/DeliveryInstructions-EmptyContainerPickup/Delete/{reportId} |
運送依頼書(空コンテナ搬出)を削除します。 帳票ID(***reportId***)を指定して、運送依頼書(空コンテナ搬出)を削除します。 運送依頼書(空コンテナ搬出)を削除しても、ルートドキュメントの内容までは削除されません。 申請種別を使用して、作成した運送依頼書(空コンテナ搬出)のキャンセルを伝える場合は、キャンセル(***Cancel***)を実施後、帳票の提出(***Submit***)を実施してください。 運送依頼書(空コンテナ搬出)に関する詳細については、[運送依頼書(空コンテナ搬出)について]()を参照ください。 |
|
DELETE | /API/v2/Reports/DeliveryInstructions-EmptyContainerPickup/DeleteFile/{fileId} |
運送依頼書(空コンテナ搬出)の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、運送依頼書(空コンテナ搬出)の添付ファイルを削除します。 帳票の添付ファイルを削除できるのは、そのファイルを添付したパートナーに所属している利用者だけです。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
GET | /API/v2/Reports/DeliveryInstructions-EmptyContainerPickup/Get/{reportId} |
運送依頼書(空コンテナ搬出)を取得します。 帳票ID(***reportId***)を指定して、運送依頼書(空コンテナ搬出)を取得します。 編集が行われていない場合は、ルートドキュメントから最新の運送依頼書(空コンテナ搬出)を取得します。 編集中の場合は、先に保存した、運送依頼書(空コンテナ搬出)を取得します。 運送依頼書(空コンテナ搬出)に関する詳細については、[運送依頼書(空コンテナ搬出)について]()を参照ください。 |
|
GET | /API/v2/Reports/DeliveryInstructions-EmptyContainerPickup/GetFile/{fileId} |
運送依頼書(空コンテナ搬出)に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、運送依頼書(空コンテナ搬出)に添付されたファイルを取得します。 帳票の添付ファイルを獲得できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
GET | /API/v2/Reports/DeliveryInstructions-EmptyContainerPickup/GetList?tradeNo=!{tradeNo}&uniqueNo=!{uniqueNo}&bookingNo=!{bookingNo}&blNo=!{blNo} |
運送依頼書(空コンテナ搬出)を全て取得します。 検索条件に該当する運送依頼書(空コンテナ搬出)を全て取得します。 編集が行われていない場合は、ルートドキュメントから最新の運送依頼書(空コンテナ搬出)を取得します。 編集中の場合は、先に保存した、運送依頼書(空コンテナ搬出)を取得します。 運送依頼書(空コンテナ搬出)に関する詳細については、[運送依頼書(空コンテナ搬出)について]()を参照ください。 |
|
PATCH | /API/v2/Reports/DeliveryInstructions-EmptyContainerPickup/Lock/{reportId} |
編集するため、運送依頼書(空コンテナ搬出)をロックします 帳票ID(***reportId***)を指定して、運送依頼書(空コンテナ搬出)をロックします。 運送依頼書(空コンテナ搬出)を作成(***Create***)した時点では、運送依頼書(空コンテナ搬出)をロックが掛かりますが、取得(***Get***)したあとで、運送依頼書(空コンテナ搬出)を編集する場合は、このメソッドを呼び出して、運送依頼書(空コンテナ搬出)をロックします。 ロックされた運送依頼書(空コンテナ搬出)は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、運送依頼書(空コンテナ搬出)をルートドキュメントから参照できますが、編集中(ロック中)の運送依頼書(空コンテナ搬出)は参照できません。 このロックは、アンロック(***Unlock***)を呼び出すか、帳票の保存後、帳票の提出(***Submit****)を行うと解除されます。 運送依頼書(空コンテナ搬出)に関する詳細については、[運送依頼書(空コンテナ搬出)について]()を参照ください。 |
|
PATCH | /API/v2/Reports/DeliveryInstructions-EmptyContainerPickup/SetCancel/{reportId} |
運送依頼書(空コンテナ搬出)の申請種別をキャンセルします 帳票ID(***reportId***)を指定して、運送依頼書(空コンテナ搬出)の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 運送依頼書(空コンテナ搬出)に関する詳細については、[運送依頼書(空コンテナ搬出)について]()を参照ください。 |
|
PATCH | /API/v2/Reports/DeliveryInstructions-EmptyContainerPickup/Submit/{reportId} |
運送依頼書(空コンテナ搬出)を提出します 帳票ID(***reportId***)を指定して、更新(***Update***)した運送依頼書(空コンテナ搬出)を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、運送依頼書(空コンテナ搬出)が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、運送依頼書(空コンテナ搬出)もロックされた状態のままなので、ご注意ください。 運送依頼書(空コンテナ搬出)に関する詳細については、[運送依頼書(空コンテナ搬出)について]()を参照ください。 |
|
PATCH | /API/v2/Reports/DeliveryInstructions-EmptyContainerPickup/Unlock/{reportId} |
運送依頼書(空コンテナ搬出)のロックを解除します 帳票ID(***reportId***)を指定して、運送依頼書(空コンテナ搬出)のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 運送依頼書(空コンテナ搬出)に関する詳細については、[運送依頼書(空コンテナ搬出)について]()を参照ください。 |
|
PATCH | /API/v2/Reports/DeliveryInstructions-EmptyContainerPickup/Update/{reportId} |
運送依頼書(空コンテナ搬出)を更新します。 帳票ID(***reportId***)を指定して、運送依頼書(空コンテナ搬出)を更新します。 このメソッドでは、運送依頼書(空コンテナ搬出)の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 運送依頼書(空コンテナ搬出)に関する詳細については、[運送依頼書(空コンテナ搬出)について]()を参照ください。 |
|
POST | /API/v2/Reports/DeliveryInstructions-EmptyContainerPickup/UploadFile |
運送依頼書(空コンテナ搬出)にファイルを添付します。 指定された運送依頼書(空コンテナ搬出)に、ファイルを添付します。 帳票にファイルを添付できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
DeliveryInstructions-LoadedContainerDelivery
運送依頼書(実入りコンテナ搬入)
API | Description | ||
---|---|---|---|
POST | /API/v2/Reports/DeliveryInstructions-LoadedContainerDelivery/Create |
運送依頼書(実入りコンテナ搬入)を作成します。 運送依頼書(実入りコンテナ搬入)を作成するには、利用者が運送依頼書(実入りコンテナ搬入)を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 運送依頼書(実入りコンテナ搬入)に関する詳細については、[運送依頼書(実入りコンテナ搬入)について]()を参照ください。 |
|
DELETE | /API/v2/Reports/DeliveryInstructions-LoadedContainerDelivery/Delete/{reportId} |
運送依頼書(実入りコンテナ搬入)を削除します。 帳票ID(***reportId***)を指定して、運送依頼書(実入りコンテナ搬入)を削除します。 運送依頼書(実入りコンテナ搬入)を削除しても、ルートドキュメントの内容までは削除されません。 申請種別を使用して、作成した運送依頼書(実入りコンテナ搬入)のキャンセルを伝える場合は、キャンセル(***Cancel***)を実施後、帳票の提出(***Submit***)を実施してください。 運送依頼書(実入りコンテナ搬入)に関する詳細については、[運送依頼書(実入りコンテナ搬入)について]()を参照ください。 |
|
DELETE | /API/v2/Reports/DeliveryInstructions-LoadedContainerDelivery/DeleteFile/{fileId} |
運送依頼書(実入りコンテナ搬入)の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、運送依頼書(実入りコンテナ搬入)の添付ファイルを削除します。 帳票の添付ファイルを削除できるのは、そのファイルを添付したパートナーに所属している利用者だけです。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
GET | /API/v2/Reports/DeliveryInstructions-LoadedContainerDelivery/Get/{reportId} |
運送依頼書(実入りコンテナ搬入)を取得します。 帳票ID(***reportId***)を指定して、運送依頼書(実入りコンテナ搬入)を取得します。 編集が行われていない場合は、ルートドキュメントから最新の運送依頼書(実入りコンテナ搬入)を取得します。 編集中の場合は、先に保存した、運送依頼書(実入りコンテナ搬入)を取得します。 運送依頼書(実入りコンテナ搬入)に関する詳細については、[運送依頼書(実入りコンテナ搬入)について]()を参照ください。 |
|
GET | /API/v2/Reports/DeliveryInstructions-LoadedContainerDelivery/GetFile/{fileId} |
運送依頼書(実入りコンテナ搬入)に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、運送依頼書(実入りコンテナ搬入)に添付されたファイルを取得します。 帳票の添付ファイルを獲得できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
GET | /API/v2/Reports/DeliveryInstructions-LoadedContainerDelivery/GetList?tradeNo=!{tradeNo}&uniqueNo=!{uniqueNo}&bookingNo=!{bookingNo}&blNo=!{blNo} |
運送依頼書(実入りコンテナ搬入)を全て取得します。 検索条件に該当する運送依頼書(実入りコンテナ搬入)を全て取得します。 編集が行われていない場合は、ルートドキュメントから最新の運送依頼書(実入りコンテナ搬入)を取得します。 編集中の場合は、先に保存した、運送依頼書(実入りコンテナ搬入)を取得します。 運送依頼書(実入りコンテナ搬入)に関する詳細については、[運送依頼書(実入りコンテナ搬入)について]()を参照ください。 |
|
PATCH | /API/v2/Reports/DeliveryInstructions-LoadedContainerDelivery/Lock/{reportId} |
編集するため、運送依頼書(実入りコンテナ搬入)をロックします 帳票ID(***reportId***)を指定して、運送依頼書(実入りコンテナ搬入)をロックします。 運送依頼書(実入りコンテナ搬入)を作成(***Create***)した時点では、運送依頼書(実入りコンテナ搬入)をロックが掛かりますが、取得(***Get***)したあとで、運送依頼書(実入りコンテナ搬入)を編集する場合は、このメソッドを呼び出して、運送依頼書(実入りコンテナ搬入)をロックします。 ロックされた運送依頼書(実入りコンテナ搬入)は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、運送依頼書(実入りコンテナ搬入)をルートドキュメントから参照できますが、編集中(ロック中)の運送依頼書(実入りコンテナ搬入)は参照できません。 このロックは、アンロック(***Unlock***)を呼び出すか、帳票の保存後、帳票の提出(***Submit****)を行うと解除されます。 運送依頼書(実入りコンテナ搬入)に関する詳細については、[運送依頼書(実入りコンテナ搬入)について]()を参照ください。 |
|
PATCH | /API/v2/Reports/DeliveryInstructions-LoadedContainerDelivery/SetCancel/{reportId} |
運送依頼書(実入りコンテナ搬入)の申請種別をキャンセルします 帳票ID(***reportId***)を指定して、運送依頼書(実入りコンテナ搬入)の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 運送依頼書(実入りコンテナ搬入)に関する詳細については、[運送依頼書(実入りコンテナ搬入)について]()を参照ください。 |
|
PATCH | /API/v2/Reports/DeliveryInstructions-LoadedContainerDelivery/Submit/{reportId} |
運送依頼書(実入りコンテナ搬入)を提出します 帳票ID(***reportId***)を指定して、更新(***Update***)した運送依頼書(実入りコンテナ搬入)を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、運送依頼書(実入りコンテナ搬入)が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、運送依頼書(実入りコンテナ搬入)もロックされた状態のままなので、ご注意ください。 運送依頼書(実入りコンテナ搬入)に関する詳細については、[運送依頼書(実入りコンテナ搬入)について]()を参照ください。 |
|
PATCH | /API/v2/Reports/DeliveryInstructions-LoadedContainerDelivery/Unlock/{reportId} |
運送依頼書(実入りコンテナ搬入)のロックを解除します 帳票ID(***reportId***)を指定して、運送依頼書(実入りコンテナ搬入)のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 運送依頼書(実入りコンテナ搬入)に関する詳細については、[運送依頼書(実入りコンテナ搬入)について]()を参照ください。 |
|
PATCH | /API/v2/Reports/DeliveryInstructions-LoadedContainerDelivery/Update/{reportId} |
運送依頼書(実入りコンテナ搬入)を更新します。 帳票ID(***reportId***)を指定して、運送依頼書(実入りコンテナ搬入)を更新します。 このメソッドでは、運送依頼書(実入りコンテナ搬入)の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 運送依頼書(実入りコンテナ搬入)に関する詳細については、[運送依頼書(実入りコンテナ搬入)について]()を参照ください。 |
|
POST | /API/v2/Reports/DeliveryInstructions-LoadedContainerDelivery/UploadFile |
運送依頼書(実入りコンテナ搬入)にファイルを添付します。 指定された運送依頼書(実入りコンテナ搬入)に、ファイルを添付します。 帳票にファイルを添付できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
DeliveryInstructions-LoadedContainerPickup
運送依頼書(実入りコンテナ搬出)
API | Description | ||
---|---|---|---|
POST | /API/v2/Reports/DeliveryInstructions-LoadedContainerPickup/Create |
運送依頼書(実入りコンテナ搬出)を作成します。 運送依頼書(実入りコンテナ搬出)を作成するには、利用者が運送依頼書(実入りコンテナ搬出)を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 運送依頼書(実入りコンテナ搬出)に関する詳細については、[運送依頼書(実入りコンテナ搬出)について]()を参照ください。 |
|
DELETE | /API/v2/Reports/DeliveryInstructions-LoadedContainerPickup/Delete/{reportId} |
運送依頼書(実入りコンテナ搬出)を削除します。 帳票ID(***reportId***)を指定して、運送依頼書(実入りコンテナ搬出)を削除します。 運送依頼書(実入りコンテナ搬出)を削除しても、ルートドキュメントの内容までは削除されません。 申請種別を使用して、作成した運送依頼書(実入りコンテナ搬出)のキャンセルを伝える場合は、キャンセル(***Cancel***)を実施後、帳票の提出(***Submit***)を実施してください。 運送依頼書(実入りコンテナ搬出)に関する詳細については、[運送依頼書(実入りコンテナ搬出)について]()を参照ください。 |
|
DELETE | /API/v2/Reports/DeliveryInstructions-LoadedContainerPickup/DeleteFile/{fileId} |
運送依頼書(実入りコンテナ搬出)の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、運送依頼書(実入りコンテナ搬出)の添付ファイルを削除します。 帳票の添付ファイルを削除できるのは、そのファイルを添付したパートナーに所属している利用者だけです。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
GET | /API/v2/Reports/DeliveryInstructions-LoadedContainerPickup/Get/{reportId} |
運送依頼書(実入りコンテナ搬出)を取得します。 帳票ID(***reportId***)を指定して、運送依頼書(実入りコンテナ搬出)を取得します。 編集が行われていない場合は、ルートドキュメントから最新の運送依頼書(実入りコンテナ搬出)を取得します。 編集中の場合は、先に保存した、運送依頼書(実入りコンテナ搬出)を取得します。 運送依頼書(実入りコンテナ搬出)に関する詳細については、[運送依頼書(実入りコンテナ搬出)について]()を参照ください。 |
|
GET | /API/v2/Reports/DeliveryInstructions-LoadedContainerPickup/GetFile/{fileId} |
運送依頼書(実入りコンテナ搬出)に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、運送依頼書(実入りコンテナ搬出)に添付されたファイルを取得します。 帳票の添付ファイルを獲得できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
GET | /API/v2/Reports/DeliveryInstructions-LoadedContainerPickup/GetList?tradeNo=!{tradeNo}&uniqueNo=!{uniqueNo}&bookingNo=!{bookingNo}&blNo=!{blNo} |
運送依頼書(実入りコンテナ搬出)を全て取得します。 検索条件に該当する運送依頼書(実入りコンテナ搬出)を全て取得します。 編集が行われていない場合は、ルートドキュメントから最新の運送依頼書(実入りコンテナ搬出)を取得します。 編集中の場合は、先に保存した、運送依頼書(実入りコンテナ搬出)を取得します。 運送依頼書(実入りコンテナ搬出)に関する詳細については、[運送依頼書(実入りコンテナ搬出)について]()を参照ください。 |
|
PATCH | /API/v2/Reports/DeliveryInstructions-LoadedContainerPickup/Lock/{reportId} |
編集するため、運送依頼書(実入りコンテナ搬出)をロックします 帳票ID(***reportId***)を指定して、運送依頼書(実入りコンテナ搬出)をロックします。 運送依頼書(実入りコンテナ搬出)を作成(***Create***)した時点では、運送依頼書(実入りコンテナ搬出)をロックが掛かりますが、取得(***Get***)したあとで、運送依頼書(実入りコンテナ搬出)を編集する場合は、このメソッドを呼び出して、運送依頼書(実入りコンテナ搬出)をロックします。 ロックされた運送依頼書(実入りコンテナ搬出)は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、運送依頼書(実入りコンテナ搬出)をルートドキュメントから参照できますが、編集中(ロック中)の運送依頼書(実入りコンテナ搬出)は参照できません。 このロックは、アンロック(***Unlock***)を呼び出すか、帳票の保存後、帳票の提出(***Submit****)を行うと解除されます。 運送依頼書(実入りコンテナ搬出)に関する詳細については、[運送依頼書(実入りコンテナ搬出)について]()を参照ください。 |
|
PATCH | /API/v2/Reports/DeliveryInstructions-LoadedContainerPickup/SetCancel/{reportId} |
運送依頼書(実入りコンテナ搬出)の申請種別をキャンセルします 帳票ID(***reportId***)を指定して、運送依頼書(実入りコンテナ搬出)の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 運送依頼書(実入りコンテナ搬出)に関する詳細については、[運送依頼書(実入りコンテナ搬出)について]()を参照ください。 |
|
PATCH | /API/v2/Reports/DeliveryInstructions-LoadedContainerPickup/Submit/{reportId} |
運送依頼書(実入りコンテナ搬出)を提出します 帳票ID(***reportId***)を指定して、更新(***Update***)した運送依頼書(実入りコンテナ搬出)を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、運送依頼書(実入りコンテナ搬出)が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、運送依頼書(実入りコンテナ搬出)もロックされた状態のままなので、ご注意ください。 運送依頼書(実入りコンテナ搬出)に関する詳細については、[運送依頼書(実入りコンテナ搬出)について]()を参照ください。 |
|
PATCH | /API/v2/Reports/DeliveryInstructions-LoadedContainerPickup/Unlock/{reportId} |
運送依頼書(実入りコンテナ搬出)のロックを解除します 帳票ID(***reportId***)を指定して、運送依頼書(実入りコンテナ搬出)のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 運送依頼書(実入りコンテナ搬出)に関する詳細については、[運送依頼書(実入りコンテナ搬出)について]()を参照ください。 |
|
PATCH | /API/v2/Reports/DeliveryInstructions-LoadedContainerPickup/Update/{reportId} |
運送依頼書(実入りコンテナ搬出)を更新します。 帳票ID(***reportId***)を指定して、運送依頼書(実入りコンテナ搬出)を更新します。 このメソッドでは、運送依頼書(実入りコンテナ搬出)の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 運送依頼書(実入りコンテナ搬出)に関する詳細については、[運送依頼書(実入りコンテナ搬出)について]()を参照ください。 |
|
POST | /API/v2/Reports/DeliveryInstructions-LoadedContainerPickup/UploadFile |
運送依頼書(実入りコンテナ搬出)にファイルを添付します。 指定された運送依頼書(実入りコンテナ搬出)に、ファイルを添付します。 帳票にファイルを添付できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
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でのレスポンスデータを編集し、指定するようにしてください。 |
DeliveryOrderLessRequests
荷渡指図書レス申込書
API | Description | ||
---|---|---|---|
POST | /API/v2/Reports/DeliveryOrderLessRequests/Create |
荷渡指図書レス申込書を作成します。 荷渡指図書レス申込書を作成するには、利用者が荷渡指図書レス申込書を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 荷渡指図書レス申込書に関する詳細については、[荷渡指図書レス申込書について]()を参照ください。 |
|
DELETE | /API/v2/Reports/DeliveryOrderLessRequests/Delete/{reportId} |
荷渡指図書レス申込書を削除します。 帳票ID(***reportId***)を指定して、荷渡指図書レス申込書を削除します。 荷渡指図書レス申込書を削除しても、ルートドキュメントの内容までは削除されません。 申請種別を使用して、作成した荷渡指図書レス申込書のキャンセルを伝える場合は、キャンセル(***Cancel***)を実施後、帳票の提出(***Submit***)を実施してください。 荷渡指図書レス申込書に関する詳細については、[荷渡指図書レス申込書について]()を参照ください。 |
|
DELETE | /API/v2/Reports/DeliveryOrderLessRequests/DeleteFile/{fileId} |
荷渡指図書レス申込書の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、荷渡指図書レス申込書の添付ファイルを削除します。 帳票の添付ファイルを削除できるのは、そのファイルを添付したパートナーに所属している利用者だけです。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
GET | /API/v2/Reports/DeliveryOrderLessRequests/Get/{reportId} |
荷渡指図書レス申込書を取得します。 帳票ID(***reportId***)を指定して、荷渡指図書レス申込書を取得します。 編集が行われていない場合は、ルートドキュメントから最新の荷渡指図書レス申込書を取得します。 編集中の場合は、先に保存した、荷渡指図書レス申込書を取得します。 荷渡指図書レス申込書に関する詳細については、[荷渡指図書レス申込書について]()を参照ください。 |
|
GET | /API/v2/Reports/DeliveryOrderLessRequests/GetFile/{fileId} |
荷渡指図書レス申込書に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、荷渡指図書レス申込書に添付されたファイルを取得します。 帳票の添付ファイルを獲得できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
GET | /API/v2/Reports/DeliveryOrderLessRequests/GetList?tradeNo=!{tradeNo}&uniqueNo=!{uniqueNo}&bookingNo=!{bookingNo}&blNo=!{blNo} |
荷渡指図書レス申込書を全て取得します。 検索条件に該当する荷渡指図書レス申込書を全て取得します。 編集が行われていない場合は、ルートドキュメントから最新の荷渡指図書レス申込書を取得します。 編集中の場合は、先に保存した、荷渡指図書レス申込書を取得します。 荷渡指図書レス申込書に関する詳細については、[荷渡指図書レス申込書について]()を参照ください。 |
|
PATCH | /API/v2/Reports/DeliveryOrderLessRequests/Lock/{reportId} |
編集するため、荷渡指図書レス申込書をロックします 帳票ID(***reportId***)を指定して、荷渡指図書レス申込書をロックします。 荷渡指図書レス申込書を作成(***Create***)した時点では、荷渡指図書レス申込書をロックが掛かりますが、取得(***Get***)したあとで、荷渡指図書レス申込書を編集する場合は、このメソッドを呼び出して、荷渡指図書レス申込書をロックします。 ロックされた荷渡指図書レス申込書は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、荷渡指図書レス申込書をルートドキュメントから参照できますが、編集中(ロック中)の荷渡指図書レス申込書は参照できません。 このロックは、アンロック(***Unlock***)を呼び出すか、帳票の保存後、帳票の提出(***Submit****)を行うと解除されます。 荷渡指図書レス申込書に関する詳細については、[荷渡指図書レス申込書について]()を参照ください。 |
|
PATCH | /API/v2/Reports/DeliveryOrderLessRequests/SetCancel/{reportId} |
荷渡指図書レス申込書の申請種別をキャンセルします 帳票ID(***reportId***)を指定して、荷渡指図書レス申込書の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 荷渡指図書レス申込書に関する詳細については、[荷渡指図書レス申込書について]()を参照ください。 |
|
PATCH | /API/v2/Reports/DeliveryOrderLessRequests/Submit/{reportId} |
荷渡指図書を提出します 帳票ID(***reportId***)を指定して、更新(***Update***)した荷渡指図書レス申込書を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、荷渡指図書レス申込書が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、荷渡指図書レス申込書もロックされた状態のままなので、ご注意ください。 荷渡指図書レス申込書に関する詳細については、[荷渡指図書レス申込書について]()を参照ください。 |
|
PATCH | /API/v2/Reports/DeliveryOrderLessRequests/Unlock/{reportId} |
荷渡指図書レス申込書のロックを解除します 帳票ID(***reportId***)を指定して、荷渡指図書レス申込書のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 荷渡指図書レス申込書に関する詳細については、[荷渡指図書レス申込書について]()を参照ください。 |
|
PATCH | /API/v2/Reports/DeliveryOrderLessRequests/Update/{reportId} |
荷渡指図書レス申込書を更新します。 帳票ID(***reportId***)を指定して、荷渡指図書レス申込書を更新します。 このメソッドでは、荷渡指図書レス申込書の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 荷渡指図書レス申込書に関する詳細については、[荷渡指図書レス申込書について]()を参照ください。 |
|
POST | /API/v2/Reports/DeliveryOrderLessRequests/UploadFile |
荷渡指図書レス申込書にファイルを添付します。 指定された荷渡指図書レス申込書に、ファイルを添付します。 帳票にファイルを添付できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
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でのレスポンスデータを編集し、指定するようにしてください。 |
DeliveryOrders
荷渡指図書
API | Description | ||
---|---|---|---|
POST | /API/v2/Reports/DeliveryOrders/Create |
荷渡指図書を作成します。 荷渡指図書を作成するには、利用者が荷渡指図書を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 荷渡指図書に関する詳細については、[荷渡指図書について]()を参照ください。 |
|
DELETE | /API/v2/Reports/DeliveryOrders/Delete/{reportId} |
荷渡指図書を削除します。 帳票ID(***reportId***)を指定して、荷渡指図書を削除します。 荷渡指図書を削除しても、ルートドキュメントの内容までは削除されません。 申請種別を使用して、作成した荷渡指図書のキャンセルを伝える場合は、キャンセル(***Cancel***)を実施後、帳票の提出(***Submit***)を実施してください。 荷渡指図書に関する詳細については、[荷渡指図書について]()を参照ください。 |
|
DELETE | /API/v2/Reports/DeliveryOrders/DeleteFile/{fileId} |
荷渡指図書の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、荷渡指図書の添付ファイルを削除します。 帳票の添付ファイルを削除できるのは、そのファイルを添付したパートナーに所属している利用者だけです。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
GET | /API/v2/Reports/DeliveryOrders/Get/{reportId} |
荷渡指図書を取得します。 帳票ID(***reportId***)を指定して、荷渡指図書を取得します。 編集が行われていない場合は、ルートドキュメントから最新の荷渡指図書を取得します。 編集中の場合は、先に保存した、荷渡指図書を取得します。 荷渡指図書に関する詳細については、[荷渡指図書について]()を参照ください。 |
|
GET | /API/v2/Reports/DeliveryOrders/GetFile/{fileId} |
荷渡指図書に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、荷渡指図書に添付されたファイルを取得します。 帳票の添付ファイルを獲得できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
GET | /API/v2/Reports/DeliveryOrders/GetList?tradeNo=!{tradeNo}&uniqueNo=!{uniqueNo}&bookingNo=!{bookingNo}&blNo=!{blNo} |
荷渡指図書を全て取得します。 検索条件に該当する荷渡指図書を全て取得します。 編集が行われていない場合は、ルートドキュメントから最新の荷渡指図書を取得します。 編集中の場合は、先に保存した、荷渡指図書を取得します。 荷渡指図書に関する詳細については、[荷渡指図書について]()を参照ください。 |
|
PATCH | /API/v2/Reports/DeliveryOrders/Lock/{reportId} |
編集するため、荷渡指図書をロックします 帳票ID(***reportId***)を指定して、荷渡指図書をロックします。 荷渡指図書を作成(***Create***)した時点では、荷渡指図書をロックが掛かりますが、取得(***Get***)したあとで、荷渡指図書を編集する場合は、このメソッドを呼び出して、荷渡指図書をロックします。 ロックされた荷渡指図書は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、荷渡指図書をルートドキュメントから参照できますが、編集中(ロック中)の荷渡指図書は参照できません。 このロックは、アンロック(***Unlock***)を呼び出すか、帳票の保存後、帳票の提出(***Submit****)を行うと解除されます。 荷渡指図書に関する詳細については、[荷渡指図書について]()を参照ください。 |
|
PATCH | /API/v2/Reports/DeliveryOrders/SetCancel/{reportId} |
荷渡指図書の申請種別をキャンセルします 帳票ID(***reportId***)を指定して、荷渡指図書の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 荷渡指図書に関する詳細については、[荷渡指図書について]()を参照ください。 |
|
PATCH | /API/v2/Reports/DeliveryOrders/Submit/{reportId} |
荷渡指図書を提出します 帳票ID(***reportId***)を指定して、更新(***Update***)した荷渡指図書を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、荷渡指図書が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、荷渡指図書もロックされた状態のままなので、ご注意ください。 荷渡指図書に関する詳細については、[荷渡指図書について]()を参照ください。 |
|
PATCH | /API/v2/Reports/DeliveryOrders/Unlock/{reportId} |
荷渡指図書のロックを解除します 帳票ID(***reportId***)を指定して、荷渡指図書のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 荷渡指図書に関する詳細については、[荷渡指図書について]()を参照ください。 |
|
PATCH | /API/v2/Reports/DeliveryOrders/Update/{reportId} |
荷渡指図書を更新します。 帳票ID(***reportId***)を指定して、荷渡指図書を更新します。 このメソッドでは、荷渡指図書の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 荷渡指図書に関する詳細については、[荷渡指図書について]()を参照ください。 |
|
POST | /API/v2/Reports/DeliveryOrders/UploadFile |
荷渡指図書にファイルを添付します。 指定された荷渡指図書に、ファイルを添付します。 帳票にファイルを添付できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
DeliveryTerms
荷渡形態
API | Description | ||
---|---|---|---|
DELETE | /API/v2/General/DeliveryTerms/DeleteAdmin/{deliveryTermCode} |
荷渡形態を削除します。 荷渡形態コード(***deliveryTermCode***)を指定して、荷渡形態を削除します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
GET | /API/v2/General/DeliveryTerms/Get/{deliveryTermCode} |
荷渡形態を取得します。 荷渡形態コード(***deliveryTermCode***)を指定して、荷渡形態を取得します。 |
|
GET | /API/v2/General/DeliveryTerms/GetList |
荷渡形態を全て取得します。 荷渡形態を全て取得します。 |
|
POST | /API/v2/General/DeliveryTerms/RegisterAdmin |
荷渡形態を登録します。 このAPIはシステム管理者しか呼び出せません。 (*For admin) |
|
POST | /API/v2/General/DeliveryTerms/RegisterInternal |
荷渡形態を登録します。 内部呼び出し用。 (*For admin) |
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でのレスポンスデータを編集し、指定するようにしてください。 |
DockReceipts
ドックレシート(D/R)
API | Description | ||
---|---|---|---|
POST | /API/v2/Reports/DockReceipts/Create |
ドックレシート(D/R)を作成します。 ドックレシート(D/R)を作成するには、利用者がドックレシート(D/R)を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 ドックレシート(D/R)に関する詳細については、[ドックレシート(D/R)について]()を参照ください。 |
|
DELETE | /API/v2/Reports/DockReceipts/Delete/{reportId} |
ドックレシート(D/R)を削除します。 帳票ID(***reportId***)を指定して、ドックレシート(D/R)を削除します。 ドックレシート(D/R)を削除しても、ルートドキュメントの内容までは削除されません。 申請種別を使用して、作成したドックレシート(D/R)のキャンセルを伝える場合は、キャンセル(***Cancel***)を実施後、帳票の提出(***Submit***)を実施してください。 ドックレシート(D/R)に関する詳細については、[ドックレシート(D/R)について]()を参照ください。 |
|
DELETE | /API/v2/Reports/DockReceipts/DeleteFile/{fileId} |
ドックレシート(D/R)の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、ドックレシート(D/R)の添付ファイルを削除します。 帳票の添付ファイルを削除できるのは、そのファイルを添付したパートナーに所属している利用者だけです。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
GET | /API/v2/Reports/DockReceipts/Get/{reportId} |
ドックレシート(D/R)を取得します。 帳票ID(***reportId***)を指定して、ドックレシート(D/R)を取得します。 編集が行われていない場合は、ルートドキュメントから最新のドックレシート(D/R)を取得します。 編集中の場合は、先に保存した、ドックレシート(D/R)を取得します。 ドックレシート(D/R)に関する詳細については、[ドックレシート(D/R)について]()を参照ください。 |
|
GET | /API/v2/Reports/DockReceipts/GetFile/{fileId} |
ドックレシート(D/R)に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、ドックレシート(D/R)に添付されたファイルを取得します。 帳票の添付ファイルを獲得できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
GET | /API/v2/Reports/DockReceipts/GetList?tradeNo=!{tradeNo}&uniqueNo=!{uniqueNo}&bookingNo=!{bookingNo}&blNo=!{blNo} |
ドックレシート(D/R)を全て取得します。 検索条件に該当するドックレシート(D/R)を全て取得します。 編集が行われていない場合は、ルートドキュメントから最新のドックレシート(D/R)を取得します。 編集中の場合は、先に保存した、ドックレシート(D/R)を取得します。 ドックレシート(D/R)に関する詳細については、[ドックレシート(D/R)について]()を参照ください。 |
|
PATCH | /API/v2/Reports/DockReceipts/Lock/{reportId} |
編集するため、ドックレシート(D/R)をロックします 帳票ID(***reportId***)を指定して、ドックレシート(D/R)をロックします。 ドックレシート(D/R)を作成(***Create***)した時点では、ドックレシート(D/R)をロックが掛かりますが、取得(***Get***)したあとで、ドックレシート(D/R)を編集する場合は、このメソッドを呼び出して、ドックレシート(D/R)をロックします。 ロックされたドックレシート(D/R)は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、ドックレシート(D/R)をルートドキュメントから参照できますが、編集中(ロック中)のドックレシート(D/R)は参照できません。 このロックは、アンロック(***Unlock***)を呼び出すか、帳票の保存後、帳票の提出(***Submit****)を行うと解除されます。 ドックレシート(D/R)に関する詳細については、[ドックレシート(D/R)について]()を参照ください。 |
|
PATCH | /API/v2/Reports/DockReceipts/SetCancel/{reportId} |
ドックレシート(D/R)の申請種別をキャンセルします 帳票ID(***reportId***)を指定して、ドックレシート(D/R)の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 ドックレシート(D/R)に関する詳細については、[ドックレシート(D/R)について]()を参照ください。 |
|
PATCH | /API/v2/Reports/DockReceipts/Submit/{reportId} |
ドックレシート(D/R)を提出します 帳票ID(***reportId***)を指定して、更新(***Update***)したドックレシート(D/R)を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、ドックレシート(D/R)が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ドックレシート(D/R)もロックされた状態のままなので、ご注意ください。 ドックレシート(D/R)に関する詳細については、[ドックレシート(D/R)について]()を参照ください。 |
|
PATCH | /API/v2/Reports/DockReceipts/Unlock/{reportId} |
ドックレシート(D/R)のロックを解除します 帳票ID(***reportId***)を指定して、ドックレシート(D/R)のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 ドックレシート(D/R)に関する詳細については、[ドックレシート(D/R)について]()を参照ください。 |
|
PATCH | /API/v2/Reports/DockReceipts/Update/{reportId} |
ドックレシート(D/R)を更新します。 帳票ID(***reportId***)を指定して、ドックレシート(D/R)を更新します。 このメソッドでは、ドックレシート(D/R)の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 ドックレシート(D/R)に関する詳細については、[ドックレシート(D/R)について]()を参照ください。 |
|
POST | /API/v2/Reports/DockReceipts/UploadFile |
ドックレシート(D/R)にファイルを添付します。 指定されたドックレシート(D/R)に、ファイルを添付します。 帳票にファイルを添付できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
DocumentClassificationCodes
書類区分コード
API | Description | ||
---|---|---|---|
DELETE | /API/v2/General/DocumentClassificationCodes/DeleteAdmin/{documentClassificationCode} |
書類区分コードを削除します。 書類区分コード(***documentClassificationCode***)を指定して、書類区分コードを削除します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
GET | /API/v2/General/DocumentClassificationCodes/Get/{documentClassificationCode} |
書類区分を取得します。 書類区分コード(***documentClassificationCode***)を指定して、書類区分を取得します。 書類区分コードに関する詳細については、[書類区分コードについて]()を参照ください。 |
|
GET | /API/v2/General/DocumentClassificationCodes/GetList |
書類区分を全て取得します。 書類区分コードに関する詳細については、[書類区分コードについて]()を参照ください。 |
|
POST | /API/v2/General/DocumentClassificationCodes/RegisterAdmin |
書類区分を登録します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
POST | /API/v2/General/DocumentClassificationCodes/RegisterInternal |
書類区分を登録します。 内部呼び出し用。 (*For admin) |
DomesticConsumptionTaxExemptionCodes
内国消費税免税コード
API | Description | ||
---|---|---|---|
DELETE | /API/v2/General/DomesticConsumptionTaxExemptionCodes/Delete/{domesticConsumptionTaxExemptionCode} |
内国消費税免税コードを削除します。 内国消費税免税コード(***domesticConsumptionTaxExemptionCode***)を指定して、内国消費税免税コードを削除します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
GET | /API/v2/General/DomesticConsumptionTaxExemptionCodes/Get/{domesticConsumptionTaxExemptionCode} |
内国消費税免税種別を取得します。 内国消費税免税コード(***domesticConsumptionTaxExemptionCode***)を指定して、内国消費税免税種別を取得します。 内国消費税免税コードに関する詳細については、[内国消費税免税コードについて]()を参照ください。 |
|
GET | /API/v2/General/DomesticConsumptionTaxExemptionCodes/GetList |
内国消費税免税種別を全て取得します。 内国消費税免税コードに関する詳細については、[内国消費税免税コードについて]()を参照ください。 |
|
POST | /API/v2/General/DomesticConsumptionTaxExemptionCodes/RegisterAdmin |
内国消費税免税種別を登録します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
POST | /API/v2/General/DomesticConsumptionTaxExemptionCodes/RegisterInternal |
内国消費税免税種別を登録します。 内部呼び出し用。 (*For admin) |
DomesticConsumptionTaxReductionAndExemptionCodes
内国消費税等減免税コード
API | Description | ||
---|---|---|---|
DELETE | /API/v2/General/DomesticConsumptionTaxReductionAndExemptionCodes/DeleteAdmin/{domesticConsumptionTaxReductionAndExemptionCode} |
内国消費税等減免税コードを削除します。 内国消費税等減免税コード(***domesticConsumptionTaxReductionAndExemptionCode***)を指定して、内国消費税等減免税コードを削除します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
GET | /API/v2/General/DomesticConsumptionTaxReductionAndExemptionCodes/Get/{domesticConsumptionTaxReductionAndExemptionCode} |
内国消費税等減免税種別を取得します。 内国消費税等減免税コード(***domesticConsumptionTaxReductionAndExemptionCode***)を指定して、内国消費税等減免税種別を取得します。 内国消費税等減免税コードに関する詳細については、[内国消費税等減免税コードについて]()を参照ください。 |
|
GET | /API/v2/General/DomesticConsumptionTaxReductionAndExemptionCodes/GetList |
内国消費税等減免税種別を全て取得します。 内国消費税等減免税コードに関する詳細については、[内国消費税等減免税コードについて]()を参照ください。 |
|
POST | /API/v2/General/DomesticConsumptionTaxReductionAndExemptionCodes/RegisterAdmin |
内国消費税等減免税種別を登録します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
POST | /API/v2/General/DomesticConsumptionTaxReductionAndExemptionCodes/RegisterInternal |
内国消費税等減免税種別を登録します。 内部呼び出し用。 (*For admin) |
DomesticConsumptionTaxTypeCodes
内国消費税等種別コード
API | Description | ||
---|---|---|---|
DELETE | /API/v2/General/DomesticConsumptionTaxTypeCodes/DeleteAdmin/{domesticConsumptionTaxTypeCode} |
内国消費税等種別コードを削除します。 内国消費税等種別コード(***domesticConsumptionTaxTypeCode***)を指定して、内国消費税等種別コードを削除します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
GET | /API/v2/General/DomesticConsumptionTaxTypeCodes/Get/{domesticConsumptionTaxTypeCode} |
内国消費税等種別を取得します。 内国消費税等種別コード(***domesticConsumptionTaxTypeCode***)を指定して、原産地証明書識別を取得します。 内国消費税等種別コードに関する詳細については、[内国消費税等種別コードについて]()を参照ください。 |
|
GET | /API/v2/General/DomesticConsumptionTaxTypeCodes/GetList |
内国消費税等種別を全て取得します。 内国消費税等種別コードに関する詳細については、[内国消費税等種別コードについて]()を参照ください。 |
|
POST | /API/v2/General/DomesticConsumptionTaxTypeCodes/RegisterAdmin |
内国消費税等種別を登録します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
POST | /API/v2/General/DomesticConsumptionTaxTypeCodes/RegisterInternal |
内国消費税等種別を登録します。 内部呼び出し用。 (*For admin) |
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権限が必要です。 |
Employees
利用者
API | Description | ||
---|---|---|---|
DELETE | /API/v2/Employees/Delete/{employeeId} |
利用者を削除します。 利用者ID(***employeeId***)を指定して、会社に所属する利用者を削除します。 このメソッドは会社の管理者(***/API/v2/Companies/Administrators***)として登録された利用者が利用できます。 |
|
GET | /API/v2/Employees/Get |
利用者を取得します。 ログインしている利用者を取得します。 利用者に関する詳細については、[利用者について]()を参照ください。 |
|
GET | /API/v2/Employees/GetAccessibleReports |
利用者がアクセス可能な帳票を全て取得します。 ログインしている利用者がアクセス可能な帳票を全て取得します。 アクセス可能な帳票は、利用者が所属している組織に割り当てられた事業種別を条件に、(***/API/v2/Master/ReportTypes/Permissions****)で、アクセス権限がR権限以上のものを取得します。 |
|
GET | /API/v2/Employees/GetCoworkers?employeeId=!{employeeId}&emailAddress=!{emailAddress}&isActive=!{isActive} |
会社の利用者を全て取得します。 ログインしている利用者が所属する会社配下に登録されている全ての利用者を取得します。 利用者に関する詳細については、[利用者について]()を参照ください。 |
|
POST | /API/v2/Employees/Register |
所属する会社に利用者を登録します。 管理者が所属する会社に、利用者を登録します。 このメソッドは会社の管理者(***/API/v2/Companies/Administrators***)として登録された利用者が利用できます。 利用者に関する詳細については、[利用者について]()を参照ください。 |
|
POST | /API/v2/Employees/RegisterList |
所属する会社に利用者を一括で登録します。 管理者が所属する会社に、利用者を登録します。 このメソッドは会社の管理者(***/API/v2/Companies/Administrators***)として登録された利用者が利用できます。 利用者に関する詳細については、[利用者について]()を参照ください。 |
|
PATCH | /API/v2/Employees/SetActive/{employeeId} |
利用者が有効であるか(isActive)を更新します。 利用者ID(***employeeId***)を指定して、利用者が有効であるか(***isActive***)を更新します。 isActiveをfalseにすると、その利用者は、 ・ログインできなくなります。 ・一部を除き、サイバーポートのAPIは呼び出せません。 このメソッドは会社の管理者(***/API/v2/Companies/Administrators***)として登録された利用者が利用できます。 |
|
PATCH | /API/v2/Employees/SetDefaultOrganization/{employeeId} |
利用者が所属する組織の中からデフォルトの組織を更新します。 利用者ID(***employeeId***)を指定して、会社に所属する利用者について、利用者が所属する組織の中からデフォルトの組織を更新します。 このメソッドは会社の管理者(***/API/v2/Companies/Administrators***)として登録された利用者が利用できます。 |
|
PATCH | /API/v2/Employees/SetEmployeeName |
利用者の名称を更新します。 ログインしている利用者の名称を更新します。 |
|
PATCH | /API/v2/Employees/SetEmployeeName/{employeeId} |
利用者の氏名を更新します。 利用者ID(***employeeId***)を指定して、利用者の氏名を更新します。 利用者に関する詳細については、[利用者について]()を参照ください。 |
|
PATCH | /API/v2/Employees/SetLanguage |
利用者が利用する言語を更新します。 ログインしている利用者が利用する言語を更新します。 |
|
PATCH | /API/v2/Employees/SetMailType |
利用者が通知で受け取るメール形式やメールアドレスを更新します。 ログインしているが通知で受け取るメール形式やメールアドレスを更新します。 |
EmptyContainerDeliveryRegistrations
PCD
API | Description | ||
---|---|---|---|
POST | /API/v1/NaccsReport/EmptyContainerDeliveryRegistrations/Create |
帳票:PCDを作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 |
|
DELETE | /API/v1/NaccsReport/EmptyContainerDeliveryRegistrations/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:PCDを削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
GET | /API/v1/NaccsReport/EmptyContainerDeliveryRegistrations/Get/{dealReportId} |
帳票:PCDを取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/NaccsReport/EmptyContainerDeliveryRegistrations/GetAttachFileMetaList/{dealReportId} |
添付ファイル情報一覧を取得します。 |
|
POST | /API/v1/NaccsReport/EmptyContainerDeliveryRegistrations/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/EmptyContainerDeliveryRegistrations/Register |
帳票:PCDを保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
EmptyContainerPickUpAnswerCalls
PUA11
API | Description | ||
---|---|---|---|
POST | /API/v1/NaccsReport/EmptyContainerPickUpAnswerCalls/Create |
帳票:PUA11を作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 帳票:PUA11が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/NaccsReport/EmptyContainerPickUpAnswerCalls/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:PUA11を削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
GET | /API/v1/NaccsReport/EmptyContainerPickUpAnswerCalls/Get/{dealReportId} |
帳票:PUA11を取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/NaccsReport/EmptyContainerPickUpAnswerCalls/GetAttachFileMetaList/{dealReportId} |
添付ファイル情報一覧を取得します。 |
|
POST | /API/v1/NaccsReport/EmptyContainerPickUpAnswerCalls/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/EmptyContainerPickUpAnswerCalls/Register |
帳票:PUA11を保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
EmptyContainerPickUpAnswers
PUA
API | Description | ||
---|---|---|---|
POST | /API/v1/NaccsReport/EmptyContainerPickUpAnswers/Create |
帳票:PUAを作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 |
|
DELETE | /API/v1/NaccsReport/EmptyContainerPickUpAnswers/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:PUAを削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
GET | /API/v1/NaccsReport/EmptyContainerPickUpAnswers/Get/{dealReportId} |
帳票:PUAを取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/NaccsReport/EmptyContainerPickUpAnswers/GetAttachFileMetaList/{dealReportId} |
添付ファイル情報一覧を取得します。 |
|
POST | /API/v1/NaccsReport/EmptyContainerPickUpAnswers/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/EmptyContainerPickUpAnswers/Register |
帳票:PUAを保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
EmptyContainerPickUpChangeCalls
PUH11
API | Description | ||
---|---|---|---|
POST | /API/v1/NaccsReport/EmptyContainerPickUpChangeCalls/Create |
帳票:PUH11を作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 帳票:PUH11が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/NaccsReport/EmptyContainerPickUpChangeCalls/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:PUH11を削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
GET | /API/v1/NaccsReport/EmptyContainerPickUpChangeCalls/Get/{dealReportId} |
帳票:PUH11を取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/NaccsReport/EmptyContainerPickUpChangeCalls/GetAttachFileMetaList/{dealReportId} |
添付ファイル情報一覧を取得します。 |
|
POST | /API/v1/NaccsReport/EmptyContainerPickUpChangeCalls/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/EmptyContainerPickUpChangeCalls/Register |
帳票:PUH11を保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
EmptyContainerPickUpChanges
PUH
API | Description | ||
---|---|---|---|
POST | /API/v1/NaccsReport/EmptyContainerPickUpChanges/Create |
帳票:PUHを作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 |
|
DELETE | /API/v1/NaccsReport/EmptyContainerPickUpChanges/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:PUHを削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
GET | /API/v1/NaccsReport/EmptyContainerPickUpChanges/Get/{dealReportId} |
帳票:PUHを取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/NaccsReport/EmptyContainerPickUpChanges/GetAttachFileMetaList/{dealReportId} |
添付ファイル情報一覧を取得します。 |
|
POST | /API/v1/NaccsReport/EmptyContainerPickUpChanges/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/EmptyContainerPickUpChanges/Register |
帳票:PUHを保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
EmptyContainerPickUpLists
PUL
API | Description | ||
---|---|---|---|
POST | /API/v1/NaccsReport/EmptyContainerPickUpLists/Create |
帳票:PULを作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 帳票:PULが取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/NaccsReport/EmptyContainerPickUpLists/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:PULを削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
GET | /API/v1/NaccsReport/EmptyContainerPickUpLists/Get/{dealReportId} |
帳票:PULを取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/NaccsReport/EmptyContainerPickUpLists/GetAttachFileMetaList/{dealReportId} |
添付ファイル情報一覧を取得します。 |
|
POST | /API/v1/NaccsReport/EmptyContainerPickUpLists/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/EmptyContainerPickUpLists/Register |
帳票:PULを保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
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でのレスポンスデータを編集し、指定するようにしてください。 |
EmptyContainerPickUpOrders
空コンテナピックアップオーダー
API | Description | ||
---|---|---|---|
POST | /API/v2/Reports/EmptyContainerPickUpOrders/Create |
空コンテナピックアップオーダーを作成します。 空コンテナピックアップオーダーを作成するには、利用者が空コンテナピックアップオーダーを作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 空コンテナピックアップオーダーに関する詳細については、[空コンテナピックアップオーダーについて]()を参照ください。 |
|
DELETE | /API/v2/Reports/EmptyContainerPickUpOrders/Delete/{reportId} |
空コンテナピックアップオーダーを削除します。 帳票ID(***reportId***)を指定して、空コンテナピックアップオーダーを削除します。 空コンテナピックアップオーダーを削除しても、ルートドキュメントの内容までは削除されません。 申請種別を使用して、作成した空コンテナピックアップオーダーのキャンセルを伝える場合は、キャンセル(***Cancel***)を実施後、帳票の提出(***Submit***)を実施してください。 空コンテナピックアップオーダーに関する詳細については、[空コンテナピックアップオーダーについて]()を参照ください。 |
|
DELETE | /API/v2/Reports/EmptyContainerPickUpOrders/DeleteFile/{fileId} |
空コンテナピックアップオーダーの添付ファイルを削除します。 ファイルID(***fileId***)を指定して、空コンテナピックアップオーダーの添付ファイルを削除します。 帳票の添付ファイルを削除できるのは、そのファイルを添付したパートナーに所属している利用者だけです。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
GET | /API/v2/Reports/EmptyContainerPickUpOrders/Get/{reportId} |
空コンテナピックアップオーダーを取得します。 帳票ID(***reportId***)を指定して、空コンテナピックアップオーダーを取得します。 編集が行われていない場合は、ルートドキュメントから最新の空コンテナピックアップオーダーを取得します。 編集中の場合は、先に保存した、空コンテナピックアップオーダーを取得します。 空コンテナピックアップオーダーに関する詳細については、[空コンテナピックアップオーダーについて]()を参照ください。 |
|
GET | /API/v2/Reports/EmptyContainerPickUpOrders/GetFile/{fileId} |
空コンテナピックアップオーダーに添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、空コンテナピックアップオーダーに添付されたファイルを取得します。 帳票の添付ファイルを獲得できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
GET | /API/v2/Reports/EmptyContainerPickUpOrders/GetList?tradeNo=!{tradeNo}&uniqueNo=!{uniqueNo}&bookingNo=!{bookingNo}&blNo=!{blNo} |
空コンテナピックアップオーダーを全て取得します。 検索条件に該当する空コンテナピックアップオーダーを全て取得します。 編集が行われていない場合は、ルートドキュメントから最新の空コンテナピックアップオーダーを取得します。 編集中の場合は、先に保存した、空コンテナピックアップオーダーを取得します。 空コンテナピックアップオーダーに関する詳細については、[空コンテナピックアップオーダーについて]()を参照ください。 |
|
PATCH | /API/v2/Reports/EmptyContainerPickUpOrders/Lock/{reportId} |
編集するため、空コンテナピックアップオーダー回答をロックします 帳票ID(***reportId***)を指定して、空コンテナピックアップオーダーをロックします。 空コンテナピックアップオーダーを作成(***Create***)した時点では、空コンテナピックアップオーダーをロックが掛かりますが、取得(***Get***)したあとで、空コンテナピックアップオーダーを編集する場合は、このメソッドを呼び出して、空コンテナピックアップオーダーをロックします。 ロックされた空コンテナピックアップオーダーは、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、空コンテナピックアップオーダーをルートドキュメントから参照できますが、編集中(ロック中)の空コンテナピックアップオーダー回答は参照できません。 このロックは、アンロック(***Unlock***)を呼び出すか、帳票の保存後、帳票の提出(***Submit****)を行うと解除されます。 空コンテナピックアップオーダーに関する詳細については、[空コンテナピックアップオーダーについて]()を参照ください。 |
|
PATCH | /API/v2/Reports/EmptyContainerPickUpOrders/SetCancel/{reportId} |
空コンテナピックアップオーダーの申請種別をキャンセルします 帳票ID(***reportId***)を指定して、空コンテナピックアップオーダーの申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 空コンテナピックアップオーダーに関する詳細については、[空コンテナピックアップオーダーについて]()を参照ください。 |
|
PATCH | /API/v2/Reports/EmptyContainerPickUpOrders/Submit/{reportId} |
空コンテナピックアップオーダーを提出します 帳票ID(***reportId***)を指定して、更新(***Update***)した空コンテナピックアップオーダーを提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、空コンテナピックアップオーダーが参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、空コンテナピックアップオーダーもロックされた状態のままなので、ご注意ください。 空コンテナピックアップオーダーに関する詳細については、[空コンテナピックアップオーダーについて]()を参照ください。 |
|
PATCH | /API/v2/Reports/EmptyContainerPickUpOrders/Unlock/{reportId} |
空コンテナピックアップオーダーのロックを解除します 帳票ID(***reportId***)を指定して、空コンテナピックアップオーダーのロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 空コンテナピックアップオーダーに関する詳細については、[空コンテナピックアップオーダーについて]()を参照ください。 |
|
PATCH | /API/v2/Reports/EmptyContainerPickUpOrders/Update/{reportId} |
空コンテナピックアップオーダーを更新します。 帳票ID(***reportId***)を指定して、空コンテナピックアップオーダーを更新します。 このメソッドでは、空コンテナピックアップオーダーの更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 空コンテナピックアップオーダーに関する詳細については、[空コンテナピックアップオーダーについて]()を参照ください。 |
|
POST | /API/v2/Reports/EmptyContainerPickUpOrders/UploadFile |
空コンテナピックアップオーダーにファイルを添付します。 指定された空コンテナピックアップオーダーに、ファイルを添付します。 帳票にファイルを添付できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
EmptyContainerPickUpRegistrationCalls
PUR11
API | Description | ||
---|---|---|---|
POST | /API/v1/NaccsReport/EmptyContainerPickUpRegistrationCalls/Create |
帳票:PUR11を作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 帳票:PUR11が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/NaccsReport/EmptyContainerPickUpRegistrationCalls/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:PUR11を削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
GET | /API/v1/NaccsReport/EmptyContainerPickUpRegistrationCalls/Get/{dealReportId} |
帳票:PUR11を取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/NaccsReport/EmptyContainerPickUpRegistrationCalls/GetAttachFileMetaList/{dealReportId} |
添付ファイル情報一覧を取得します。 |
|
POST | /API/v1/NaccsReport/EmptyContainerPickUpRegistrationCalls/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/EmptyContainerPickUpRegistrationCalls/Register |
帳票:PUR11を保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
EmptyContainerPickUpRegistrations
PUR
API | Description | ||
---|---|---|---|
POST | /API/v1/NaccsReport/EmptyContainerPickUpRegistrations/Create |
帳票:PURを作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 |
|
DELETE | /API/v1/NaccsReport/EmptyContainerPickUpRegistrations/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:PURを削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
GET | /API/v1/NaccsReport/EmptyContainerPickUpRegistrations/Get/{dealReportId} |
帳票:PURを取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/NaccsReport/EmptyContainerPickUpRegistrations/GetAttachFileMetaList/{dealReportId} |
添付ファイル情報一覧を取得します。 |
|
POST | /API/v1/NaccsReport/EmptyContainerPickUpRegistrations/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/EmptyContainerPickUpRegistrations/Register |
帳票:PURを保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対して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でのレスポンスデータを編集し、指定するようにしてください。 |
EquipmentInterchangeReceipts-In-Empty
機器受領書(IN EMPTY)
API | Description | ||
---|---|---|---|
POST | /API/v2/Reports/EquipmentInterchangeReceipts-In-Empty/Create |
機器受領書(IN EMPTY)を作成します。 機器受領書(IN EMPTY)を作成するには、利用者が機器受領書(IN EMPTY)を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 機器受領書(IN EMPTY)に関する詳細については、[機器受領書(IN EMPTY)について]()を参照ください。 |
|
DELETE | /API/v2/Reports/EquipmentInterchangeReceipts-In-Empty/Delete/{reportId} |
機器受領書(IN EMPTY)を削除します。 帳票ID(***reportId***)を指定して、機器受領書(IN EMPTY)を削除します。 機器受領書(IN EMPTY)を削除しても、ルートドキュメントの内容までは削除されません。 申請種別を使用して、作成した機器受領書(IN EMPTY)のキャンセルを伝える場合は、キャンセル(***Cancel***)を実施後、帳票の提出(***Submit***)を実施してください。 機器受領書(IN EMPTY)に関する詳細については、[機器受領書(IN EMPTY)について]()を参照ください。 |
|
DELETE | /API/v2/Reports/EquipmentInterchangeReceipts-In-Empty/DeleteFile/{fileId} |
機器受領書(IN EMPTY)の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、機器受領書(IN EMPTY)の添付ファイルを削除します。 帳票の添付ファイルを削除できるのは、そのファイルを添付したパートナーに所属している利用者だけです。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
GET | /API/v2/Reports/EquipmentInterchangeReceipts-In-Empty/Get/{reportId} |
機器受領書(IN EMPTY)を取得します。 帳票ID(***reportId***)を指定して、機器受領書(IN EMPTY)を取得します。 編集が行われていない場合は、ルートドキュメントから最新の機器受領書(IN EMPTY)を取得します。 編集中の場合は、先に保存した、機器受領書(IN EMPTY)を取得します。 機器受領書(IN EMPTY)に関する詳細については、[機器受領書(IN EMPTY)について]()を参照ください。 |
|
GET | /API/v2/Reports/EquipmentInterchangeReceipts-In-Empty/GetFile/{fileId} |
機器受領書(IN EMPTY)に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、機器受領書(IN EMPTY)に添付されたファイルを取得します。 帳票の添付ファイルを獲得できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
GET | /API/v2/Reports/EquipmentInterchangeReceipts-In-Empty/GetList?tradeNo=!{tradeNo}&uniqueNo=!{uniqueNo}&bookingNo=!{bookingNo}&blNo=!{blNo} |
機器受領書(IN EMPTY)を全て取得します。 検索条件に該当する機器受領書(IN EMPTY)を全て取得します。 編集が行われていない場合は、ルートドキュメントから最新の機器受領書(IN EMPTY)を取得します。 編集中の場合は、先に保存した、機器受領書(IN EMPTY)を取得します。 機器受領書(IN EMPTY)に関する詳細については、[機器受領書(IN EMPTY)について]()を参照ください。 |
|
PATCH | /API/v2/Reports/EquipmentInterchangeReceipts-In-Empty/Lock/{reportId} |
編集するため、機器受領書(IN EMPTY)をロックします 帳票ID(***reportId***)を指定して、機器受領書(IN EMPTY)をロックします。 機器受領書(IN EMPTY)を作成(***Create***)した時点では、機器受領書(IN EMPTY)をロックが掛かりますが、取得(***Get***)したあとで、機器受領書(IN EMPTY)を編集する場合は、このメソッドを呼び出して、機器受領書(IN EMPTY)をロックします。 ロックされた機器受領書(IN EMPTY)は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、機器受領書(IN EMPTY)をルートドキュメントから参照できますが、編集中(ロック中)の機器受領書(IN EMPTY)は参照できません。 このロックは、アンロック(***Unlock***)を呼び出すか、帳票の保存後、帳票の提出(***Submit****)を行うと解除されます。 機器受領書(IN EMPTY)に関する詳細については、[機器受領書(IN EMPTY)について]()を参照ください。 |
|
PATCH | /API/v2/Reports/EquipmentInterchangeReceipts-In-Empty/SetCancel/{reportId} |
機器受領書(IN EMPTY)の申請種別をキャンセルします 帳票ID(***reportId***)を指定して、機器受領書(IN EMPTY)の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 機器受領書(IN EMPTY)に関する詳細については、[機器受領書(IN EMPTY)について]()を参照ください。 |
|
PATCH | /API/v2/Reports/EquipmentInterchangeReceipts-In-Empty/Submit/{reportId} |
機器受領書(IN EMPTY)を提出します 帳票ID(***reportId***)を指定して、更新(***Update***)した機器受領書(IN EMPTY)を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、機器受領書(IN EMPTY)が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、機器受領書(IN EMPTY)もロックされた状態のままなので、ご注意ください。 機器受領書(IN EMPTY)に関する詳細については、[機器受領書(IN EMPTY)について]()を参照ください。 |
|
PATCH | /API/v2/Reports/EquipmentInterchangeReceipts-In-Empty/Unlock/{reportId} |
機器受領書(IN EMPTY)のロックを解除します 帳票ID(***reportId***)を指定して、機器受領書(IN EMPTY)のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 機器受領書(IN EMPTY)に関する詳細については、[機器受領書(IN EMPTY)について]()を参照ください。 |
|
PATCH | /API/v2/Reports/EquipmentInterchangeReceipts-In-Empty/Update/{reportId} |
機器受領書(IN EMPTY)を更新します。 帳票ID(***reportId***)を指定して、機器受領書(IN EMPTY)を更新します。 このメソッドでは、機器受領書(IN EMPTY)の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 機器受領書(IN EMPTY)に関する詳細については、[機器受領書(IN EMPTY)について]()を参照ください。 |
|
POST | /API/v2/Reports/EquipmentInterchangeReceipts-In-Empty/UploadFile |
機器受領書(IN EMPTY)にファイルを添付します。 指定された機器受領書(IN EMPTY)に、ファイルを添付します。 帳票にファイルを添付できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
EquipmentInterchangeReceipts-In-Full
機器受領書(IN FULL)
API | Description | ||
---|---|---|---|
POST | /API/v2/Reports/EquipmentInterchangeReceipts-In-Full/Create |
機器受領書(IN FULL)を作成します。 機器受領書(IN FULL)を作成するには、利用者が機器受領書(IN FULL)を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 機器受領書(IN FULL)に関する詳細については、[機器受領書(IN FULL)について]()を参照ください。 |
|
DELETE | /API/v2/Reports/EquipmentInterchangeReceipts-In-Full/Delete/{reportId} |
機器受領書(IN FULL)を削除します。 帳票ID(***reportId***)を指定して、機器受領書(IN FULL)を削除します。 機器受領書(IN FULL)を削除しても、ルートドキュメントの内容までは削除されません。 申請種別を使用して、作成した機器受領書(IN FULL)のキャンセルを伝える場合は、キャンセル(***Cancel***)を実施後、帳票の提出(***Submit***)を実施してください。 機器受領書(IN FULL)に関する詳細については、[機器受領書(IN FULL)について]()を参照ください。 |
|
DELETE | /API/v2/Reports/EquipmentInterchangeReceipts-In-Full/DeleteFile/{fileId} |
機器受領書(IN FULL)の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、機器受領書(IN FULL)の添付ファイルを削除します。 帳票の添付ファイルを削除できるのは、そのファイルを添付したパートナーに所属している利用者だけです。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
GET | /API/v2/Reports/EquipmentInterchangeReceipts-In-Full/Get/{reportId} |
機器受領書(IN FULL)を取得します。 帳票ID(***reportId***)を指定して、機器受領書(IN FULL)を取得します。 編集が行われていない場合は、ルートドキュメントから最新の機器受領書(IN FULL)を取得します。 編集中の場合は、先に保存した、機器受領書(IN FULL)を取得します。 機器受領書(IN FULL)に関する詳細については、[機器受領書(IN FULL)について]()を参照ください。 |
|
GET | /API/v2/Reports/EquipmentInterchangeReceipts-In-Full/GetFile/{fileId} |
機器受領書(IN FULL)に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、機器受領書(OUT FULL)に添付されたファイルを取得します。 帳票の添付ファイルを獲得できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
GET | /API/v2/Reports/EquipmentInterchangeReceipts-In-Full/GetList?tradeNo=!{tradeNo}&uniqueNo=!{uniqueNo}&bookingNo=!{bookingNo}&blNo=!{blNo} |
機器受領書(IN FULL)を全て取得します。 検索条件に該当する機器受領書(IN FULL)を全て取得します。 編集が行われていない場合は、ルートドキュメントから最新の機器受領書(IN FULL)を取得します。 編集中の場合は、先に保存した、機器受領書(IN FULL)を取得します。 機器受領書(IN FULL)に関する詳細については、[機器受領書(IN FULL)について]()を参照ください。 |
|
PATCH | /API/v2/Reports/EquipmentInterchangeReceipts-In-Full/Lock/{reportId} |
編集するため、機器受領書(IN FULL)をロックします 帳票ID(***reportId***)を指定して、機器受領書(IN FULL)をロックします。 機器受領書(IN FULL)を作成(***Create***)した時点では、機器受領書(IN FULL)をロックが掛かりますが、取得(***Get***)したあとで、機器受領書(IN FULL)を編集する場合は、このメソッドを呼び出して、機器受領書(IN FULL)をロックします。 ロックされた機器受領書(IN FULL)は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、機器受領書(IN FULL)をルートドキュメントから参照できますが、編集中(ロック中)の機器受領書(IN FULL)は参照できません。 このロックは、アンロック(***Unlock***)を呼び出すか、帳票の保存後、帳票の提出(***Submit****)を行うと解除されます。 機器受領書(IN FULL)に関する詳細については、[機器受領書(IN FULL)について]()を参照ください。 |
|
PATCH | /API/v2/Reports/EquipmentInterchangeReceipts-In-Full/SetCancel/{reportId} |
機器受領書(IN FULL)の申請種別をキャンセルします 帳票ID(***reportId***)を指定して、機器受領書(IN FULL)の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 機器受領書(IN FULL)に関する詳細については、[機器受領書(IN FULL)について]()を参照ください。 |
|
PATCH | /API/v2/Reports/EquipmentInterchangeReceipts-In-Full/Submit/{reportId} |
機器受領書(IN FULL)を提出します 帳票ID(***reportId***)を指定して、更新(***Update***)した機器受領書(IN FULL)を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、機器受領書(IN FULL)が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、機器受領書(IN FULL)もロックされた状態のままなので、ご注意ください。 機器受領書(IN FULL)に関する詳細については、[機器受領書(IN FULL)について]()を参照ください。 |
|
PATCH | /API/v2/Reports/EquipmentInterchangeReceipts-In-Full/Unlock/{reportId} |
機器受領書(IN FULL)のロックを解除します 帳票ID(***reportId***)を指定して、機器受領書(IN FULL)のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 機器受領書(IN FULL)に関する詳細については、[機器受領書(IN FULL)について]()を参照ください。 |
|
PATCH | /API/v2/Reports/EquipmentInterchangeReceipts-In-Full/Update/{reportId} |
機器受領書(IN FULL)を更新します。 帳票ID(***reportId***)を指定して、機器受領書(IN FULL)を更新します。 このメソッドでは、機器受領書(IN FULL)の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 機器受領書(IN FULL)に関する詳細については、[機器受領書(IN FULL)について]()を参照ください。 |
|
POST | /API/v2/Reports/EquipmentInterchangeReceipts-In-Full/UploadFile |
機器受領書(IN FULL)にファイルを添付します。 指定された機器受領書(IN FULL)に、ファイルを添付します。 帳票にファイルを添付できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
EquipmentInterchangeReceipts-Out-Empty
機器受領書(OUT EMPTY)
API | Description | ||
---|---|---|---|
POST | /API/v2/Reports/EquipmentInterchangeReceipts-Out-Empty/Create |
機器受領書(OUT EMPTY)を作成します。 機器受領書(OUT EMPTY)を作成するには、利用者が機器受領書(OUT EMPTY)を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 機器受領書(OUT EMPTY)に関する詳細については、[機器受領書(OUT EMPTY)について]()を参照ください。 |
|
DELETE | /API/v2/Reports/EquipmentInterchangeReceipts-Out-Empty/Delete/{reportId} |
機器受領書(OUT EMPTY)を削除します。 帳票ID(***reportId***)を指定して、機器受領書(OUT EMPTY)を削除します。 機器受領書(OUT EMPTY)を削除しても、ルートドキュメントの内容までは削除されません。 申請種別を使用して、作成した機器受領書(OUT EMPTY)のキャンセルを伝える場合は、キャンセル(***Cancel***)を実施後、帳票の提出(***Submit***)を実施してください。 機器受領書(OUT EMPTY)に関する詳細については、[機器受領書(OUT EMPTY)について]()を参照ください。 |
|
DELETE | /API/v2/Reports/EquipmentInterchangeReceipts-Out-Empty/DeleteFile/{fileId} |
機器受領書(OUT EMPTY)の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、機器受領書(OUT EMPTY)の添付ファイルを削除します。 帳票の添付ファイルを削除できるのは、そのファイルを添付したパートナーに所属している利用者だけです。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
GET | /API/v2/Reports/EquipmentInterchangeReceipts-Out-Empty/Get/{reportId} |
機器受領書(OUT EMPTY)を取得します。 帳票ID(***reportId***)を指定して、機器受領書(OUT EMPTY)を取得します。 編集が行われていない場合は、ルートドキュメントから最新の機器受領書(OUT EMPTY)を取得します。 編集中の場合は、先に保存した、機器受領書(OUT EMPTY)を取得します。 機器受領書(OUT EMPTY)に関する詳細については、[機器受領書(OUT EMPTY)について]()を参照ください。 |
|
GET | /API/v2/Reports/EquipmentInterchangeReceipts-Out-Empty/GetFile/{fileId} |
機器受領書(OUT EMPTY)に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、機器受領書(OUT EMPTY)に添付されたファイルを取得します。 帳票の添付ファイルを獲得できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
GET | /API/v2/Reports/EquipmentInterchangeReceipts-Out-Empty/GetList?tradeNo=!{tradeNo}&uniqueNo=!{uniqueNo}&bookingNo=!{bookingNo}&blNo=!{blNo} |
機器受領書(OUT EMPTY)を全て取得します。 検索条件に該当する機器受領書(OUT EMPTY)を全て取得します。 編集が行われていない場合は、ルートドキュメントから最新の機器受領書(OUT EMPTY)を取得します。 編集中の場合は、先に保存した、機器受領書(OUT EMPTY)を取得します。 機器受領書(OUT EMPTY)に関する詳細については、[機器受領書(OUT EMPTY)について]()を参照ください。 |
|
PATCH | /API/v2/Reports/EquipmentInterchangeReceipts-Out-Empty/Lock/{reportId} |
編集するため、機器受領書(OUT EMPTY)をロックします 帳票ID(***reportId***)を指定して、機器受領書(OUT EMPTY)をロックします。 機器受領書(OUT EMPTY)を作成(***Create***)した時点では、機器受領書(OUT EMPTY)をロックが掛かりますが、取得(***Get***)したあとで、機器受領書(OUT EMPTY)を編集する場合は、このメソッドを呼び出して、機器受領書(OUT EMPTY)をロックします。 ロックされた機器受領書(OUT EMPTY)は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、機器受領書(OUT EMPTY)をルートドキュメントから参照できますが、編集中(ロック中)の機器受領書(OUT EMPTY)は参照できません。 このロックは、アンロック(***Unlock***)を呼び出すか、帳票の保存後、帳票の提出(***Submit****)を行うと解除されます。 機器受領書(OUT EMPTY)に関する詳細については、[機器受領書(OUT EMPTY)について]()を参照ください。 |
|
PATCH | /API/v2/Reports/EquipmentInterchangeReceipts-Out-Empty/SetCancel/{reportId} |
機器受領書(OUT EMPTY)の申請種別をキャンセルします 帳票ID(***reportId***)を指定して、機器受領書(OUT EMPTY)の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 機器受領書(OUT EMPTY)に関する詳細については、[機器受領書(OUT EMPTY)について]()を参照ください。 |
|
PATCH | /API/v2/Reports/EquipmentInterchangeReceipts-Out-Empty/Submit/{reportId} |
機器受領書(OUT EMPTY)を提出します 帳票ID(***reportId***)を指定して、更新(***Update***)した機器受領書(OUT EMPTY)を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、機器受領書(OUT EMPTY)が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、機器受領書(OUT EMPTY)もロックされた状態のままなので、ご注意ください。 機器受領書(OUT EMPTY)に関する詳細については、[機器受領書(OUT EMPTY)について]()を参照ください。 |
|
PATCH | /API/v2/Reports/EquipmentInterchangeReceipts-Out-Empty/Unlock/{reportId} |
機器受領書(OUT EMPTY)のロックを解除します 帳票ID(***reportId***)を指定して、機器受領書(OUT EMPTY)のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 機器受領書(OUT EMPTY)に関する詳細については、[機器受領書(OUT EMPTY)について]()を参照ください。 |
|
PATCH | /API/v2/Reports/EquipmentInterchangeReceipts-Out-Empty/Update/{reportId} |
機器受領書(OUT EMPTY)を更新します。 帳票ID(***reportId***)を指定して、機器受領書(OUT EMPTY)を更新します。 このメソッドでは、機器受領書(OUT EMPTY)の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 機器受領書(OUT EMPTY)に関する詳細については、[機器受領書(OUT EMPTY)について]()を参照ください。 |
|
POST | /API/v2/Reports/EquipmentInterchangeReceipts-Out-Empty/UploadFile |
機器受領書(OUT EMPTY)にファイルを添付します。 指定された機器受領書(OUT EMPTY)に、ファイルを添付します。 帳票にファイルを添付できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
EquipmentInterchangeReceipts-Out-Full
機器受領書(OUT FULL)
API | Description | ||
---|---|---|---|
POST | /API/v2/Reports/EquipmentInterchangeReceipts-Out-Full/Create |
機器受領書(OUT FULL)を作成します。 機器受領書(OUT FULL)を作成するには、利用者が機器受領書(OUT FULL)を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 機器受領書(OUT FULL)に関する詳細については、[機器受領書(OUT FULL)について]()を参照ください。 |
|
DELETE | /API/v2/Reports/EquipmentInterchangeReceipts-Out-Full/Delete/{reportId} |
機器受領書(OUT FULL)を削除します。 帳票ID(***reportId***)を指定して、機器受領書(OUT FULL)を削除します。 機器受領書(OUT FULL)を削除しても、ルートドキュメントの内容までは削除されません。 申請種別を使用して、作成した機器受領書(OUT FULL)のキャンセルを伝える場合は、キャンセル(***Cancel***)を実施後、帳票の提出(***Submit***)を実施してください。 機器受領書(OUT FULL)に関する詳細については、[機器受領書(OUT FULL)について]()を参照ください。 |
|
DELETE | /API/v2/Reports/EquipmentInterchangeReceipts-Out-Full/DeleteFile/{fileId} |
機器受領書(OUT FULL)の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、機器受領書(OUT FULL)の添付ファイルを削除します。 帳票の添付ファイルを削除できるのは、そのファイルを添付したパートナーに所属している利用者だけです。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
GET | /API/v2/Reports/EquipmentInterchangeReceipts-Out-Full/Get/{reportId} |
機器受領書(OUT FULL)を取得します。 帳票ID(***reportId***)を指定して、機器受領書(OUT FULL)を取得します。 編集が行われていない場合は、ルートドキュメントから最新の機器受領書(OUT FULL)を取得します。 編集中の場合は、先に保存した、機器受領書(OUT FULL)を取得します。 機器受領書(OUT FULL)に関する詳細については、[機器受領書(OUT FULL)について]()を参照ください。 |
|
GET | /API/v2/Reports/EquipmentInterchangeReceipts-Out-Full/GetFile/{fileId} |
機器受領書(OUT FULL)に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、機器受領書(OUT FULL)に添付されたファイルを取得します。 帳票の添付ファイルを獲得できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
GET | /API/v2/Reports/EquipmentInterchangeReceipts-Out-Full/GetList?tradeNo=!{tradeNo}&uniqueNo=!{uniqueNo}&bookingNo=!{bookingNo}&blNo=!{blNo} |
機器受領書(OUT FULL)を全て取得します。 検索条件に該当する機器受領書(OUT FULL)を全て取得します。 編集が行われていない場合は、ルートドキュメントから最新の機器受領書(OUT FULL)を取得します。 編集中の場合は、先に保存した、機器受領書(OUT FULL)を取得します。 機器受領書(OUT FULL)に関する詳細については、[機器受領書(OUT FULL)について]()を参照ください。 |
|
PATCH | /API/v2/Reports/EquipmentInterchangeReceipts-Out-Full/Lock/{reportId} |
編集するため、機器受領書(OUT FULL)をロックします 帳票ID(***reportId***)を指定して、機器受領書(OUT FULL)をロックします。 機器受領書(OUT FULL)を作成(***Create***)した時点では、機器受領書(OUT FULL)をロックが掛かりますが、取得(***Get***)したあとで、機器受領書(OUT FULL)を編集する場合は、このメソッドを呼び出して、機器受領書(OUT FULL)をロックします。 ロックされた機器受領書(OUT FULL)は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、機器受領書(OUT FULL)をルートドキュメントから参照できますが、編集中(ロック中)の機器受領書(OUT FULL)は参照できません。 このロックは、アンロック(***Unlock***)を呼び出すか、帳票の保存後、帳票の提出(***Submit****)を行うと解除されます。 機器受領書(OUT FULL)に関する詳細については、[機器受領書(OUT FULL)について]()を参照ください。 |
|
PATCH | /API/v2/Reports/EquipmentInterchangeReceipts-Out-Full/SetCancel/{reportId} |
機器受領書(OUT FULL)の申請種別をキャンセルします 帳票ID(***reportId***)を指定して、機器受領書(OUT FULL)の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 機器受領書(OUT FULL)に関する詳細については、[機器受領書(OUT FULL)について]()を参照ください。 |
|
PATCH | /API/v2/Reports/EquipmentInterchangeReceipts-Out-Full/Submit/{reportId} |
機器受領書(OUT FULL)を提出します 帳票ID(***reportId***)を指定して、更新(***Update***)した機器受領書(OUT FULL)を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、機器受領書(OUT FULL)が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、機器受領書(OUT FULL)もロックされた状態のままなので、ご注意ください。 機器受領書(OUT FULL)に関する詳細については、[機器受領書(OUT FULL)について]()を参照ください。 |
|
PATCH | /API/v2/Reports/EquipmentInterchangeReceipts-Out-Full/Unlock/{reportId} |
機器受領書(OUT FULL)のロックを解除します 帳票ID(***reportId***)を指定して、機器受領書(OUT FULL)のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 機器受領書(OUT FULL)に関する詳細については、[機器受領書(OUT FULL)について]()を参照ください。 |
|
PATCH | /API/v2/Reports/EquipmentInterchangeReceipts-Out-Full/Update/{reportId} |
機器受領書(OUT FULL)を更新します。 帳票ID(***reportId***)を指定して、機器受領書(OUT FULL)を更新します。 このメソッドでは、機器受領書(OUT FULL)の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 機器受領書(OUT FULL)に関する詳細については、[機器受領書(OUT FULL)について]()を参照ください。 |
|
POST | /API/v2/Reports/EquipmentInterchangeReceipts-Out-Full/UploadFile |
機器受領書(OUT FULL)にファイルを添付します。 指定された機器受領書(OUT FULL)に、ファイルを添付します。 帳票にファイルを添付できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
ExcelFormats
Excelフォーマット
API | Description | ||
---|---|---|---|
DELETE | /API/v2/Master/ExcelFormats/DeleteAdmin/{excelFormatCode} |
Excelフォーマットを削除します。 このAPIはシステム管理者しか呼び出せません。 (*For admin) |
|
GET | /API/v2/Master/ExcelFormats/Get/{excelFormatCode} |
Excelフォーマットを取得します。 Excelフォーマットコード(***excelFormatCode***)を指定して、Excelフォーマットを取得します。 |
|
GET | /API/v2/Master/ExcelFormats/GetFormat/{excelFormatCode} |
Excelフォーマットとなるファイルを取得します。 Excelフォーマットコード(***excelFormatCode***)を指定して、Excelフォーマットとなるファイルを取得します。 |
|
GET | /API/v2/Master/ExcelFormats/GetList?excelFormatCode=!{excelFormatCode}&excelFormatName=!{excelFormatName}&tradeType=!{tradeType}&reportCode=!{reportCode} |
Excelフォーマットを全て取得します。 検索条件を指定して、条件に該当するExcelフォーマットを全て取得します。 |
|
POST | /API/v2/Master/ExcelFormats/RegisterAdmin |
Excelフォーマットを登録します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
POST | /API/v2/Master/ExcelFormats/RegisterInternal |
Excelフォーマットを登録します。 内部呼び出し用。 (*For admin) |
|
PATCH | /API/v2/Master/ExcelFormats/UpdateAdmin/{excelFormatCode} |
Excelフォーマットとなるファイルを更新します。 Excelフォーマットとなるファイルを更新します。 このAPIはシステム管理者しか呼び出せません。 (*For admin) |
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でのレスポンスデータを編集し、指定するようにしてください。 |
ExchangeReports
標準プロセスで取り扱う帳票
API | Description | ||
---|---|---|---|
DELETE | /API/v2/Master/StandardProcesses/ExchangeReports/DeleteAdmin/{exchangeReportCode} |
標準プロセスで取り扱う帳票を登録します。 取り扱う帳票コード(***exchangeReportCode***)を指定して、標準プロセスで取り扱う帳票を削除します。 このAPIはシステム管理者しか呼び出せません。 (*For admin) |
|
GET | /API/v2/Master/StandardProcesses/ExchangeReports/Get/{exchangeReportCode} |
取り扱う帳票コードを指定して、標準プロセスでの取り扱う帳票を取得します 取り扱う帳票コード(***exchangeReportCode***)を指定して、標準プロセスで取り扱う帳票を取得します。 グループ配下のプロセスも含めて、取得する場合は、(***/API/v2/Master/StandardProcesses/GetList***)を使用します。 プロセスに関する詳細については、[プロセスについて]()を参照ください。 |
|
GET | /API/v2/Master/StandardProcesses/ExchangeReports/GetList/{processCode} |
プロセスコードを指定して、標準プロセスで取り扱う帳票を全て取得します プロセスコード(***processCode***)を指定して、指定した標準プロセスで取り扱う帳票を全て取得します。 プロセスに関する詳細については、[プロセスについて]()を参照ください。 |
|
POST | /API/v2/Master/StandardProcesses/ExchangeReports/RegisterAdmin |
標準プロセスで取り扱う帳票を登録します。 このAPIはシステム管理者しか呼び出せません。 (*For admin) |
|
POST | /API/v2/Master/StandardProcesses/ExchangeReports/RegisterInternal |
標準プロセスで取り扱う帳票を登録します。 内部呼び出し用。 (*For admin) |
ExportApprovalCodes
輸出承認証等識別コード
API | Description | ||
---|---|---|---|
DELETE | /API/v2/General/ExportApprovalCodes/DeleteAdmin/{exportApprovalCode} |
輸出承認証等識別コードを削除します。 輸出承認証等識別コード(***exportApprovalCode***)を指定して、輸出承認証等識別コードを削除します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
GET | /API/v2/General/ExportApprovalCodes/Get/{exportApprovalCode} |
輸出承認証等識別を取得します。 輸出承認証等識別コード(***exportApprovalCode***)を指定して、輸出承認証等識別を取得します。 輸出承認証等識別コードに関する詳細については、[輸出承認証等識別コードについて]()を参照ください。 |
|
GET | /API/v2/General/ExportApprovalCodes/GetList |
輸出承認証等識別を全て取得します。 輸出承認証等識別コードに関する詳細については、[輸出承認証等識別コードについて]()を参照ください。 |
|
POST | /API/v2/General/ExportApprovalCodes/RegisterAdmin |
輸出承認証等識別を登録します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
POST | /API/v2/General/ExportApprovalCodes/RegisterInternal |
輸出承認証等識別を登録します。 内部呼び出し用。 (*For admin) |
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でのレスポンスデータを編集し、指定するようにしてください。 |
ExportTradeControlOrdinanceAppendixCodes
輸出貿易管理令別表コード
API | Description | ||
---|---|---|---|
DELETE | /API/v2/General/ExportTradeControlOrdinanceAppendixCodes/DeleteAdmin/{exportTradeControlOrdinanceAppendixCode} |
輸出貿易管理令別表コードを削除します。 輸出貿易管理令別表コード(***exportTradeControlOrdinanceAppendixCode***)を指定して、輸出貿易管理令別表コードを削除します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
GET | /API/v2/General/ExportTradeControlOrdinanceAppendixCodes/Get/{exportTradeControlOrdinanceAppendixCode} |
輸出貿易管理令別表を取得します。 輸出貿易管理令別表コード(***exportTradeControlOrdinanceAppendixCode***)を指定して、輸出貿易管理令別表を取得します。 輸出貿易管理令別表コードに関する詳細については、[輸出貿易管理令別表コードについて]()を参照ください。 |
|
GET | /API/v2/General/ExportTradeControlOrdinanceAppendixCodes/GetList |
輸出貿易管理令別表を全て取得します。 輸出貿易管理令別表コードに関する詳細については、[輸出貿易管理令別表コードについて]()を参照ください。 |
|
POST | /API/v2/General/ExportTradeControlOrdinanceAppendixCodes/RegisterAdmin |
輸出貿易管理令別表を登録します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
POST | /API/v2/General/ExportTradeControlOrdinanceAppendixCodes/RegisterInternal |
輸出貿易管理令別表を登録します。 内部呼び出し用。 (*For admin) |
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でのレスポンスデータを編集し、指定するようにしてください。 |
FreightInformations
フレイト情報
API | Description | ||
---|---|---|---|
POST | /API/v2/Reports/FreightInformations/Create |
フレイト情報を作成します。 フレイト情報を作成するには、利用者が船荷証券(B/L)を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 フレイト情報に関する詳細については、[フレイト情報について]()を参照ください。 |
|
DELETE | /API/v2/Reports/FreightInformations/Delete/{reportId} |
フレイト情報を削除します。 帳票ID(***reportId***)を指定して、フレイト情報を削除します。 フレイト情報を削除しても、ルートドキュメントの内容までは削除されません。 申請種別を使用して、作成したフレイト情報のキャンセルを伝える場合は、キャンセル(***Cancel***)を実施後、帳票の提出(***Submit***)を実施してください。 フレイト情報に関する詳細については、[フレイト情報について]()を参照ください。 |
|
DELETE | /API/v2/Reports/FreightInformations/DeleteFile/{fileId} |
フレイト情報の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、フレイト情報 の添付ファイルを削除します。 帳票の添付ファイルを削除できるのは、そのファイルを添付したパートナーに所属している利用者だけです。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
GET | /API/v2/Reports/FreightInformations/Get/{reportId} |
フレイト情報を取得します。 帳票ID(***reportId***)を指定して、フレイト情報を取得します。 編集が行われていない場合は、ルートドキュメントから最新のフレイト情報を取得します。 編集中の場合は、先に保存した、フレイト情報を取得します。 フレイト情報に関する詳細については、[フレイト情報について]()を参照ください。 |
|
GET | /API/v2/Reports/FreightInformations/GetFile/{fileId} |
フレイト情報に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、フレイト情報に添付されたファイルを取得します。 帳票の添付ファイルを獲得できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
GET | /API/v2/Reports/FreightInformations/GetList?tradeNo=!{tradeNo}&uniqueNo=!{uniqueNo}&bookingNo=!{bookingNo}&blNo=!{blNo} |
フレイト情報を全て取得します。 検索条件に該当するフレイト情報を全て取得します。 編集が行われていない場合は、ルートドキュメントから最新のフレイト情報を取得します。 編集中の場合は、先に保存した、フレイト情報を取得します。 フレイト情報に関する詳細については、[フレイト情報について]()を参照ください。 |
|
PATCH | /API/v2/Reports/FreightInformations/Lock/{reportId} |
編集するため、フレイト情報をロックします 帳票ID(***reportId***)を指定して、フレイト情報をロックします。 フレイト情報を作成(***Create***)した時点では、フレイト情報をロックが掛かりますが、取得(***Get***)したあとで、フレイト情報を編集する場合は、このメソッドを呼び出して、フレイト情報をロックします。 ロックされたフレイト情報は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、フレイト情報をルートドキュメントから参照できますが、編集中(ロック中)の船荷証券(B/L)は参照できません。 このロックは、アンロック(***Unlock***)を呼び出すか、帳票の保存後、帳票の提出(***Submit****)を行うと解除されます。 フレイト情報に関する詳細については、[フレイト情報について]()を参照ください。 |
|
PATCH | /API/v2/Reports/FreightInformations/SetCancel/{reportId} |
フレイト情報の申請種別をキャンセルします 帳票ID(***reportId***)を指定して、フレイト情報の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 フレイト情報に関する詳細については、[フレイト情報について]()を参照ください。 |
|
PATCH | /API/v2/Reports/FreightInformations/Submit/{reportId} |
フレイト情報を提出します 帳票ID(***reportId***)を指定して、更新(***Update***)したフレイト情報を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、フレイト情報が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、フレイト情報もロックされた状態のままなので、ご注意ください。 フレイト情報に関する詳細については、[フレイト情報について]()を参照ください。 |
|
PATCH | /API/v2/Reports/FreightInformations/Unlock/{reportId} |
フレイト情報のロックを解除します 帳票ID(***reportId***)を指定して、フレイト情報のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 フレイト情報に関する詳細については、[フレイト情報について]()を参照ください。 |
|
PATCH | /API/v2/Reports/FreightInformations/Update/{reportId} |
フレイト情報を更新します。 帳票ID(***reportId***)を指定して、フレイト情報を更新します。 このメソッドでは、フレイト情報の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 フレイト情報に関する詳細については、[フレイト情報について]()を参照ください。 |
|
POST | /API/v2/Reports/FreightInformations/UploadFile |
フレイト情報にファイルを添付します。 指定されたフレイト情報に、ファイルを添付します。 帳票にファイルを添付できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
GrantedBusinessTypes
会社の事業種別
API | Description | ||
---|---|---|---|
GET | /API/v2/Companies/GrantedBusinessTypes/GetList |
会社に割り当てられた事業種別を全て取得します。 ログインしている利用者が所属する会社に割り当てられた事業種別を全て取得します。 会社に割り当てられた事業種別に関する詳細については、[会社の事業種別について]()を参照ください。 |
HazardousCargoCodes
危険貨物等コード
API | Description | ||
---|---|---|---|
DELETE | /API/v2/General/HazardousCargoCodes/DeleteAdmin/{hazardousCargoCode} |
危険貨物等コードを削除します。 危険貨物等コード(***hazardousCargoCode***)を指定して、危険貨物等コードを削除します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
GET | /API/v2/General/HazardousCargoCodes/Get/{hazardousCargoCode} |
危険貨物等を取得します。 危険貨物等コード(***hazardousCargoCode***)を指定して、危険貨物等を取得します。 危険貨物等に関する詳細については、きてについて]()を参照ください。 |
|
GET | /API/v2/General/HazardousCargoCodes/GetList |
危険貨物等種別を全て取得します。 危険貨物等コードに関する詳細については、[危険貨物等コードについて]()を参照ください。 |
|
POST | /API/v2/General/HazardousCargoCodes/RegisterAdmin |
危険貨物等を登録します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
POST | /API/v2/General/HazardousCargoCodes/RegisterInternal |
危険貨物等種別を登録します。 内部呼び出し用。 (*For admin) |
Histories
取引内での操作履歴
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権限が必要です。 |
ImportApprovalCodes
輸入承認証等識別コード
API | Description | ||
---|---|---|---|
DELETE | /API/v2/General/ImportApprovalCodes/DeleteAdmin/{importApprovalCode} |
輸入承認証等識別コードを削除します。 輸入承認証等識別コード(***importApprovalCode***)を指定して、輸入承認証等識別コードを削除します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
GET | /API/v2/General/ImportApprovalCodes/Get/{importApprovalCode} |
輸入承認証等識別を取得します。 輸入承認証等識別コード(***importApprovalCode***)を指定して、輸入承認証等識別を取得します。 輸入承認証等識別コードに関する詳細については、[輸入承認証等識別コードについて]()を参照ください。 |
|
GET | /API/v2/General/ImportApprovalCodes/GetList |
輸入承認証等識別を全て取得します。 輸入承認証等識別コードに関する詳細については、[輸入承認証等識別コードについて]()を参照ください。 |
|
POST | /API/v2/General/ImportApprovalCodes/RegisterAdmin |
輸入承認証等識別を登録します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
POST | /API/v2/General/ImportApprovalCodes/RegisterInternal |
輸入承認証等識別を登録します。 内部呼び出し用。 (*For admin) |
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でのレスポンスデータを編集し、指定するようにしてください。 |
ImportInstructions
輸入指図書
API | Description | ||
---|---|---|---|
POST | /API/v2/Reports/ImportInstructions/Create |
輸入指図書を作成します。 輸入指図書を作成するには、利用者が輸入指図書を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 輸入指図書に関する詳細については、[輸入指図書について]()を参照ください。 |
|
DELETE | /API/v2/Reports/ImportInstructions/Delete/{reportId} |
輸入指図書を削除します。 帳票ID(***reportId***)を指定して、輸入指図書を削除します。 輸入指図書を削除しても、ルートドキュメントの内容までは削除されません。 申請種別を使用して、作成した輸入指図書のキャンセルを伝える場合は、キャンセル(***Cancel***)を実施後、帳票の提出(***Submit***)を実施してください。 輸入指図書に関する詳細については、[輸入指図書について]()を参照ください。 |
|
DELETE | /API/v2/Reports/ImportInstructions/DeleteFile/{fileId} |
輸入指図書の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、輸入指図書の添付ファイルを削除します。 帳票の添付ファイルを削除できるのは、そのファイルを添付したパートナーに所属している利用者だけです。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
GET | /API/v2/Reports/ImportInstructions/Get/{reportId} |
輸入指図書を取得します。 帳票ID(***reportId***)を指定して、輸入指図書を取得します。 編集が行われていない場合は、ルートドキュメントから最新の輸入指図書を取得します。 編集中の場合は、先に保存した、輸入指図書を取得します。 輸入指図書に関する詳細については、[輸入指図書について]()を参照ください。 |
|
GET | /API/v2/Reports/ImportInstructions/GetFile/{fileId} |
輸入指図書に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、輸入指図書に添付されたファイルを取得します。 帳票の添付ファイルを獲得できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
GET | /API/v2/Reports/ImportInstructions/GetList?tradeNo=!{tradeNo}&uniqueNo=!{uniqueNo}&bookingNo=!{bookingNo}&blNo=!{blNo} |
輸入指図書を全て取得します。 検索条件に該当する輸入指図書を全て取得します。 編集が行われていない場合は、ルートドキュメントから最新の輸入指図書を取得します。 編集中の場合は、先に保存した、輸入指図書を取得します。 輸入指図書に関する詳細については、[輸入指図書について]()を参照ください。 |
|
PATCH | /API/v2/Reports/ImportInstructions/Lock/{reportId} |
編集するため、輸入指図書をロックします 帳票ID(***reportId***)を指定して、輸入指図書をロックします。 輸入指図書を作成(***Create***)した時点では、輸入指図書をロックが掛かりますが、取得(***Get***)したあとで、輸入指図書を編集する場合は、このメソッドを呼び出して、輸入指図書をロックします。 ロックされた輸入指図書は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、輸入指図書をルートドキュメントから参照できますが、編集中(ロック中)の輸入指図書は参照できません。 このロックは、アンロック(***Unlock***)を呼び出すか、帳票の保存後、帳票の提出(***Submit****)を行うと解除されます。 輸入指図書に関する詳細については、[輸入指図書について]()を参照ください。 |
|
PATCH | /API/v2/Reports/ImportInstructions/SetCancel/{reportId} |
輸入指図書の申請種別をキャンセルします 帳票ID(***reportId***)を指定して、輸入指図書の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 輸入指図書に関する詳細については、[輸入指図書について]()を参照ください。 |
|
PATCH | /API/v2/Reports/ImportInstructions/Submit/{reportId} |
輸入指図書を提出します 帳票ID(***reportId***)を指定して、更新(***Update***)した輸入指図書を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、輸入指図書が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、輸入指図書もロックされた状態のままなので、ご注意ください。 輸入指図書に関する詳細については、[輸入指図書について]()を参照ください。 |
|
PATCH | /API/v2/Reports/ImportInstructions/Unlock/{reportId} |
輸入指図書のロックを解除します 帳票ID(***reportId***)を指定して、輸入指図書のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 輸入指図書に関する詳細については、[輸入指図書について]()を参照ください。 |
|
PATCH | /API/v2/Reports/ImportInstructions/Update/{reportId} |
輸入指図書を更新します。 帳票ID(***reportId***)を指定して、輸入指図書を更新します。 このメソッドでは、輸入指図書の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 輸入指図書に関する詳細については、[輸入指図書について]()を参照ください。 |
|
POST | /API/v2/Reports/ImportInstructions/UploadFile |
輸入指図書にファイルを添付します。 指定された輸入指図書に、ファイルを添付します。 帳票にファイルを添付できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
ImportTradeControlOrdinanceAppendixCodes
輸入貿易管理令別表コード
API | Description | ||
---|---|---|---|
DELETE | /API/v2/General/ImportTradeControlOrdinanceAppendixCodes/DeleteAdmin/{importTradeControlOrdinanceAppendixCode} |
輸入貿易管理令別表コードを削除します。 輸入貿易管理令別表コード(***importTradeControlOrdinanceAppendixCode***)を指定して、輸入貿易管理令別表コードを削除します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
GET | /API/v2/General/ImportTradeControlOrdinanceAppendixCodes/Get/{importTradeControlOrdinanceAppendixCode} |
輸入貿易管理令別表を取得します。 輸入貿易管理令別表コード(***importTradeControlOrdinanceAppendixCode***)を指定して、輸入貿易管理令別表を取得します。 輸入貿易管理令別表コードに関する詳細については、[輸入貿易管理令別表コードについて]()を参照ください。 |
|
GET | /API/v2/General/ImportTradeControlOrdinanceAppendixCodes/GetList |
輸入貿易管理令別表を全て取得します。 輸入貿易管理令別表コードに関する詳細については、[輸入貿易管理令別表コードについて]()を参照ください。 |
|
POST | /API/v2/General/ImportTradeControlOrdinanceAppendixCodes/RegisterAdmin |
輸入貿易管理令別表を登録します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
POST | /API/v2/General/ImportTradeControlOrdinanceAppendixCodes/RegisterInternal |
輸入貿易管理令別表を登録します。 内部呼び出し用。 (*For admin) |
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でのレスポンスデータを編集し、指定するようにしてください。 |
Messages
取引内のメッセージ
API | Description | ||
---|---|---|---|
PATCH | /API/v2/Trades/Messages/Edit/{historyId} |
送信した取引内のメッセージを更新します。 メッセージID(***messageId***)を指定して、送信した取引内のメッセージを更新します。 |
|
GET | /API/v2/Trades/Messages/GetDetails/{historyId} |
取引内のメッセージを取得します。 履歴ID(***historyId***)を指定して、その操作に対するメッセージを返信メッセージも含めて、取得します。 |
|
GET | /API/v2/Trades/Messages/GetHistories/{historyId} |
取引内のメッセージについての履歴を取得します。 履歴ID(***historyId***)を指定して、その操作に対するメッセージの履歴を取得します。 |
|
PATCH | /API/v2/Trades/Messages/MarkAsDelete/{historyId} |
送信した取引内のメッセージのメッセージ内容を削除します。 メッセージID(***messageId***)を指定して、送信した取引内のメッセージを削除としてマークします。 削除してマークされたメッセージは、メッセージ内容が確認できなくなります。 |
|
POST | /API/v2/Trades/Messages/Reply |
取引内のメッセージを返信します。 取引内でメッセージを返信します。 取引内のメッセージに関する詳細については、[取引内のメッセージでの操作履歴について]()を参照ください。 |
|
POST | /API/v2/Trades/Messages/Send |
取引内のメッセージを送信します。 取引のパートナーに対して、メッセージを送信します。 取引内のメッセージに関する詳細については、[取引内のメッセージでの操作履歴について]()を参照ください。 |
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でのレスポンスデータを編集し、指定するようにしてください。 |
MultimodalTransportBillOfLadings
複合運送証券
API | Description | ||
---|---|---|---|
POST | /API/v2/Reports/MultimodalTransportBillOfLadings/Create |
複合運送証券を作成します。 複合運送証券を作成するには、利用者が複合運送証券を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 複合運送証券に関する詳細については、[複合運送証券について]()を参照ください。 |
|
DELETE | /API/v2/Reports/MultimodalTransportBillOfLadings/Delete/{reportId} |
複合運送証券を削除します。 帳票ID(***reportId***)を指定して、複合運送証券を削除します。 複合運送証券を削除しても、ルートドキュメントの内容までは削除されません。 申請種別を使用して、作成した複合運送証券のキャンセルを伝える場合は、キャンセル(***Cancel***)を実施後、帳票の提出(***Submit***)を実施してください。 複合運送証券に関する詳細については、[複合運送証券について]()を参照ください。 |
|
DELETE | /API/v2/Reports/MultimodalTransportBillOfLadings/DeleteFile/{fileId} |
複合運送証券の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、複合運送証券の添付ファイルを削除します。 帳票の添付ファイルを削除できるのは、そのファイルを添付したパートナーに所属している利用者だけです。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
GET | /API/v2/Reports/MultimodalTransportBillOfLadings/Get/{reportId} |
複合運送証券を取得します。 帳票ID(***reportId***)を指定して、複合運送証券を取得します。 編集が行われていない場合は、ルートドキュメントから最新の複合運送証券を取得します。 編集中の場合は、先に保存した、複合運送証券を取得します。 複合運送証券に関する詳細については、[複合運送証券について]()を参照ください。 |
|
GET | /API/v2/Reports/MultimodalTransportBillOfLadings/GetFile/{fileId} |
複合運送証券に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、複合運送証券に添付されたファイルを取得します。 帳票の添付ファイルを獲得できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
GET | /API/v2/Reports/MultimodalTransportBillOfLadings/GetList?tradeNo=!{tradeNo}&uniqueNo=!{uniqueNo}&bookingNo=!{bookingNo}&blNo=!{blNo} |
複合運送証券を全て取得します。 検索条件に該当する複合運送証券を全て取得します。 編集が行われていない場合は、ルートドキュメントから最新の複合運送証券を取得します。 編集中の場合は、先に保存した、複合運送証券を取得します。 複合運送証券に関する詳細については、[複合運送証券について]()を参照ください。 |
|
PATCH | /API/v2/Reports/MultimodalTransportBillOfLadings/Lock/{reportId} |
編集するため、複合運送証券をロックします 帳票ID(***reportId***)を指定して、複合運送証券をロックします。 複合運送証券を作成(***Create***)した時点では、複合運送証券をロックが掛かりますが、取得(***Get***)したあとで、複合運送証券を編集する場合は、このメソッドを呼び出して、複合運送証券をロックします。 ロックされた複合運送証券は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、海上運送状(ウェイビル)をルートドキュメントから参照できますが、編集中(ロック中)の複合運送証券は参照できません。 このロックは、アンロック(***Unlock***)を呼び出すか、帳票の保存後、帳票の提出(***Submit****)を行うと解除されます。 複合運送証券に関する詳細については、[複合運送証券について]()を参照ください。 |
|
PATCH | /API/v2/Reports/MultimodalTransportBillOfLadings/SetCancel/{reportId} |
複合運送証券の申請種別をキャンセルします 帳票ID(***reportId***)を指定して、複合運送証券の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 複合運送証券に関する詳細については、[複合運送証券について]()を参照ください。 |
|
PATCH | /API/v2/Reports/MultimodalTransportBillOfLadings/Submit/{reportId} |
複合運送証券を提出します 帳票ID(***reportId***)を指定して、更新(***Update***)した複合運送証券を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、複合運送証券が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、複合運送証券もロックされた状態のままなので、ご注意ください。 複合運送証券に関する詳細については、[複合運送証券について]()を参照ください。 |
|
PATCH | /API/v2/Reports/MultimodalTransportBillOfLadings/Unlock/{reportId} |
複合運送証券のロックを解除します 帳票ID(***reportId***)を指定して、複合運送証券のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 複合運送証券に関する詳細については、[複合運送証券について]()を参照ください。 |
|
PATCH | /API/v2/Reports/MultimodalTransportBillOfLadings/Update/{reportId} |
複合運送証券を更新します。 帳票ID(***reportId***)を指定して、複合運送証券を更新します。 このメソッドでは、複合運送証券の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 複合運送証券に関する詳細については、[複合運送証券について]()を参照ください。 |
|
POST | /API/v2/Reports/MultimodalTransportBillOfLadings/UploadFile |
複合運送証券にファイルを添付します。 指定された複合運送証券に、ファイルを添付します。 帳票にファイルを添付できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
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連携添付ファイル付加情報を登録します。 |
NaccsBusinessTypes
NACCS業務
API | Description | ||
---|---|---|---|
DELETE | /API/v2/General/NaccsBusinessTypes/DeleteAdmin/{naccsBusinessCode} |
NACCS業務を削除します。 NACCS業務コード(***naccsBusinessCode***)を指定して、NACCS業務を削除します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
GET | /API/v2/General/NaccsBusinessTypes/Get/{naccsBusinessCode} |
NACCS業務を取得します。 NACCS業務コード(***naccsBusinessCode***)を指定して、NACCS業務を取得します。 NACCS業務に関する詳細については、[NACCS業務について]()を参照ください。 |
|
GET | /API/v2/General/NaccsBusinessTypes/GetList |
NACCS業務を全て取得します。 NACCS業務を全て取得します。 NACCS業務に関する詳細については、[NACCS業務について]()を参照ください。 |
|
POST | /API/v2/General/NaccsBusinessTypes/RegisterAdmin |
NACCS業務を登録します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
POST | /API/v2/General/NaccsBusinessTypes/RegisterInternal |
事業種別を登録します。 内部呼び出し用。 (*For admin) |
NaccsExportControls
NACCS出力制御
API | Description | ||
---|---|---|---|
DELETE | /API/v2/General/NaccsExportControls/DeleteAdmin/{naccsExportControlCode} |
NACCS出力制御を削除します。 NACCS出力制御コード(***naccsExportControlCode***)を指定して、NACCS出力制御を削除します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
GET | /API/v2/General/NaccsExportControls/Get/{naccsExportControlCode} |
NACCS出力制御を取得します。 NACCS出力制御コード(***naccsExportControlCode***)を指定して、NACCS出力制御を取得します。 NACCS出力制御に関する詳細については、[NACCS出力制御について]()を参照ください。 |
|
GET | /API/v2/General/NaccsExportControls/Get{naccsExportControlCode} |
NACCS出力制御を取得します。 NACCS出力制御コード(***naccsExportControlCode***)を指定して、NACCS出力制御を取得します。 NACCS出力制御に関する詳細については、[NACCS出力制御について]()を参照ください。 |
|
GET | /API/v2/General/NaccsExportControls/GetList |
NACCS出力制御を全て取得します。 NACCS出力制御に関する詳細については、[NACCS出力制御について]()を参照ください。 |
|
POST | /API/v2/General/NaccsExportControls/RegisterAdmin |
NACCS出力制御を登録します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
POST | /API/v2/General/NaccsExportControls/RegisterInternal |
出力制御種別を登録します。 内部呼び出し用。 (*For admin) |
NaccsImportControls
NACCS取込制御
API | Description | ||
---|---|---|---|
DELETE | /API/v2/General/NaccsImportControls/DeleteAdmin/{naccsImportControlCode} |
NACCS取入制御を削除します。 NACCS取入制御コード(***naccsImportControlCode***)を指定して、NACCS取入制御を削除します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
GET | /API/v2/General/NaccsImportControls/Get/{naccsImportControlCode} |
NACCS取入制御を取得します。 NACCS取入制御コード(***naccsImportControlCode***)を指定して、NACCS取入制御を取得します。 NACCS取入制御に関する詳細については、[NACCS取入制御について]()を参照ください。 |
|
GET | /API/v2/General/NaccsImportControls/GetList |
NACCS取入制御を全て取得します。 NACCS取入制御に関する詳細については、[NACCS取入制御について]()を参照ください。 |
|
POST | /API/v2/General/NaccsImportControls/RegisterAdmin |
NACCS取引制御を登録します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
POST | /API/v2/General/NaccsImportControls/RegisterInternal |
取引制御種別を登録します。 内部呼び出し用。 (*For admin) |
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メッセージマスタ一覧取得 |
NaccsMessages
NACCSメッセージ
API | Description | ||
---|---|---|---|
DELETE | /API/v2/General/NaccsMessages/DeleteAdmin/{naccsMessageId} |
NACCSメッセージを削除します。 NACCSメッセージID(***naccsMessageId***)を指定して、NACCSメッセージを削除します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
DELETE | /API/v2/General/NaccsMessages/DeleteAdminByNaccsBusinessCode/{naccsBusinessCode} |
NACCSメッセージをNACCS業務コード単位で削除します。 NACCS業務コード(***naccsBusinessCode***)を指定して、NACCSメッセージを削除します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
GET | /API/v2/General/NaccsMessages/Get/{naccsMessageId} |
NACCSメッセージを取得します。 NACCSメッセージID(***naccsMessageId***)を指定して、NACCSメッセージを取得します。 |
|
GET | /API/v2/General/NaccsMessages/GetList?naccsBusinessCode={naccsBusinessCode} |
NACCSメッセージを取得します。 NACCS業務コードに該当する全てメッセージを取得します。 |
|
GET | /API/v2/General/NaccsMessages/GetListInternal?naccsMessageId=!{naccsMessageId}&naccsBusinessCode=!{naccsBusinessCode} |
NACCSメッセージを取得します。 検索条件に該当するメッセージを全て取得します。 内部呼び出し用。 |
|
POST | /API/v2/General/NaccsMessages/RegisterAdmin |
NACCS停止スケジュールを登録します。 このAPIはシステム管理者しか呼び出せません。 (*For admin) |
|
POST | /API/v2/General/NaccsMessages/RegisterInternal |
NACCS停止スケジュールを登録します。 内部呼び出し用。 (*For admin) |
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連携送信権限一覧取得 |
NaccsSendPermissions
帳票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停止スケジュールをフィルター条件を付けて取得する。 |
NaccsShutdownSchedules
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利用者登録情報一覧取得 |
NaccsUsers
NACCS利用者
API | Description | ||
---|---|---|---|
GET | /API/v2/Companies/NaccsUsers/ConnectivityTest |
NACCS利用者の疎通確認を実施します。 登録されたNACCS利用者を基に、NACCSとの疎通確認を実施します。 疎通に成功した場合は、trueを返却します。 NACCS 利用者に関する詳細については、[NACCS 利用者について]()を参照ください。 |
|
DELETE | /API/v2/Companies/NaccsUsers/Delete/{naccsUserId} |
NACCS利用者を削除します。 NACCS利用者ID(***naccsUserId***)を指定して、自社に登録されているNACCS利用者を削除します。 NACCS 利用者に関する詳細については、[NACCS 利用者について]()を参照ください。 |
|
GET | /API/v2/Companies/NaccsUsers/Get/{naccsUserId} |
NACCS利用者を取得します。 NACCS利用者ID(***naccsUserId***)を指定して、自社に登録されているNACCS利用者を取得します。 NACCS 利用者に関する詳細については、[NACCS 利用者について]()を参照ください。 |
|
GET | /API/v2/Companies/NaccsUsers/GetList |
自社に登録されているNACCS利用者を全て取得します。 NACCS 利用者に関する詳細については、[NACCS 利用者について]()を参照ください。 |
|
GET | /API/v2/Companies/NaccsUsers/GetList?naccsUserId=!{naccsUserId}&naccsUserCode=!{naccsUserCode}&naccsIdNo=!{naccsIdNo}¬e=!{note} |
NACCS利用者を全て取得します。 検索条件に該当する、自社に登録されているNACCS利用者を全て取得します。 NACCS 利用者に関する詳細については、[NACCS 利用者について]()を参照ください。 |
|
POST | /API/v2/Companies/NaccsUsers/Register |
NACCS利用者を登録します。 NACCS センターより付与された NACCS 利用者(利用者コード、識別番号、パスワード)をサイバーポートに登録します。 このメソッドは会社の管理者(***/API/v2/Companies/Administrators***)として登録された利用者が利用できます。 NACCS 利用者に関する詳細については、[NACCS 利用者について]()を参照ください。 |
NotifiableOperations
通知可能な操作
API | Description | ||
---|---|---|---|
DELETE | /API/v2/Master/NotifiableOperations/DeleteAdmin/{notifiableOperationCode} |
通知可能な操作を削除します。 このAPIはシステム管理者しか呼び出せません。 (*For admin) |
|
GET | /API/v2/Master/NotifiableOperations/Get/{notifiableOperationCode} |
通知可能な操作を取得します。 通知可能な操作コード(***notifiableOperationCode***)を指定して、通知可能な操作を取得します。 通知可能な操作に関する詳細については、、[通知可能な操作について]()を参照ください。 |
|
GET | /API/v2/Master/NotifiableOperations/GetList |
通知可能な操作を全て取得します。 通知可能な操作を全て取得します。 通知可能な操作に関する詳細については、[通知可能な操作について]()を参照ください。 |
|
POST | /API/v2/Master/NotifiableOperations/RegisterAdmin |
通知可能な操作を登録します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
POST | /API/v2/Master/NotifiableOperations/RegisterInternal |
通知可能な操作を登録します。 内部呼び出し用。 (*For admin) |
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を指定します。 |
NotifyOperationByMails
利用者のメール通知設定
API | Description | ||
---|---|---|---|
DELETE | /API/v2/Employees/NotifyOperationByMails/Delete/{employeeNotifyId} |
利用者の通知設定を削除します。 利用者の通知設定ID(***employeeNotifyId***)を指定して、利用者の通知設定を削除します。 利用者の通知設定に関する詳細については、[利用者の通知設定について]()を参照ください。 |
|
GET | /API/v2/Employees/NotifyOperationByMails/Get/{employeeNotifyId} |
利用者の通知設定を取得します。 利用者の通知設定ID(***employeeNotifyId***)を指定して、利用者の通知設定を取得します。 利用者の通知設定に関する詳細については、[利用者の通知設定について]()を参照ください。 |
|
GET | /API/v2/Employees/NotifyOperationByMails/GetList |
利用者の通知設定を全て取得します。 ログインしている利用者の通知設定を全て取得します。 利用者の通知設定に関する詳細については、[利用者の通知設定について]()を参照ください。 |
NotifyOperations
Webhookの通知設定
API | Description | ||
---|---|---|---|
DELETE | /API/v2/Organizations/UsedWebhooks/NotifyOperations/Delete/{webhookNotifyId} |
Webhookの通知設定を削除します。 Webhookの通知設定ID(***webhookNotifyId***)を指定して、Webhookの通知設定を削除します。 このメソッドは会社の管理者(***/API/v2/Companies/Administrators***)として登録された利用者が利用できます。 Webhookの通知設定に関する詳細については、[Webhookの通知設定について]()を参照ください。 |
|
GET | /API/v2/Organizations/UsedWebhooks/NotifyOperations/Get/{webhookNotifyId} |
Webhookの通知設定を取得します。 Webhookの通知設定ID(***webhookNotifyId***)を指定して、Wenhookの通知設定を取得します。 Webhookの通知設定に関する詳細については、[Webhookの通知設定について]()を参照ください。 |
|
GET | /API/v2/Organizations/UsedWebhooks/NotifyOperations/GetList/{usedWebhookId} |
Webhookの通知設定を全て取得します。 Webhook設定(***webhookId**)を指定して、Webhookの通知設定を全て取得します。 Webhookの通知設定に関する詳細については、[Webhookの通知設定について]()を参照ください。 |
|
POST | /API/v2/Organizations/UsedWebhooks/NotifyOperations/Register |
Webhookの通知設定を登録します。 管理者が所属する会社に登録されたWebookの通知設定を登録します。 このメソッドは会社の管理者(***/API/v2/Companies/Administrators***)として登録された利用者が利用できます。 Webhookの通知設定に関する詳細については、[Webhookの通知設定について]()を参照ください。 |
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} |
ブッキング番号でトラッキングデータを取得します。 |
OperationTypes
操作種別
API | Description | ||
---|---|---|---|
DELETE | /API/v2/Master/OperationTypes/DeleteAdmin/{operationTypeCode} |
操作種別を削除します。 操作種別コード(***operationTypeCode***)を指定して、操作種別を削除します。 このAPIはシステム管理者しか呼び出せません。 (*For admin) |
|
GET | /API/v2/Master/OperationTypes/Get/{operationTypeCode} |
操作種別を取得します。 操作種別コード(***operationTypeCode***)を指定して、操作種別を取得します。 |
|
GET | /API/v2/Master/OperationTypes/GetList |
操作種別を全て取得します。 操作種別を全て取得します。 |
|
POST | /API/v2/Master/OperationTypes/RegisterAdmin |
操作種別を登録します。 このAPIはシステム管理者しか呼び出せません。 (*For admin) |
|
POST | /API/v2/Master/OperationTypes/RegisterInternal |
操作種別を登録します。 内部呼び出し用。 (*For admin) |
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)。 |
Organizations
組織
API | Description | ||
---|---|---|---|
DELETE | /API/v2/Organizations/Delete/{organizationId} |
組織を削除します。 組織ID(organizationId)を指定して、組織を削除します。 このメソッドは会社の管理者(***/API/v2/Companies/Administrators***)として登録された利用者が利用できます。 また、取引に参加している組織については、削除は行えません。 組織に関する詳細については、[組織について]()を参照ください。 |
|
GET | /API/v2/Organizations/Get/{organizationId} |
組織を取得します。 組織ID(***organizationId***)を指定して、組織を取得します。 組織に関する詳細については、[組織について]()を参照ください。 |
|
GET | /API/v2/Organizations/GetAccessibleReports/{organizationId} |
組織がアクセス可能な帳票を全て取得します。 組織がアクセス可能な帳票を全て取得します。 アクセス可能な帳票は、組織に割り当てられた事業種別を条件に、(***/API/v2/Master/ReportTypes/Permissions****)で、アクセス権限がR権限以上のものを取得します。 |
|
GET | /API/v2/Organizations/GetMyList?organizationId=!{organizationId} |
会社配下の組織を全て取得します。 ログインしている利用者が所属する会社配下に登録されている全ての組織を取得します。 有効でない組織(isActive=false)を含めて、会社配下に登録されている全ての組織を取得します。 組織に関する詳細については、[組織について]()を参照ください。 |
|
GET | /API/v2/Organizations/IsUnique/{organizationId} |
組織IDが一意であるかを判定します。 組織ID(***organizationId***)を指定して、組織IDが一意であるか(このIDで組織を追加できるのか)を判定します。 組織に関する詳細については、[組織について]()を参照ください。 |
|
POST | /API/v2/Organizations/Register |
所属する会社に組織を登録します。 管理者が所属する会社に、組織を登録します。 このメソッドは会社の管理者(***/API/v2/Companies/Administrators***)として登録された利用者が利用できます。 組織に関する詳細については、[組織について]()を参照ください。 |
|
GET | /API/v2/Organizations/Search?corporateNo=!{corporateNo}&companyName=!{companyName}&companyNameEn=!{companyNameEn}&organizationName=!{organizationName}&organizationNameEn=!{organizationNameEn}&businessTypeCodeList=!{businessTypeCodeList} |
検索条件に該当する組織を取得します。 検索条件を指定して、条件に該当する組織を全て取得します。非公開の組織(***permitSearchByName=false***)や無効な組織(***isActive=false***)は検索対象外となります。 組織に関する詳細については、[組織について]()を参照ください。 |
|
PATCH | /API/v2/Organizations/SetActive/{organizationId} |
組織が有効であるか(isActive)を更新します。 組織ID(***organizationId***)を指定して、組織が有効であるか(isActive)を更新します。 isActiveをfalseにすると、その組織は、 - 参加していた取引は参照できますが、取引内での操作は行えません。 - 新しい取引を作成したり、取引のパートナーとして参加することは出来ません。 このメソッドは会社の管理者(***/API/v2/Companies/Administrators***)として登録された利用者が利用できます。 組織に関する詳細については、[組織について]()を参照ください。 |
|
PATCH | /API/v2/Organizations/Update/{organizationId} |
組織を更新します。 組織ID(***organizationId***)を指定して、組織を更新します。 更新する組織は、ログインしている利用者が所属する会社配下になければなりません。 このメソッドは会社の管理者(***/API/v2/Companies/Administrators***)として登録された利用者が利用できます。 組織に関する詳細については、[組織について]()を参照ください。 |
OrgEmployees
組織・利用者マスタ
API | Description | ||
---|---|---|---|
GET | /API/v1/Master/OrgEmployees/Get/{orgEmployeeId} |
組織・利用者マスタから、組織・利用者IDを指定して、組織と利用者の情報を取得します。 ただし、自社の組織・利用者情報に限ります。他社の組織・利用者情報は取得出来ません |
|
GET | /API/v1/Master/OrgEmployees/GetList?filter={filter}&orderby={orderby} |
組織・利用者マスタから、検索条件に該当する組織・利用者を全て取得します。 ただし、自社の組織・利用者情報に限ります。他社の組織・利用者情報は取得出来ません。 |
OtherLawCodes
他法令コード
API | Description | ||
---|---|---|---|
DELETE | /API/v2/General/OtherLawCodes/DeleteAdmin/{otherLawCode} |
他法令コードを削除します。 他法令コード(***otherLawCode***)を指定して、他法令コードを削除します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
GET | /API/v2/General/OtherLawCodes/Get/{otherLawCode} |
他法令種別を取得します。 他法令コード(***otherLawCode***)を指定して、他法令種別を取得します。 他法令コードに関する詳細については、[他法令コードについて]()を参照ください。 |
|
GET | /API/v2/General/OtherLawCodes/GetList |
他法令種別を全て取得します。 他法令コードに関する詳細については、[他法令コードについて]()を参照ください。 |
|
POST | /API/v2/General/OtherLawCodes/RegisterAdmin |
他法令種別を登録します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
POST | /API/v2/General/OtherLawCodes/RegisterInternal |
他法令種別を登録します。 内部呼び出し用。 (*For admin) |
PackageTypeCodes
包装種類コード(UN/ECE勧告第21号・英字)
API | Description | ||
---|---|---|---|
DELETE | /API/v2/General/PackageTypeCodes/DeleteAdmin/{packageTypeCode} |
包装種類コードを削除します。 包装種類コード(***packageTypeCode***)を指定して、包装種類コードを削除します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
GET | /API/v2/General/PackageTypeCodes/Get/{packageTypeCode} |
包装種類を取得します。 包装種類コード(***packageTypeCode***)を指定して、包装種類を取得します。 包装種類コードに関する詳細については、[包装コードについて]()を参照ください。 |
|
GET | /API/v2/General/PackageTypeCodes/GetList |
包装種類を全て取得します。 包装種類コードに関する詳細については、[包装種類コードについて]()を参照ください。 |
|
POST | /API/v2/General/PackageTypeCodes/RegisterAdmin |
包装種類を登録します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
POST | /API/v2/General/PackageTypeCodes/RegisterInternal |
包装種類を登録します。 内部呼び出し用。 (*For admin) |
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でのレスポンスデータを編集し、指定するようにしてください。 |
PackingLists
パッキングリスト(P/L)
API | Description | ||
---|---|---|---|
POST | /API/v2/Reports/PackingLists/Create |
パッキングリスト(P/L)を作成します。 パッキングリスト(P/L)を作成するには、利用者が商業送り状(I/V)を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 パッキングリスト(P/L)に関する詳細については、[パッキングリスト(P/L)について]()を参照ください。 |
|
DELETE | /API/v2/Reports/PackingLists/Delete/{reportId} |
パッキングリスト(P/L)を削除します。 帳票ID(***reportId***)を指定して、パッキングリスト(P/L)を削除します。 パッキングリスト(P/L)を削除しても、ルートドキュメントの内容までは削除されません。 申請種別を使用して、作成したパッキングリスト(P/L)のキャンセルを伝える場合は、キャンセル(***Cancel***)を実施後、帳票の提出(***Submit***)を実施してください。 パッキングリスト(P/L)に関する詳細については、[パッキングリスト(P/L)について]()を参照ください。 |
|
DELETE | /API/v2/Reports/PackingLists/DeleteFile/{fileId} |
パッキングリスト(P/L)の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、商業送り状(I/V)の添付ファイルを削除します。 帳票の添付ファイルを削除できるのは、そのファイルを添付したパートナーに所属している利用者だけです。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
GET | /API/v2/Reports/PackingLists/Get/{reportId} |
パッキングリスト(P/L)を取得します。 帳票ID(***reportId***)を指定して、パッキングリスト(P/L)を取得します。 編集が行われていない場合は、ルートドキュメントから最新のブッキング依頼書を取得します。 編集中の場合は、先に保存した、パッキングリスト(P/L)を取得します。 パッキングリスト(P/L)に関する詳細については、[パッキングリスト(P/L)について]()を参照ください。 |
|
GET | /API/v2/Reports/PackingLists/GetFile/{fileId} |
パッキングリスト(P/L)に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、商業送り状(I/V)に添付されたファイルを取得します。 帳票の添付ファイルを獲得できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
GET | /API/v2/Reports/PackingLists/GetList?tradeNo=!{tradeNo}&uniqueNo=!{uniqueNo}&bookingNo=!{bookingNo}&blNo=!{blNo} |
パッキングリスト(P/L)を全て取得します。 検索条件に該当するパッキングリスト(P/L)を全て取得します。 編集が行われていない場合は、ルートドキュメントから最新のパッキングリスト(P/L)を取得します。 編集中の場合は、先に保存した、パッキングリスト(P/L)を取得します。 パッキングリスト(P/L)に関する詳細については、[パッキングリスト(P/L)について]()を参照ください。 |
|
PATCH | /API/v2/Reports/PackingLists/Lock/{reportId} |
編集するため、パッキングリスト(P/L)をロックします 帳票ID(***reportId***)を指定して、パッキングリスト(P/L)をロックします。 パッキングリスト(P/L)を作成(***Create***)した時点では、パッキングリスト(P/L)をロックが掛かりますが、取得(***Get***)したあとで、パッキングリスト(P/L)を編集する場合は、このメソッドを呼び出して、パッキングリスト(P/L)をロックします。 ロックされたパッキングリスト(P/L)は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、パッキングリスト(P/L)をルートドキュメントから参照できますが、編集中(ロック中)のパッキングリスト(P/L)は参照できません。 このロックは、アンロック(***Unlock***)を呼び出すか、帳票の保存後、帳票の提出(***Submit****)を行うと解除されます。 パッキングリスト(P/L)に関する詳細については、[パッキングリスト(P/L)について]()を参照ください。 |
|
PATCH | /API/v2/Reports/PackingLists/SetCancel/{reportId} |
パッキングリスト(P/L)の申請種別をキャンセルします 帳票ID(***reportId***)を指定して、パッキングリスト(P/L)の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 パッキングリスト(P/L)に関する詳細については、[パッキングリスト(P/L)について]()を参照ください。 |
|
PATCH | /API/v2/Reports/PackingLists/Submit/{reportId} |
パッキングリスト(P/L)を提出します 帳票ID(***reportId***)を指定して、更新(***Update***)したパッキングリスト(P/L)を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、パッキングリスト(P/L)が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、パッキングリスト(P/L)もロックされた状態のままなので、ご注意ください。 パッキングリスト(P/L)に関する詳細については、[パッキングリスト(P/L)について]()を参照ください。 |
|
PATCH | /API/v2/Reports/PackingLists/Unlock/{reportId} |
パッキングリスト(P/L)のロックを解除します 帳票ID(***reportId***)を指定して、パッキングリスト(P/L)のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 パッキングリスト(P/L)に関する詳細については、[パッキングリスト(P/L)について]()を参照ください。 |
|
PATCH | /API/v2/Reports/PackingLists/Update/{reportId} |
パッキングリスト(P/L)を更新します。 帳票ID(***reportId***)を指定して、パッキングリスト(P/L)を更新します。 このメソッドでは、パッキングリスト(P/L)の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 パッキングリスト(P/L)に関する詳細については、[パッキングリスト(P/L)について]()を参照ください。 |
|
POST | /API/v2/Reports/PackingLists/UploadFile |
パッキングリスト(P/L)にファイルを添付します。 指定されたパッキングリスト(P/L)に、ファイルを添付します。 帳票にファイルを添付できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
Partners
取引のパートナー
API | Description | ||
---|---|---|---|
DELETE | /API/v2/Trades/Partners/Delete/{partnerId} |
パートナーIDを指定して、取引のパートナーを削除します。 パートナーID(***partnerId***)を指定して、取引のパートナーを削除します。 このメソッドを呼び出す利用者は、対象となる取引に利用者が所属する組織が参加しており、さらに、取引から削除するパートナーを招待した組織に所属している必要があります。 取引からパートナーを削除すると、そのパートナーが作成した帳票は全て削除されます。 取引のパートナーに関する詳細については、[取引のパートナーについて]()を参照ください。 |
|
GET | /API/v2/Trades/Partners/Get/{partnerId} |
取引のパートナーを取得します。 パートナーID(***partnerId***)を指定して、取引のパートナーを取得します。 対象となる取引に、利用者が所属する組織が参加している必要があります。 取引のパートナーに関する詳細については、[取引のパートナーについて]()を参照ください。 |
|
GET | /API/v2/Trades/Partners/GetList/{tradeNo}?partnerId=!{partnerId}&organizationId=!{organizationId}&parentPartnerId=!{parentPartnerId}&parentOrganizationId=!{parentOrganizationId}&businessTypeCodeList=!{businessTypeCodeList}&myPartnerOnly=!{myPartnerOnly}&isActive=!{isActive} |
取引管理番号を指定して、取引のパートナーを全て取得します。 取引管理番号(***tradeNo***)を指定して、その取引に参加している取引のパートナーを全て取得します。 対象となる取引に、利用者が所属する組織が参加している必要があります。 |
|
POST | /API/v2/Trades/Partners/Register |
取引にパートナーを追加します。 取引に他の事業者をパートナーとして追加します。 取引が作成された時点では、取引を作成した組織に所属する利用者しかアクセス出来ませんが、このメソッドで、他の事業者を取引のパートナーとして追加します。 取引のパートナーを追加すると、取引を他の事業者と共有することになります。 取引のパートナーに関する詳細については、[取引のパートナーについて]()を参照ください。 |
PermissionInTrades
取引内での帳票アクセス権限
API | Description | ||
---|---|---|---|
DELETE | /API/v2/Trades/Partners/PermissionInTrades/Delete/{permissionInTradeId} |
取引内での帳票アクセス権限を削除します。 取引内での帳票アクセス権限ID(***permissionInTradeId***)を指定して、取引内での帳票アクセス権限を削除します。 取引内で変更した帳票アクセス権限がクリアされ、帳票アクセス権限(***/API/v2/Master/Reports/Permissions***)での帳票のRead/Write権限が適用されます。 取引内での帳票アクセス権限に関する詳細については、[取引内での帳票アクセス権限について]()を参照ください。 |
|
GET | /API/v2/Trades/Partners/PermissionInTrades/Get/{permissionInTradeId} |
取引内での帳票アクセス権限を取得します。 取引内での帳票アクセス権限ID(***permissionInTradeId***)を指定して、取引内での帳票アクセス権限を取得します。 取引内での帳票アクセス権限に関する詳細については、[取引内での帳票アクセス権限について]()を参照ください。 |
|
GET | /API/v2/Trades/Partners/PermissionInTrades/GetList/{tradeNo}?partnerId=!{partnerId}&organizationId=!{organizationId}&permissionInTradeId=!{permissionInTradeId}&reportCode=!{reportCode}&reportId=!{reportId}&permissionInTrade=!{permissionInTrade} |
取引内の帳票アクセス権限を取得します。 検索条件を指定して、取引のパートナーに与えられている取引内の帳票アクセス権限を全て取得します。 取引内での帳票アクセス権限に関する詳細については、[取引内での帳票アクセス権限について]()を参照ください。 |
|
POST | /API/v2/Trades/Partners/PermissionInTrades/Register |
取引内での帳票アクセス制限を登録します。 取引のパートナーに対して、取引内での帳票アクセス制限を登録します。 取引のパートナーを追加(***/API/v2/Trades/Partners/Register***)した時点では、追加した組織の事業種別に従い、帳票アクセス権限(***/API/v2/Master/Reports/PermissionInTrades***)での帳票のRead/Write権限が適用されていますが、これを変更する場合に、このメソッドを使用します。 ただし、帳票アクセス権限(***/API/v2/Master/Reports/Permissions***)での設定以上に権限を変更することは出来ません。例えば、帳票アクセス権限(***/API/v2/Master/Reports/Permissions***)での設定で、ある帳票にRead権限までが設定されている場合、これをWrite権限に変更することは出来ません。 この変更は、変更を行った取引に対してのみ有効です。また、取引を複製した場合も(***/API/v2/Trades/Duplicate***)、この設定は引き継がれます。 取引内での帳票アクセス権限に関する詳細については、[取引内での帳票アクセス権限について]()を参照ください。 |
|
PATCH | /API/v2/Trades/Partners/PermissionInTrades/Update/{permissionInTradeId} |
取引内での帳票アクセス権限を更新します。 取引内での帳票アクセス権限ID(***permissionInTradeId***)を指定して、取引内での帳票アクセス権限を更新します。 ただし、帳票アクセス権限(***/API/v2/Master/Reports/Permissions***)での設定以上に権限を変更することは出来ません。 例えば、帳票アクセス権限(***/API/v2/Master/Reports/Permissions***)での設定で、ある帳票にRead権限までが設定されている場合、これをWrite権限に変更することは出来ません。 取引内での帳票アクセス権限に関する詳細については、[取引内での帳票アクセス権限について]()を参照ください。 |
Permissions
帳票アクセス権限
API | Description | ||
---|---|---|---|
DELETE | /API/v2/Master/ReportTypes/Permissions/DeleteAdmin/{reportPermissionCode} |
帳票アクセス制限を削除します。 このAPIはシステム管理者しか呼び出せません。 (*For admin) |
|
GET | /API/v2/Master/ReportTypes/Permissions/Get/{reportPermissionCode} |
帳票アクセス権限を取得します。 帳票アクセス権限コード(***reportPermissionCode***)を指定して、帳票アクセス権限を取得します。 帳票アクセス権限に関する詳細については、[帳票アクセス権限について]()を参照ください。 |
|
GET | /API/v2/Master/ReportTypes/Permissions/GetList/{tradeType}/{businessTypeCode} |
帳票アクセス権限を取得します。 取引タイプ(***tradeType***)と事業種別コード(***businessTypeCode***)を指定して、帳票アクセス権限を取得します。 帳票アクセス権限に関する詳細については、[帳票アクセス権限について]()を参照ください。 |
|
POST | /API/v2/Master/ReportTypes/Permissions/RegisterAdmin |
帳票アクセス制限を登録します。 このAPIはシステム管理者しか呼び出せません。 (*For admin) |
|
POST | /API/v2/Master/ReportTypes/Permissions/RegisterInternal |
帳票アクセス制限を登録します。 内部呼び出し用。 (*For admin) |
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でのレスポンスデータを編集し、指定するようにしてください。 |
Prefectures
都道府県
API | Description | ||
---|---|---|---|
DELETE | /API/v2/General/Prefectures/DeleteAdmin/{prefectureCode} |
コンテナサイズ(高さ)を削除します。 コンテナサイズ(高さ)(***heightCode***)を指定して、コンテナサイズ(長さ)を削除します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
GET | /API/v2/General/Prefectures/Get/{prefectureCode} |
都道府県を取得します。 都道府県コード(***prefectureCode***)を指定して、都道府県を取得します。 |
|
GET | /API/v2/General/Prefectures/GetList?prefectureCode=!{prefectureCode}&prefectureName=!{prefectureName}&prefectureNameEn=!{prefectureNameEn} |
都道府県を取得します。 検索条件に該当する都道府県を全て取得します。 |
|
POST | /API/v2/General/Prefectures/RegisterAdmin |
都道府県を登録します。 このAPIはシステム管理者しか呼び出せません。 (*For admin) |
|
POST | /API/v2/General/Prefectures/RegisterInternal |
都道府県を登録します。 内部呼び出し用。 (*For admin) |
PresettingOrganizations
組織事前設定
API | Description | ||
---|---|---|---|
POST | /API/v1/Master/PresettingOrganizations/RegisterInternal |
組織事前設定を登録します。(Internal Method) |
Processes
取引内のプロセス
API | Description | ||
---|---|---|---|
PATCH | /API/v2/Trades/Processes/AddReports/{processId} |
取引のプロセスに帳票を追加します。 取引内でのプロセスに関する詳細については、[取引内でのプロセスについて]()を参照ください。 |
|
DELETE | /API/v2/Trades/Processes/Delete/{processId} |
取引のプロセスを削除します。 取引内でのプロセスに関する詳細については、[取引内でのプロセスについて]()を参照ください。 |
|
GET | /API/v2/Trades/Processes/Get/{processId} |
取引内のプロセスを取得します。 プロセスID(***processId***)を指定して、取引内のプロセスを取得します。 取引内でのプロセスに関する詳細については、[取引内でのプロセスについて]()を参照ください。 |
|
GET | /API/v2/Trades/Processes/GetList/{tradeNo} |
取引内のプロセスを全て取得します。 取引管理番号(***tradeNo***)を指定して、取引内のプロセスを全て取得します。 |
|
GET | /API/v2/Trades/Processes/GetList/{tradeNo}?processId=!{processId}&processGroupCode=!{processGroupCode}&processCode=!{processCode}&customizedProcessCode=!{customizedProcessCode}&organizationIdAsPlanner=!{organizationIdAsPlanner}&organizationIdAsSubmitter=!{organizationIdAsSubmitter}&organizationIdAsAccepter=!{organizationIdAsAccepter}&processStatus=!{processStatus}&startAtFrom=!{startAtFrom}&startAtTo=!{startAtTo}&dueAtFrom=!{dueAtFrom}&dueAtTo=!{dueAtTo} |
取引内のプロセスを全て取得します。 取引管理番号(***tradeNo***)を指定して、取引内のプロセスを全て取得します。 取引内でのプロセスに関する詳細については、[取引内でのプロセスについて]()を参照ください。 |
|
POST | /API/v2/Trades/Processes/Plan |
取引にプロセスを登録(計画)します。 取引に実施予定のプロセスを登録(計画)します。 登録できるプロセスは、サイバーポート標準プロセス(***/API/v2/Master/StandardProcesses***)か、取引に参加しているパートナーがカスタマイズしたプロセス(***/API/v2/Organizations/CustomizedProcesses***)となります 取引にプロセスを登録(計画)した時点では、そのプロセスで取扱う帳票は、作成されません。 プロセスを開始する際(***/API/v2/Trades/Processes/Start***)に、そのプロセスで取扱う帳票とタスクを作成します。 ただし、作成済みの帳票を使用して、プロセスを開始することも可能です。 取引内でのプロセスに関する詳細については、[取引内でのプロセスについて]()を参照ください。 |
|
PATCH | /API/v2/Trades/Processes/SetStatus/{processId} |
取引のプロセスのステータスを設定します。 取引のプロセスのステータスを設定します。 ステータスを更新すると、紐づくタスクのステータスも連動して更新されます。例えば、プロセスのステータスをDoneにすると、紐づくタスクのステータスもDoneになります。 取引内でのプロセスに関する詳細については、[取引内でのプロセスについて]()を参照ください。 |
|
POST | /API/v2/Trades/Processes/Start |
取引のプロセスを開始します。 取引に登録されている実施予定のプロセスを開始します。 プロセスを開始すると、そのプロセスで取扱う帳票が作成され(作成済みでない場合)、各帳票にタスクが作成されます。 取引内でのプロセスに関する詳細については、[取引内でのプロセスについて]()を参照ください。 |
|
POST | /API/v2/Trades/Processes/Start/{processId} |
No documentation available. |
|
PATCH | /API/v2/Trades/Processes/Update/{processId} |
取引のプロセスを更新します。 取引内でのプロセスに関する詳細については、[取引内でのプロセスについて]()を参照ください。 |
|
PATCH | /API/v2/Trades/Processes/UpdateDisplayOrder |
No documentation available. |
|
PATCH | /API/v2/Trades/Processes/UpdateDisplayOrder/{processId} |
取引のプロセスの並び順を設定します。 取引内でのプロセスに関する詳細については、[取引内でのプロセスについて]()を参照ください。 |
ProcessGroups
プロセスグループ
API | Description | ||
---|---|---|---|
DELETE | /API/v2/Master/ProcessGroups/DeleteAdmin/{processGroupCode} |
プロセスグループコードを指定して、プロセスグループを削除します。 プロセスグループコード(***processGroupCode***)を指定して、プロセスグループを削除します。 このAPIはシステム管理者しか呼び出せません。 (*For admin) |
|
GET | /API/v2/Master/ProcessGroups/GetList/{tradeType}?processGroupCode=!{processGroupCode} |
取引タイプを指定して、プロセスグループを取得します 取引タイプ(***tradeType***)を指定して、プロセスグループを取得します。 ただし、このメソッドのレスポンスには、グループ配下のプロセス(***/API/v2/Master/StandardProcesses***)は含まれません。 グループ配下のプロセスも含めて、取得する場合は、(***/API/v2/Master/StandardProcesses/GetList***)を使用します。 プロセスに関する詳細については、[プロセスについて]()を参照ください。 |
|
POST | /API/v2/Master/ProcessGroups/RegisterAdmin |
プロセスグループを登録します。 このAPIはシステム管理者しか呼び出せません。 (*For admin) |
|
POST | /API/v2/Master/ProcessGroups/RegisterInternal |
プロセスグループを登録します。 内部呼び出し用。 (*For admin) |
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でのレスポンスデータを編集し、指定するようにしてください。 |
ProformaInvoices
商業送り状(I/V)
API | Description | ||
---|---|---|---|
POST | /API/v2/Reports/ProformaInvoices/Create |
仮送り状を作成します。 仮送り状を作成するには、利用者が仮送り状を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 仮送り状に関する詳細については、[仮送り状について]()を参照ください。 |
|
DELETE | /API/v2/Reports/ProformaInvoices/Delete/{reportId} |
仮送り状を削除します。 帳票ID(***reportId***)を指定して、仮送り状を削除します。 仮送り状を削除しても、ルートドキュメントの内容までは削除されません。 申請種別を使用して、作成した仮送り状のキャンセルを伝える場合は、キャンセル(***Cancel***)を実施後、帳票の提出(***Submit***)を実施してください。 仮送り状に関する詳細については、[仮送り状について]()を参照ください。 |
|
DELETE | /API/v2/Reports/ProformaInvoices/DeleteFile/{fileId} |
仮送り状の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、仮送り状の添付ファイルを削除します。 帳票の添付ファイルを削除できるのは、そのファイルを添付したパートナーに所属している利用者だけです。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
GET | /API/v2/Reports/ProformaInvoices/Get/{reportId} |
仮送り状を取得します。 帳票ID(***reportId***)を指定して、仮送り状を取得します。 編集が行われていない場合は、ルートドキュメントから最新の仮送り状を取得します。 編集中の場合は、先に保存した、仮送り状を取得します。 仮送り状に関する詳細については、[仮送り状について]()を参照ください。 |
|
GET | /API/v2/Reports/ProformaInvoices/GetFile/{fileId} |
仮送り状に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、仮送り状に添付されたファイルを取得します。 帳票の添付ファイルを獲得できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
GET | /API/v2/Reports/ProformaInvoices/GetList?tradeNo=!{tradeNo}&uniqueNo=!{uniqueNo}&bookingNo=!{bookingNo}&blNo=!{blNo} |
仮送り状を全て取得します。 検索条件に該当する仮送り状を全て取得します。 編集が行われていない場合は、ルートドキュメントから最新の仮送り状を取得します。 編集中の場合は、先に保存した、仮送り状を取得します。 仮送り状に関する詳細については、[仮送り状について]()を参照ください。 |
|
PATCH | /API/v2/Reports/ProformaInvoices/Lock/{reportId} |
編集するため、仮送り状をロックします 帳票ID(***reportId***)を指定して、仮送り状をロックします。 仮送り状を作成(***Create***)した時点では、仮送り状をロックが掛かりますが、取得(***Get***)したあとで、仮送り状を編集する場合は、このメソッドを呼び出して、仮送り状をロックします。 ロックされた仮送り状は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、仮送り状をルートドキュメントから参照できますが、編集中(ロック中)の仮送り状は参照できません。 このロックは、アンロック(***Unlock***)を呼び出すか、帳票の保存後、帳票の提出(***Submit****)を行うと解除されます。 仮送り状に関する詳細については、[仮送り状について]()を参照ください。 |
|
PATCH | /API/v2/Reports/ProformaInvoices/SetCancel/{reportId} |
仮送り状の申請種別をキャンセルします 帳票ID(***reportId***)を指定して、仮送り状の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 仮送り状に関する詳細については、[仮送り状について]()を参照ください。 |
|
PATCH | /API/v2/Reports/ProformaInvoices/Submit/{reportId} |
仮送り状を提出します 帳票ID(***reportId***)を指定して、更新(***Update***)した仮送り状を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、仮送り状が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、仮送り状もロックされた状態のままなので、ご注意ください。 仮送り状に関する詳細については、[仮送り状について]()を参照ください。 |
|
PATCH | /API/v2/Reports/ProformaInvoices/Unlock/{reportId} |
仮送り状のロックを解除します 帳票ID(***reportId***)を指定して、仮送り状のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 仮送り状に関する詳細については、[仮送り状について]()を参照ください。 |
|
PATCH | /API/v2/Reports/ProformaInvoices/Update/{reportId} |
仮送り状を更新します。 帳票ID(***reportId***)を指定して、仮送り状を更新します。 このメソッドでは、仮送り状の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 仮送り状に関する詳細については、[仮送り状について]()を参照ください。 |
|
POST | /API/v2/Reports/ProformaInvoices/UploadFile |
仮送り状にファイルを添付します。 指定された仮送り状に、ファイルを添付します。 帳票にファイルを添付できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
ReasonCodeForChanges
変更理由コード
API | Description | ||
---|---|---|---|
DELETE | /API/v2/General/ReasonCodeForChanges/DeleteAdmin/{changeReasonCode} |
変更理由コードを削除します。 変更理由コード(***changeReasonCode***)を指定して、内変更理由コードを削除します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
GET | /API/v2/General/ReasonCodeForChanges/Get/{changeReasonCode} |
変更理由を取得します。 変更理由コード(***changeReasonCode***)を指定して、変更理由を取得します。 変更理由コードに関する詳細については、[変更理由コードについて]()を参照ください。 |
|
GET | /API/v2/General/ReasonCodeForChanges/GetList |
変更理由を全て取得します。 変更理由コードに関する詳細については、[変更理由コードについて]()を参照ください。 |
|
POST | /API/v2/General/ReasonCodeForChanges/RegisterAdmin |
変更理由を登録します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
POST | /API/v2/General/ReasonCodeForChanges/RegisterInternal |
変更理由を登録します。 内部呼び出し用。 (*For admin) |
ReceivingTerms
荷受形態
API | Description | ||
---|---|---|---|
DELETE | /API/v2/General/ReceivingTerms/DeleteAdmin/{receivingTermCode} |
荷受形態を削除します。 荷受形態コード(***receivingTermCode***)を指定して、荷受形態を削除します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
GET | /API/v2/General/ReceivingTerms/Get/{receivingTermCode} |
荷受形態を取得します。 荷受形態コード(***receivingTermCode***)を指定して、荷受形態を取得します。 |
|
GET | /API/v2/General/ReceivingTerms/GetList |
荷受形態を全て取得します。 荷受形態を全て取得します。 |
|
POST | /API/v2/General/ReceivingTerms/RegisterAdmin |
荷受形態を登録します。 このAPIはシステム管理者しか呼び出せません。 (*For admin) |
|
POST | /API/v2/General/ReceivingTerms/RegisterInternal |
荷受形態を登録します。 内部呼び出し用。 (*For admin) |
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でのレスポンスデータを編集し、指定するようにしてください。 |
RemarkCodes
リマークコード
API | Description | ||
---|---|---|---|
DELETE | /API/v2/General/RemarkCodes/DeleteAdmin/{remarkCode} |
リマークコードを削除します。 リマークコード(***remarkCode***)を指定して、リマークコードを削除します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
GET | /API/v2/General/RemarkCodes/Get/{remarkCode} |
リマーク種別を取得します。 リマークコード(***remarkCode***)を指定して、リマーク種別を取得します。 リマークコードに関する詳細については、[リマークコードについて]()を参照ください。 |
|
GET | /API/v2/General/RemarkCodes/GetList |
リマーク種別を全て取得します。 リマークコードに関する詳細については、[リマークコードについて]()を参照ください。 |
|
POST | /API/v2/General/RemarkCodes/RegisterAdmin |
リマーク種別を登録します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
POST | /API/v2/General/RemarkCodes/RegisterInternal |
リマーク種別を登録します。 内部呼び出し用。 (*For admin) |
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でのレスポンスデータを編集し、指定するようにしてください。 |
RemittanceAdvices
振込完了通知書
API | Description | ||
---|---|---|---|
POST | /API/v2/Reports/RemittanceAdvices/Create |
振込完了通知書を作成します。 振込完了通知書を作成するには、利用者が振込完了通知書を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 振込完了通知書に関する詳細については、[振込完了通知書について]()を参照ください。 |
|
DELETE | /API/v2/Reports/RemittanceAdvices/Delete/{reportId} |
振込完了通知書を削除します。 帳票ID(***reportId***)を指定して、振込完了通知書を削除します。 振込完了通知書を削除しても、ルートドキュメントの内容までは削除されません。 申請種別を使用して、作成した振込完了通知書のキャンセルを伝える場合は、キャンセル(***Cancel***)を実施後、帳票の提出(***Submit***)を実施してください。 振込完了通知書に関する詳細については、[振込完了通知書について]()を参照ください。 |
|
DELETE | /API/v2/Reports/RemittanceAdvices/DeleteFile/{fileId} |
振込完了通知書の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、振込完了通知書の添付ファイルを削除します。 帳票の添付ファイルを削除できるのは、そのファイルを添付したパートナーに所属している利用者だけです。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
GET | /API/v2/Reports/RemittanceAdvices/Get/{reportId} |
振込完了通知書を取得します。 帳票ID(***reportId***)を指定して、振込完了通知書を取得します。 編集が行われていない場合は、ルートドキュメントから最新の振込完了通知書を取得します。 編集中の場合は、先に保存した、振込完了通知書を取得します。 振込完了通知書に関する詳細については、[振込完了通知書について]()を参照ください。 |
|
GET | /API/v2/Reports/RemittanceAdvices/GetFile/{fileId} |
振込完了通知書に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、振込完了通知書に添付されたファイルを取得します。 帳票の添付ファイルを獲得できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
GET | /API/v2/Reports/RemittanceAdvices/GetList?tradeNo=!{tradeNo}&uniqueNo=!{uniqueNo}&bookingNo=!{bookingNo}&blNo=!{blNo} |
振込完了通知書を全て取得します。 検索条件に該当する振込完了通知書を全て取得します。 編集が行われていない場合は、ルートドキュメントから最新の振込完了通知書を取得します。 編集中の場合は、先に保存した、振込完了通知書を取得します。 振込完了通知書に関する詳細については、[振込完了通知書について]()を参照ください。 |
|
PATCH | /API/v2/Reports/RemittanceAdvices/Lock/{reportId} |
編集するため、振込完了通知書をロックします 帳票ID(***reportId***)を指定して、振込完了通知書をロックします。 振込完了通知書を作成(***Create***)した時点では、振込完了通知書をロックが掛かりますが、取得(***Get***)したあとで、振込完了通知書を編集する場合は、このメソッドを呼び出して、振込完了通知書をロックします。 ロックされた振込完了通知書は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、振込完了通知書をルートドキュメントから参照できますが、編集中(ロック中)の振込完了通知書は参照できません。 このロックは、アンロック(***Unlock***)を呼び出すか、帳票の保存後、帳票の提出(***Submit****)を行うと解除されます。 振込完了通知書に関する詳細については、[振込完了通知書について]()を参照ください。 |
|
PATCH | /API/v2/Reports/RemittanceAdvices/SetCancel/{reportId} |
振込完了通知書の申請種別をキャンセルします 帳票ID(***reportId***)を指定して、振込完了通知書の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 振込完了通知書に関する詳細については、[振込完了通知書について]()を参照ください。 |
|
PATCH | /API/v2/Reports/RemittanceAdvices/Submit/{reportId} |
振込完了通知書を提出します 帳票ID(***reportId***)を指定して、更新(***Update***)した振込完了通知書を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、振込完了通知書が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、振込完了通知書もロックされた状態のままなので、ご注意ください。 振込完了通知書に関する詳細については、[振込完了通知書について]()を参照ください。 |
|
PATCH | /API/v2/Reports/RemittanceAdvices/Unlock/{reportId} |
振込完了通知書のロックを解除します 帳票ID(***reportId***)を指定して、振込完了通知書のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 振込完了通知書に関する詳細については、[振込完了通知書について]()を参照ください。 |
|
PATCH | /API/v2/Reports/RemittanceAdvices/Update/{reportId} |
振込完了通知書を更新します。 帳票ID(***reportId***)を指定して、振込完了通知書を更新します。 このメソッドでは、振込完了通知書の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 振込完了通知書に関する詳細については、[振込完了通知書について]()を参照ください。 |
|
POST | /API/v2/Reports/RemittanceAdvices/UploadFile |
振込完了通知書にファイルを添付します。 指定された振込完了通知書に、ファイルを添付します。 帳票にファイルを添付できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
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でのレスポンスデータを編集し、指定するようにしてください。 |
RemittanceSlips
振込・振替明細帳票
API | Description | ||
---|---|---|---|
POST | /API/v2/Reports/RemittanceSlips/Create |
振込・振替明細帳票を作成します。 振込・振替明細帳票を作成するには、利用者が振込・振替明細帳票を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 振込・振替明細帳票に関する詳細については、[振込・振替明細帳票について]()を参照ください。 |
|
DELETE | /API/v2/Reports/RemittanceSlips/Delete/{reportId} |
振込・振替明細帳票を削除します。 帳票ID(***reportId***)を指定して、振込・振替明細帳票を削除します。 振込・振替明細帳票を削除しても、ルートドキュメントの内容までは削除されません。 申請種別を使用して、作成した振込・振替明細帳票のキャンセルを伝える場合は、キャンセル(***Cancel***)を実施後、帳票の提出(***Submit***)を実施してください。 振込・振替明細帳票に関する詳細については、[振込・振替明細帳票について]()を参照ください。 |
|
DELETE | /API/v2/Reports/RemittanceSlips/DeleteFile/{fileId} |
振込・振替明細帳票の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、振込・振替明細帳票の添付ファイルを削除します。 帳票の添付ファイルを削除できるのは、そのファイルを添付したパートナーに所属している利用者だけです。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
GET | /API/v2/Reports/RemittanceSlips/Get/{reportId} |
振込・振替明細帳票を取得します。 帳票ID(***reportId***)を指定して、振込・振替明細帳票を取得します。 編集が行われていない場合は、ルートドキュメントから最新の振込・振替明細帳票を取得します。 編集中の場合は、先に保存した、振込・振替明細帳票を取得します。 振込・振替明細帳票に関する詳細については、[振込・振替明細帳票について]()を参照ください。 |
|
GET | /API/v2/Reports/RemittanceSlips/GetFile/{fileId} |
振込・振替明細帳票に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、振込・振替明細帳票に添付されたファイルを取得します。 帳票の添付ファイルを獲得できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
GET | /API/v2/Reports/RemittanceSlips/GetList?tradeNo=!{tradeNo}&uniqueNo=!{uniqueNo}&bookingNo=!{bookingNo}&blNo=!{blNo} |
振込・振替明細帳票を全て取得します。 検索条件に該当する振込・振替明細帳票を全て取得します。 編集が行われていない場合は、ルートドキュメントから最新の振込・振替明細帳票を取得します。 編集中の場合は、先に保存した、振込・振替明細帳票を取得します。 振込・振替明細帳票に関する詳細については、[振込・振替明細帳票について]()を参照ください。 |
|
PATCH | /API/v2/Reports/RemittanceSlips/Lock/{reportId} |
編集するため、振込・振替明細帳票をロックします 帳票ID(***reportId***)を指定して、振込・振替明細帳票をロックします。 振込・振替明細帳票を作成(***Create***)した時点では、振込・振替明細帳票をロックが掛かりますが、取得(***Get***)したあとで、振込・振替明細帳票を編集する場合は、このメソッドを呼び出して、振込・振替明細帳票をロックします。 ロックされた振込・振替明細帳票は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、振込・振替明細帳票をルートドキュメントから参照できますが、編集中(ロック中)の振込・振替明細帳票は参照できません。 このロックは、アンロック(***Unlock***)を呼び出すか、帳票の保存後、帳票の提出(***Submit****)を行うと解除されます。 振込・振替明細帳票に関する詳細については、[振込・振替明細帳票について]()を参照ください。 |
|
PATCH | /API/v2/Reports/RemittanceSlips/SetCancel/{reportId} |
振込・振替明細帳票の申請種別をキャンセルします 帳票ID(***reportId***)を指定して、振込・振替明細帳票の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 振込・振替明細帳票に関する詳細については、[振込・振替明細帳票について]()を参照ください。 |
|
PATCH | /API/v2/Reports/RemittanceSlips/Submit/{reportId} |
振込・振替明細帳票を提出します 帳票ID(***reportId***)を指定して、更新(***Update***)した振込・振替明細帳票を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、振込・振替明細帳票が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、振込・振替明細帳票もロックされた状態のままなので、ご注意ください。 振込・振替明細帳票に関する詳細については、[振込・振替明細帳票について]()を参照ください。 |
|
PATCH | /API/v2/Reports/RemittanceSlips/Unlock/{reportId} |
振込・振替明細帳票のロックを解除します 帳票ID(***reportId***)を指定して、振込・振替明細帳票のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 振込・振替明細帳票に関する詳細については、[振込・振替明細帳票について]()を参照ください。 |
|
PATCH | /API/v2/Reports/RemittanceSlips/Update/{reportId} |
振込・振替明細帳票を更新します。 帳票ID(***reportId***)を指定して、振込・振替明細帳票を更新します。 このメソッドでは、振込・振替明細帳票の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 振込・振替明細帳票に関する詳細については、[振込・振替明細帳票について]()を参照ください。 |
|
POST | /API/v2/Reports/RemittanceSlips/UploadFile |
振込・振替明細帳票にファイルを添付します。 指定された振込・振替明細帳票に、ファイルを添付します。 帳票にファイルを添付できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
ReportCategories
帳票カテゴリ
API | Description | ||
---|---|---|---|
DELETE | /API/v2/Master/ReportCategories/DeleteAdmin/{reportCategoryCode} |
帳票のカテゴリを削除します。 帳票カテゴリコード(***reportCategoryCode***)を指定して、帳票のカテゴリを削除します。 このAPIはシステム管理者しか呼び出せません。 (*For admin) |
|
GET | /API/v2/Master/ReportCategories/Get/{reportCategoryCode} |
帳票のカテゴリを取得します。 帳票カテゴリコード(***reportCategoryCode***)を指定して、帳票のカテゴリを取得します。 帳票カテゴリに関する詳細については、[帳票カテゴリについて]()を参照ください。 |
|
GET | /API/v2/Master/ReportCategories/GetList |
帳票のカテゴリを全て取得します。 帳票のカテゴリを全て取得します。 帳票カテゴリに関する詳細については、[帳票カテゴリについて]()を参照ください。 |
|
POST | /API/v2/Master/ReportCategories/RegisterAdmin |
帳票のカテゴリを登録します。 このAPIはシステム管理者しか呼び出せません。 (*For admin) |
|
POST | /API/v2/Master/ReportCategories/RegisterInternal |
帳票のカテゴリを登録します。 内部呼び出し用。 (*For admin) |
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)を指定して、帳票スキーマを取得します。 |
Reports
取引内の帳票
API | Description | ||
---|---|---|---|
GET | /API/v2/Trades/Reports/Get/{reportId} |
取引内の帳票を取得します。 帳票ID(***reportId***)を指定して、該当する取引内の帳票を取得します。 |
|
GET | /API/v2/Trades/Reports/GetCreatable/{tradeNo}/{organizationId}?reportCategoryCodeList=!{reportCategoryCodeList} |
取引内で作成可能な帳票の種類を取得します。 取引内で、指定された組織(***organizationId***)が、作成可能な帳票の種類を取得します。 |
|
GET | /API/v2/Trades/Reports/GetList/{tradeNo}?reportCode=!{reportCode}&createdByOrganizationId=!{createdByOrganizationId}&editingByOrganizationId=!{editingByOrganizationId}&updatedByOrganizationId=!{updatedByOrganizationId} |
取引内の帳票を全て取得します。 検索条件に該当する取引内の帳票を全て取得します。 |
ReportTypes
帳票の種類
API | Description | ||
---|---|---|---|
DELETE | /API/v2/Master/ReportTypes/DeleteAdmin/{reportCode} |
帳票を削除します。 帳票コード(***reportCode***)を指定して、帳票の種類を削除します。 このAPIはシステム管理者しか呼び出せません。 (*For admin) |
|
GET | /API/v2/Master/ReportTypes/Get/{reportCode} |
帳票の種類を取得します。 帳票コード(***reportCode***)を指定して、帳票の種類を取得します。 帳票の種類に関する詳細については、[帳票の種類について]()を参照ください。 |
|
GET | /API/v2/Master/ReportTypes/GetList |
帳票の種類を全て取得します。 帳票の種類を全て取得します。 帳票の種類に関する詳細については、[帳票の種類について]()を参照ください。 |
|
GET | /API/v2/Master/ReportTypes/GetSchema/{reportCode} |
帳票のJSONスキーマを取得します。 帳票コード(***reportCode***)を指定して、帳票のJSONスキーマを取得します。 |
|
POST | /API/v2/Master/ReportTypes/RegisterAdmin |
帳票の種類を登録します。 このAPIはシステム管理者しか呼び出せません。 (*For admin) |
|
POST | /API/v2/Master/ReportTypes/RegisterInternal |
帳票の種類を登録します。 内部呼び出し用。 (*For admin) |
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 |
レビューを既読状態にします。 |
Reviews
レビュー
API | Description | ||
---|---|---|---|
POST | /API/v2/Reports/Reviews/Assign |
帳票にレビュー依頼を作成します。 レビュー依頼は、取引内の帳票に対して、更新や送信を行う取引内のパートナーに対して、レビューを依頼し、帳票を既読したかどうかを確認する機能です。 レビューを依頼したパートナーは、依頼された側の既読状況を ***/API/v2/Report/Reviews/Get/{reviewId}*** や、 ***/API/v2/Trades/Reports*** で確認できます。 レビューを依頼されたパートナーは、帳票の内容を確認し、***/API/v2/Report/Reviews/MarkAsRead/{reviewId}*** で、既読としてマークします。 レビューに関する詳細については、[レビューについて]()を参照ください。 |
|
PATCH | /API/v2/Reports/Reviews/Cancel/{reviewId} |
依頼したレビューをキャンセルします。 レビューID(***reviewId***)と組織ID(***organizationId***)を指定して、依頼したレビューのステータスをキャンセルにします。 レビューに関する詳細については、[レビューについて]()を参照ください。 |
|
GET | /API/v2/Reports/Reviews/Get/{reviewId} |
レビューIDを指定して、レビュー依頼を取得します。 レビューID(***reviewId***)を指定して、レビュー依頼を取得します。 レビュー依頼が作成されている帳票にアクセス権限を持っている必要があります。 レビューに関する詳細については、[レビューについて]()を参照ください。 |
|
GET | /API/v2/Reports/Reviews/GetList?tradeNo=!{tradeNo}&reportId=!{reportId}&reviewId=!{reviewId}&statusList=!{statusList} |
検索条件を指定して、レビュー依頼を取得します。 検索条件を指定して、レビュー依頼を取得します。 レビュー依頼が作成されている帳票にアクセス権限を持っている必要があります。 レビューに関する詳細については、[レビューについて]()を参照ください。 |
|
PATCH | /API/v2/Reports/Reviews/MarkAsRead/{reviewId} |
依頼されているレビューを既読としてマークします。 レビューID(***reviewId***)と組織ID(***organizationId***)を指定して、依頼されているレビューを既読としてマークします。 レビューに関する詳細については、[レビューについて]()を参照ください。 |
RootDocumentColumns
ルートドキュメントの項目
API | Description | ||
---|---|---|---|
DELETE | /API/v2/Master/RootDocumentColumns/DeleteAdmin/{columnCode} |
帳票を削除します。 帳票コード(***reportCode***)を指定して、帳票を削除します。 このAPIはシステム管理者しか呼び出せません。 (*For admin) |
|
GET | /API/v2/Master/RootDocumentColumns/Get/{columnCode} |
ルートドキュメントの項目を取得します。 項目コード(***columnCode***)を指定して、ルートドキュメントの項目を取得します。 ルートドキュメントに関する詳細については、[ルートドキュメントについて]()を参照ください。 |
|
GET | /API/v2/Master/RootDocumentColumns/GetList |
ルートドキュメントの項目を全て取得します。 ルートドキュメントの項目を全て取得します。 ルートドキュメントに関する詳細については、[ルートドキュメントについて]()を参照ください。 |
|
POST | /API/v2/Master/RootDocumentColumns/RegisterAdmin |
項目を登録します。 このAPIはシステム管理者しか呼び出せません。 (*For admin) |
|
POST | /API/v2/Master/RootDocumentColumns/RegisterInternal |
項目を登録します。 内部呼び出し用。 (*For admin) |
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権限が必要です。 |
ScacCodes
船会社コード (SCAC)
API | Description | ||
---|---|---|---|
GET | /API/v2/General/ScacCodes/Get/{scacCode} |
船会社コード(SCAC)を取得します。 船会社(SCAC)コード(***scacCode***)を指定して、船会社コード(SCAC)を取得します。 NACCSから連携されるマスターデータに関する詳細については、[NACCSから連携されるマスターデータについて]()を参照ください。 |
|
GET | /API/v2/General/ScacCodes/GetList?scacCode=!{scacCode}&shippingCompanyName=!{shippingCompanyName}&representativeUserCode=!{representativeUserCode}&isMixedLoading=!{isMixedLoading} |
船会社コード(SCAC)を取得します。 検索条件に該当する船会社コード(SCAC)を全て取得します。 NACCSから連携されるマスターデータに関する詳細については、[NACCSから連携されるマスターデータについて]()を参照ください。 |
SearchShortcuts
検索ショートカット
API | Description | ||
---|---|---|---|
DELETE | /API/v2/Trades/SearchShortcuts/Delete/{searchShortcutId} |
検索ショートカットIDを指定して、検索ショートカットを削除します。 検索ショートカットID(***searchShortcutId***)を指定して、検索ショートカットを削除します。 |
|
GET | /API/v2/Trades/SearchShortcuts/Get/{searchShortcutId} |
検索ショートカットを取得します。 検索ショートカットID(***searchShortcutId***)を指定して、検索ショートカットを取得します。 取引の検索に関する詳細については、[取引の検索について]()を参照ください。 |
|
GET | /API/v2/Trades/SearchShortcuts/GetList?searchShortcutName=!{searchShortcutName} |
検索ショートカットを全て取得します。 検索ショートカットを全て取得します。 取引の検索に関する詳細については、[取引の検索について]()を参照ください。 |
|
POST | /API/v2/Trades/SearchShortcuts/Register |
取引の検索条件をショートカットとして登録します。 取引の検索条件をショートカットとして登録します。 取引を検索する条件を、検索ショートカットとして保存します。 検索ショートカットを使用した取引の検索は、***/API/v2/Trades/SeacrhByShortcut/*** を使って行います。 取引の検索に関する詳細については、[取引の検索について]()を参照ください。 |
|
PATCH | /API/v2/Trades/SearchShortcuts/UpdateDisplayOrder/{searchShortcutId} |
検索ショートカットの表示順を変更します。 検索ショートカットID(***searchShortcutId***)を指定して、検索ショートカットの表示順を変更します。 |
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でのレスポンスデータを編集し、指定するようにしてください。 |
SeaWayBills
海上運送状(ウェイビル)
API | Description | ||
---|---|---|---|
POST | /API/v2/Reports/SeaWayBills/Create |
海上運送状(ウェイビル)を作成します。 海上運送状(ウェイビル)を作成するには、利用者が海上運送状(ウェイビル)を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 海上運送状(ウェイビル)に関する詳細については、[海上運送状(ウェイビル)について]()を参照ください。 |
|
DELETE | /API/v2/Reports/SeaWayBills/Delete/{reportId} |
海上運送状(ウェイビル)を削除します。 帳票ID(***reportId***)を指定して、海上運送状(ウェイビル)を削除します。 海上運送状(ウェイビル)を削除しても、ルートドキュメントの内容までは削除されません。 申請種別を使用して、作成した海上運送状(ウェイビル)のキャンセルを伝える場合は、キャンセル(***Cancel***)を実施後、帳票の提出(***Submit***)を実施してください。 海上運送状(ウェイビル)に関する詳細については、[海上運送状(ウェイビル)について]()を参照ください。 |
|
DELETE | /API/v2/Reports/SeaWayBills/DeleteFile/{fileId} |
海上運送状(ウェイビル)の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、海上運送状(ウェイビル)の添付ファイルを削除します。 帳票の添付ファイルを削除できるのは、そのファイルを添付したパートナーに所属している利用者だけです。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
GET | /API/v2/Reports/SeaWayBills/Get/{reportId} |
海上運送状(ウェイビル)を取得します。 帳票ID(***reportId***)を指定して、海上運送状(ウェイビル)を取得します。 編集が行われていない場合は、ルートドキュメントから最新の海上運送状(ウェイビル)を取得します。 編集中の場合は、先に保存した、海上運送状(ウェイビル)を取得します。 海上運送状(ウェイビル)に関する詳細については、[海上運送状(ウェイビル)について]()を参照ください。 |
|
GET | /API/v2/Reports/SeaWayBills/GetFile/{fileId} |
海上運送状(ウェイビル)に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、海上運送状(ウェイビル)に添付されたファイルを取得します。 帳票の添付ファイルを獲得できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
GET | /API/v2/Reports/SeaWayBills/GetList?tradeNo=!{tradeNo}&uniqueNo=!{uniqueNo}&bookingNo=!{bookingNo}&blNo=!{blNo} |
海上運送状(ウェイビル)を全て取得します。 検索条件に該当する海上運送状(ウェイビル)を全て取得します。 編集が行われていない場合は、ルートドキュメントから最新の海上運送状(ウェイビル)を取得します。 編集中の場合は、先に保存した、海上運送状(ウェイビル)を取得します。 海上運送状(ウェイビル)に関する詳細については、[海上運送状(ウェイビル)について]()を参照ください。 |
|
PATCH | /API/v2/Reports/SeaWayBills/Lock/{reportId} |
編集するため、海上運送状(ウェイビル)をロックします 帳票ID(***reportId***)を指定して、海上運送状(ウェイビル)をロックします。 海上運送状(ウェイビル)を作成(***Create***)した時点では、海上運送状(ウェイビル)をロックが掛かりますが、取得(***Get***)したあとで、海上運送状(ウェイビル)を編集する場合は、このメソッドを呼び出して、海上運送状(ウェイビル)をロックします。 ロックされた海上運送状(ウェイビル)は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、海上運送状(ウェイビル)をルートドキュメントから参照できますが、編集中(ロック中)の海上運送状(ウェイビル)は参照できません。 このロックは、アンロック(***Unlock***)を呼び出すか、帳票の保存後、帳票の提出(***Submit****)を行うと解除されます。 海上運送状(ウェイビル)に関する詳細については、[海上運送状(ウェイビル)について]()を参照ください。 |
|
PATCH | /API/v2/Reports/SeaWayBills/SetCancel/{reportId} |
海上運送状(ウェイビル)の申請種別をキャンセルします 帳票ID(***reportId***)を指定して、船荷証券(B/L)の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 海上運送状(ウェイビル)に関する詳細については、[海上運送状(ウェイビル)について]()を参照ください。 |
|
PATCH | /API/v2/Reports/SeaWayBills/Submit/{reportId} |
海上運送状(ウェイビル)を提出します 帳票ID(***reportId***)を指定して、更新(***Update***)した海上運送状(ウェイビル)を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、海上運送状(ウェイビル)が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、海上運送状(ウェイビル)もロックされた状態のままなので、ご注意ください。 海上運送状(ウェイビル)に関する詳細については、[海上運送状(ウェイビル)について]()を参照ください。 |
|
PATCH | /API/v2/Reports/SeaWayBills/Unlock/{reportId} |
海上運送状(ウェイビル)のロックを解除します 帳票ID(***reportId***)を指定して、海上運送状(ウェイビル)のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 海上運送状(ウェイビル)に関する詳細については、[海上運送状(ウェイビル)について]()を参照ください。 |
|
PATCH | /API/v2/Reports/SeaWayBills/Update/{reportId} |
海上運送状(ウェイビル)を更新します。 帳票ID(***reportId***)を指定して、海上運送状(ウェイビル)を更新します。 このメソッドでは、海上運送状(ウェイビル)の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 海上運送状(ウェイビル)に関する詳細については、[海上運送状(ウェイビル)について]()を参照ください。 |
|
POST | /API/v2/Reports/SeaWayBills/UploadFile |
海上運送状(ウェイビル)にファイルを添付します。 指定された海上運送状(ウェイビル)に、ファイルを添付します。 帳票にファイルを添付できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
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でのレスポンスデータを編集し、指定するようにしてください。 |
ShippingCompanyInstructionCodes
船社指示コード
API | Description | ||
---|---|---|---|
DELETE | /API/v2/General/ShippingCompanyInstructionCodes/DeleteAdmin/{shippingCompanyInstructionCode} |
船社指示コードを削除します。 船社指示コード(***shippingCompanyInstructionCode***)を指定して、船社指示コードを削除します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
GET | /API/v2/General/ShippingCompanyInstructionCodes/Get/{shippingCompanyInstructionCode} |
船社指示種別を取得します。 船社指示コード(***shippingCompanyInstructionCode***)を指定して、船社指示種別を取得します。 船社指示コードに関する詳細については、[船社指示コードについて]()を参照ください。 |
|
GET | /API/v2/General/ShippingCompanyInstructionCodes/GetList |
船社指示種別を全て取得します。 船社指示コードに関する詳細については、[船社指示コードについて]()を参照ください。 |
|
GET | /API/v2/General/ShippingCompanyInstructionCodes/RegisterAdmin |
No documentation available. |
|
POST | /API/v2/General/ShippingCompanyInstructionCodes/RegisterInternal |
船社指示種別を登録します。 内部呼び出し用。 (*For admin) |
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でのレスポンスデータを編集し、指定するようにしてください。 |
ShippingInstructions
船積依頼書
API | Description | ||
---|---|---|---|
POST | /API/v2/Reports/ShippingInstructions/Create |
船積依頼書を作成します。 船積依頼書を作成するには、利用者が船積依頼書を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 船積依頼書に関する詳細については、[船積依頼書について]()を参照ください。 |
|
DELETE | /API/v2/Reports/ShippingInstructions/Delete/{reportId} |
船積依頼書を削除します。 帳票ID(***reportId***)を指定して、船積依頼書を削除します。 船積依頼書を削除しても、ルートドキュメントの内容までは削除されません。 申請種別を使用して、作成した船積依頼書のキャンセルを伝える場合は、キャンセル(***Cancel***)を実施後、帳票の提出(***Submit***)を実施してください。 船積依頼書に関する詳細については、[船積依頼書について]()を参照ください。 |
|
DELETE | /API/v2/Reports/ShippingInstructions/DeleteFile/{fileId} |
船積依頼書の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、船積依頼書の添付ファイルを削除します。 帳票の添付ファイルを削除できるのは、そのファイルを添付したパートナーに所属している利用者だけです。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
GET | /API/v2/Reports/ShippingInstructions/Get/{reportId} |
船積依頼書を取得します。 帳票ID(***reportId***)を指定して、船積依頼書を取得します。 編集が行われていない場合は、ルートドキュメントから最新の船積依頼書を取得します。 編集中の場合は、先に保存した、船積依頼書を取得します。 船積依頼書に関する詳細については、[船積依頼書について]()を参照ください。 |
|
GET | /API/v2/Reports/ShippingInstructions/GetFile/{fileId} |
船積依頼書に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、船積依頼書に添付されたファイルを取得します。 帳票の添付ファイルを獲得できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
GET | /API/v2/Reports/ShippingInstructions/GetList?tradeNo=!{tradeNo}&uniqueNo=!{uniqueNo}&bookingNo=!{bookingNo}&blNo=!{blNo} |
船積依頼書を全て取得します。 検索条件に該当する船積依頼書を全て取得します。 編集が行われていない場合は、ルートドキュメントから最新の船積依頼書を取得します。 編集中の場合は、先に保存した、船積依頼書を取得します。 船積依頼書に関する詳細については、[船積依頼書について]()を参照ください。 |
|
PATCH | /API/v2/Reports/ShippingInstructions/Lock/{reportId} |
編集するため、船積依頼書をロックします 帳票ID(***reportId***)を指定して、船積依頼書をロックします。 船積依頼書を作成(***Create***)した時点では、船積依頼書をロックが掛かりますが、取得(***Get***)したあとで、船積依頼書を編集する場合は、このメソッドを呼び出して、船積依頼書をロックします。 ロックされた船積依頼書は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、船積依頼書をルートドキュメントから参照できますが、編集中(ロック中)の船積依頼書は参照できません。 このロックは、アンロック(***Unlock***)を呼び出すか、帳票の保存後、帳票の提出(***Submit****)を行うと解除されます。 船積依頼書に関する詳細については、[船積依頼書について]()を参照ください。 |
|
PATCH | /API/v2/Reports/ShippingInstructions/SetCancel/{reportId} |
船積依頼書の申請種別をキャンセルします 帳票ID(***reportId***)を指定して、船積依頼書の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 船積依頼書に関する詳細については、[船積依頼書について]()を参照ください。 |
|
PATCH | /API/v2/Reports/ShippingInstructions/Submit/{reportId} |
船積依頼書を提出します 帳票ID(***reportId***)を指定して、更新(***Update***)した船積依頼書を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、船積依頼書が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、船積依頼書もロックされた状態のままなので、ご注意ください。 船積依頼書に関する詳細については、[船積依頼書について]()を参照ください。 |
|
PATCH | /API/v2/Reports/ShippingInstructions/Unlock/{reportId} |
船積依頼書のロックを解除します 帳票ID(***reportId***)を指定して、船積依頼書のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 船積依頼書に関する詳細については、[船積依頼書について]()を参照ください。 |
|
PATCH | /API/v2/Reports/ShippingInstructions/Update/{reportId} |
船積依頼書を更新します。 帳票ID(***reportId***)を指定して、船積依頼書を更新します。 このメソッドでは、船積依頼書の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 船積依頼書に関する詳細については、[船積依頼書について]()を参照ください。 |
|
POST | /API/v2/Reports/ShippingInstructions/UploadFile |
船積依頼書にファイルを添付します。 指定された船積依頼書に、ファイルを添付します。 帳票にファイルを添付できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
ShippingPurposeCodes
運送目的コード
API | Description | ||
---|---|---|---|
DELETE | /API/v2/General/ShippingPurposeCodes/DeleteAdmin/{shippingPurposeCode} |
運送目的コードを削除します。 運送目的コード(***shippingPurposeCode***)を指定して、運送目的コードを削除します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
GET | /API/v2/General/ShippingPurposeCodes/Get/{shippingPurposeCode} |
運送目的種別を取得します。 運送目的コード(***shippingPurposeCode***)を指定して、運送目的種別を取得します。 運送目的コードに関する詳細については、[運送目的コードについて]()を参照ください。 |
|
GET | /API/v2/General/ShippingPurposeCodes/GetList |
運送目的種別を全て取得します。 運送目的コードに関する詳細については、[運送目的コードについて]()を参照ください。 |
|
POST | /API/v2/General/ShippingPurposeCodes/RegisterAdmin |
運送目的種別を登録します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
POST | /API/v2/General/ShippingPurposeCodes/RegisterInternal |
運送目的種別を登録します。 内部呼び出し用。 (*For admin) |
ShippingTypeCodes
運送種別コード
API | Description | ||
---|---|---|---|
DELETE | /API/v2/General/ShippingTypeCodes/DeleteAdmin/{shippingTypeCode} |
運送種別コードを削除します。 運送種別コード(***shippingTypeCode***)を指定して、運送種別コードを削除します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
GET | /API/v2/General/ShippingTypeCodes/Get/{shippingTypeCode} |
運送種別を取得します。 運送種別コード(***shippingTypeCode***)を指定して、運送種別を取得します。 運送種別コードに関する詳細については、[運送種別コードについて]()を参照ください。 |
|
GET | /API/v2/General/ShippingTypeCodes/GetList |
運送種別を全て取得します。 運送種別コードに関する詳細については、[運送種別コードについて]()を参照ください。 |
|
POST | /API/v2/General/ShippingTypeCodes/RegisterAdmin |
運送種別を登録します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
POST | /API/v2/General/ShippingTypeCodes/RegisterInternal |
運送種別を登録します。 内部呼び出し用。 (*For admin) |
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権限が必要です。 |
SpecialCargoCodes
特殊貨物コード
API | Description | ||
---|---|---|---|
DELETE | /API/v2/General/SpecialCargoCodes/DeleteAdmin/{specialCargoCode} |
特殊貨物コードを削除します。 特殊貨物コード(***specialCargoCode***)を指定して、特殊貨物コードを削除します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
GET | /API/v2/General/SpecialCargoCodes/Get/{specialCargoCode} |
特殊貨物種別を取得します。 特殊貨物コード(***specialCargoCode***)を指定して、特殊貨物種別を取得します。 特殊貨物コードに関する詳細については、[特殊貨物コードについて]()を参照ください。 |
|
GET | /API/v2/General/SpecialCargoCodes/GetList |
特殊貨物種別を全て取得します。 特殊貨物コードに関する詳細については、[特殊貨物コードについて]()を参照ください。 |
|
POST | /API/v2/General/SpecialCargoCodes/RegisterAdmin |
特殊貨物種別を登録します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
POST | /API/v2/General/SpecialCargoCodes/RegisterInternal |
特殊貨物種別を登録します。 内部呼び出し用。 (*For admin) |
StandardProcesses
標準プロセス
API | Description | ||
---|---|---|---|
GET | /API/v2/Master/StandardProcesses/CanAccept/{processCode}?organizationId={organizationId}&openId={openId} |
指定したプロセスで「帳票を受け取るパートナー」になる権限があるかを判定します。 指定した組織がプロセスで取り扱う全ての帳票に対してR権限以上を持っていれば true, そうでなければ false。 内部呼び出し用 |
|
GET | /API/v2/Master/StandardProcesses/CanSubmit/{processCode}?organizationId={organizationId}&openId={openId} |
指定したプロセスで「帳票を提出するパートナー」になる権限があるかを判定します。 指定した組織がプロセスで取り扱う全ての帳票に対してRW権限を持っていれば true, そうでなければ false。 内部呼び出し用 |
|
DELETE | /API/v2/Master/StandardProcesses/DeleteAdmin/{processCode} |
プロセスコードを指定して、標準プロセスを削除します。 プロセスコード(***processCode***)を指定して、標準プロセスを削除します。 このAPIはシステム管理者しか呼び出せません。 (*For admin) |
|
GET | /API/v2/Master/StandardProcesses/Get/{processCode}?organizationId=!{organizationId} |
プロセスコードを指定して、標準プロセスを取得します プロセスコード(***processCode***)を指定して、標準プロセスを取得します。 グループ配下のプロセスも含めて、取得する場合は、(***/API/v2/Master/StandardProcesses/GetList***)を使用します。 プロセスに関する詳細については、[プロセスについて]()を参照ください。 |
|
GET | /API/v2/Master/StandardProcesses/GetList/{tradeType}?processGroupCode=!{processGroupCode}&processCode=!{processCode}&organizationId=!{organizationId} |
標準プロセスを全てを取得します 取引タイプ(***tradeType***)を指定して、プロセスグループ、その配下の標準プロセスを全てを取得します 組織の事業種別ID(***assignedBusinessTypeId***)を指定すると、選択可能なプロセス種別(***selectableProcessTypes***)にて、そのプロセスで帳票を提出できる事業者なのか、受け取ることができる事業者なのかが確認できます。 プロセスに関する詳細については、[プロセスについて]()を参照ください。 |
|
POST | /API/v2/Master/StandardProcesses/RegisterAdmin |
標準プロセスを登録します。 このAPIはシステム管理者しか呼び出せません。 (*For admin) |
|
POST | /API/v2/Master/StandardProcesses/RegisterInternal |
標準プロセスを登録します。 内部呼び出し用。 (*For admin) |
Submitters
帳票を提出する事業種別
API | Description | ||
---|---|---|---|
DELETE | /API/v2/Master/StandardProcesses/Submitters/DeleteAdmin/{standardProcessSubmitterCode} |
帳票を提出する事業種別コードを指定して、帳票を提出する事業種別を削除します。 帳票を提出する事業種別コード(***standardProcessSubmitterCode***)プロセスで取り扱う帳票を提出する事業種別を削除します。 このAPIはシステム管理者しか呼び出せません。 (*For admin) |
|
GET | /API/v2/Master/StandardProcesses/Submitters/Get/{standardProcessSubmitterCode} |
帳票を提出する事業種別コードを指定して、帳票を提出する事業種別を取得します 帳票を提出する事業種別コード(***standardProcessSubmitterCode***)を指定して、プロセスで取り扱う帳票を提出する事業種別を取得します。 グループ配下のプロセスも含めて、取得する場合は、(***/API/v2/Master/StandardProcesses/GetList***)を使用します。 プロセスに関する詳細については、[プロセスについて]()を参照ください。 |
|
POST | /API/v2/Master/StandardProcesses/Submitters/RegisterAdmin |
帳票を提出する事業種別を登録します。 このAPIはシステム管理者しか呼び出せません。 (*For admin) |
|
POST | /API/v2/Master/StandardProcesses/Submitters/RegisterInternal |
帳票を提出する事業種別を登録します。 内部呼び出し用。 (*For admin) |
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 |
タスク依頼のステータスを変更します。 |
Tasks
タスク
API | Description | ||
---|---|---|---|
POST | /API/v2/Reports/Tasks/Assign |
帳票にタスクを割り当てます。 タスクは、取引内の帳票に対して、更新や送信を行う取引内のパートナーを「担当するパートナー」として設定したり、帳票に対して「必須項目」を設定する機能です。 必須項目が設定されたタスクが割り当てられた帳票は、帳票の提出時に、必須項目のチェックが行われ、必須項目が入力されていない場合、帳票の提出は出来なくなります。 タスクの担当となった取引のパートナーは、この必須項目の設定に従い、帳票の項目を入力します。 タスクが割り当てられた帳票の提出に成功すると、そのタスクを担当するパートナーは、タスクを依頼したパートナーに切り替わります。 タスクに関する詳細については、[タスクについて]()を参照ください。 |
|
GET | /API/v2/Reports/Tasks/Get/{taskId} |
タスクを取得します。 タスクID(***taskId***)を指定して、タスクを取得します。 対象となる取引に、利用者が所属する組織が参加、かつ、タスクが作成されている帳票にアクセス権限を持っている必要があります。 タスクに関する詳細については、[タスクについて]()を参照ください。 |
|
GET | /API/v2/Reports/Tasks/GetAssignedCount?tradeNo=!{tradeNo}&reportId=!{reportId} |
指定された条件で、利用者が所属する組織が担当となっているタスクの件数を取得します。 取引管理番号(***tradeNo***)や帳票ID(***reportId***)を指定して、利用者が所属する組織が担当となっているタスクの件数を取得します。 タスクに関する詳細については、[タスクについて]()を参照ください。 |
|
GET | /API/v2/Reports/Tasks/GetList?taskId=!{taskId}&taskTitle=!{taskTitle}&tradeNo=!{tradeNo}&reportId=!{reportId}&reportCode=!{reportCode}&processId=!{processId}&organizationIdAsAssignor=!{organizationIdAsAssignor}&organizationIdAsAssignee=!{organizationIdAsAssignee}&employeeIdAsAssignee=!{employeeIdAsAssignee}&statusList=!{statusList}&assignedToMe=!{assignedToMe} |
検索条件を指定して、該当するタスク全てを取得します。 検索条件を指定して、条件に該当するタスクを全て取得します。 取得できるタスクは、対象となる取引に、利用者が所属する組織が参加、かつ、タスクが割り当てられた帳票にアクセス権限を持っているものに限定されます。 タスクに関する詳細については、[タスクについて]()を参照ください。 |
|
PATCH | /API/v2/Reports/Tasks/SetAssignee/{taskId} |
取引内でタスクを担当する取引内のパートナーや担当者を変更します。 タスクID(***taskId***)を指定して、タスクを担当するパートナーを変更します。 タスクを担当するパートナーを変更できるのは、その帳票にアクセス権限を持つパートナーに所属する利用者です。 タスクに関する詳細については、[タスクについて]()を参照ください。 |
|
PATCH | /API/v2/Reports/Tasks/SetRequiredFields/{taskId} |
取引内でタスクの必須項目を更新します。 タスクID(***taskId***)を指定して、タスクの必須項目を更新します。 タスクの必須項目を変更できるのは、その帳票にアクセス権限を持つパートナーに所属する利用者です。 タスクに関する詳細については、[タスクについて]()を参照ください。 |
|
PATCH | /API/v2/Reports/Tasks/SetStatus/{taskId} |
取引内でタスクのステータスを更新します。 タスクID(***taskId***)を指定して、タスクのステータスを更新します。 タスクのステータスを変更できるのは、その帳票にアクセス権限を持つパートナーに所属する利用者です。 タスクに関する詳細については、[タスクについて]()を参照ください。 |
|
PATCH | /API/v2/Reports/Tasks/SetTaskTitle/{taskId} |
取引内でタスクのタイトルを更新します。 タスクID(***taskId***)を指定して、タスクのタイトルを更新します。 タスクのタイトルを変更できるのは、その帳票にアクセス権限を持つパートナーに所属する利用者です。 タスクに関する詳細については、[タスクについて]()を参照ください。 |
|
PATCH | /API/v2/Reports/Tasks/SetTitle/{taskId} |
取引内でタスクのタイトルを更新します。 タスクID(***taskId***)を指定して、タスクのタイトルを更新します。 タスクのタイトルを変更できるのは、そのタスクを依頼にアクセス権限を持つパートナーに所属する利用者です。 タスクに関する詳細については、[タスクについて]()を参照ください。 |
TerminalInquiries
ターミナル問合せ
API | Description | ||
---|---|---|---|
POST | /API/v2/Reports/TerminalInquiries/Create |
ターミナル問合せを作成します。 ターミナル問合せを作成するには、利用者がターミナル問合せを作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 ターミナル問合せに関する詳細については、[ターミナル問合せについて]()を参照ください。 |
|
DELETE | /API/v2/Reports/TerminalInquiries/Delete/{reportId} |
ターミナル問合せを削除します。 帳票ID(***reportId***)を指定して、ターミナル問合せを削除します。 ターミナル問合せを削除しても、ルートドキュメントの内容までは削除されません。 申請種別を使用して、作成したターミナル問合せのキャンセルを伝える場合は、キャンセル(***Cancel***)を実施後、帳票の提出(***Submit***)を実施してください。 ターミナル問合せに関する詳細については、[ターミナル問合せについて]()を参照ください。 |
|
DELETE | /API/v2/Reports/TerminalInquiries/DeleteFile/{fileId} |
ターミナル問合せの添付ファイルを削除します。 ファイルID(***fileId***)を指定して、ターミナル問合せの添付ファイルを削除します。 帳票の添付ファイルを削除できるのは、そのファイルを添付したパートナーに所属している利用者だけです。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
GET | /API/v2/Reports/TerminalInquiries/Get/{reportId} |
ターミナル問合せを取得します。 帳票ID(***reportId***)を指定して、ターミナル問合せを取得します。 編集が行われていない場合は、ルートドキュメントから最新の搬入確認依頼票を取得します。 編集中の場合は、先に保存した、ターミナル問合せを取得します。 ターミナル問合せに関する詳細については、[ターミナル問合せについて]()を参照ください。 |
|
GET | /API/v2/Reports/TerminalInquiries/GetFile/{fileId} |
ターミナル問合せに添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、ターミナル問合せに添付されたファイルを取得します。 帳票の添付ファイルを獲得できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
GET | /API/v2/Reports/TerminalInquiries/GetList?tradeNo=!{tradeNo}&uniqueNo=!{uniqueNo}&bookingNo=!{bookingNo}&blNo=!{blNo} |
ターミナル問合せを全て取得します。 検索条件に該当するターミナル問合せを全て取得します。 編集が行われていない場合は、ルートドキュメントから最新のターミナル問合せを取得します。 編集中の場合は、先に保存した、ターミナル問合せを取得します。 ターミナル問合せに関する詳細については、[ターミナル問合せについて]()を参照ください。 |
|
PATCH | /API/v2/Reports/TerminalInquiries/Lock/{reportId} |
編集するため、ターミナル問合せをロックします 帳票ID(***reportId***)を指定して、ターミナル問合せをロックします。 ターミナル問合せを作成(***Create***)した時点では、ターミナル問合せをロックが掛かりますが、取得(***Get***)したあとで、ターミナル問合せを編集する場合は、このメソッドを呼び出して、ターミナル問合せをロックします。 ロックされたターミナル問合せは、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、ターミナル問合せをルートドキュメントから参照できますが、編集中(ロック中)のターミナル問合せは参照できません。 このロックは、アンロック(***Unlock***)を呼び出すか、帳票の保存後、帳票の提出(***Submit****)を行うと解除されます。 ターミナル問合せに関する詳細については、[ターミナル問合せについて]()を参照ください。 |
|
PATCH | /API/v2/Reports/TerminalInquiries/SetCancel/{reportId} |
ターミナル問合せの申請種別をキャンセルします 帳票ID(***reportId***)を指定して、ターミナル問合せの申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 ターミナル問合せに関する詳細については、[ターミナル問合せについて]()を参照ください。 |
|
PATCH | /API/v2/Reports/TerminalInquiries/Submit/{reportId} |
ターミナル問合せを提出します 帳票ID(***reportId***)を指定して、更新(***Update***)したターミナル問合せを提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、ターミナル問合せが参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ターミナル問合せもロックされた状態のままなので、ご注意ください。 ターミナル問合せに関する詳細については、[ターミナル問合せについて]()を参照ください。 |
|
PATCH | /API/v2/Reports/TerminalInquiries/Unlock/{reportId} |
ターミナル問合せのロックを解除します 帳票ID(***reportId***)を指定して、ターミナル問合せのロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 ターミナル問合せに関する詳細については、[ターミナル問合せについて]()を参照ください。 |
|
PATCH | /API/v2/Reports/TerminalInquiries/Update/{reportId} |
ターミナル問合せを更新します。 帳票ID(***reportId***)を指定して、ターミナル問合せを更新します。 このメソッドでは、ターミナル問合せの更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 ターミナル問合せに関する詳細については、[ターミナル問合せについて]()を参照ください。 |
|
POST | /API/v2/Reports/TerminalInquiries/UploadFile |
ターミナル問合せにファイルを添付します。 指定されたターミナル問合せに、ファイルを添付します。 帳票にファイルを添付できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
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***)のセットで指定します。 |
TerminalPayments
ターミナル支払申込兼入金通知書
API | Description | ||
---|---|---|---|
POST | /API/v2/Reports/TerminalPayments/Create |
ターミナル支払申込兼入金通知書を作成します。 ターミナル支払申込兼入金通知書を作成するには、利用者がターミナル支払申込兼入金通知書を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 ターミナル支払申込兼入金通知書に関する詳細については、[ターミナル支払申込兼入金通知書について]()を参照ください。 |
|
DELETE | /API/v2/Reports/TerminalPayments/Delete/{reportId} |
ターミナル支払申込兼入金通知書を削除します。 帳票ID(***reportId***)を指定して、ターミナル支払申込兼入金通知書を削除します。 ターミナル支払申込兼入金通知書を削除しても、ルートドキュメントの内容までは削除されません。 申請種別を使用して、作成したターミナル支払申込兼入金通知書のキャンセルを伝える場合は、キャンセル(***Cancel***)を実施後、帳票の提出(***Submit***)を実施してください。 ターミナル支払申込兼入金通知書に関する詳細については、[ターミナル支払申込兼入金通知書について]()を参照ください。 |
|
DELETE | /API/v2/Reports/TerminalPayments/DeleteFile/{fileId} |
ターミナル支払申込兼入金通知書の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、ターミナル支払申込兼入金通知書の添付ファイルを削除します。 帳票の添付ファイルを削除できるのは、そのファイルを添付したパートナーに所属している利用者だけです。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
GET | /API/v2/Reports/TerminalPayments/Get/{reportId} |
ターミナル支払申込兼入金通知書を取得します。 帳票ID(***reportId***)を指定して、ターミナル支払申込兼入金通知書を取得します。 編集が行われていない場合は、ルートドキュメントから最新の搬入確認依頼票を取得します。 編集中の場合は、先に保存した、ターミナル支払申込兼入金通知書を取得します。 ターミナル支払申込兼入金通知書に関する詳細については、[ターミナル支払申込兼入金通知書について]()を参照ください。 |
|
GET | /API/v2/Reports/TerminalPayments/GetFile/{fileId} |
ターミナル支払申込兼入金通知書に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、ターミナル支払申込兼入金通知書に添付されたファイルを取得します。 帳票の添付ファイルを獲得できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
GET | /API/v2/Reports/TerminalPayments/GetList?tradeNo=!{tradeNo}&uniqueNo=!{uniqueNo}&bookingNo=!{bookingNo}&blNo=!{blNo} |
ターミナル支払申込兼入金通知書を全て取得します。 検索条件に該当するターミナル支払申込兼入金通知書を全て取得します。 編集が行われていない場合は、ルートドキュメントから最新のターミナル支払申込兼入金通知書を取得します。 編集中の場合は、先に保存した、ターミナル支払申込兼入金通知書を取得します。 ターミナル支払申込兼入金通知書に関する詳細については、[ターミナル支払申込兼入金通知書について]()を参照ください。 |
|
PATCH | /API/v2/Reports/TerminalPayments/Lock/{reportId} |
編集するため、ターミナル支払申込兼入金通知書をロックします 帳票ID(***reportId***)を指定して、ターミナル支払申込兼入金通知書をロックします。 ターミナル支払申込兼入金通知書を作成(***Create***)した時点では、ターミナル支払申込兼入金通知書をロックが掛かりますが、取得(***Get***)したあとで、ターミナル支払申込兼入金通知書を編集する場合は、このメソッドを呼び出して、ターミナル支払申込兼入金通知書をロックします。 ロックされたターミナル支払申込兼入金通知書は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、ターミナル支払申込兼入金通知書をルートドキュメントから参照できますが、編集中(ロック中)のターミナル支払申込兼入金通知書は参照できません。 このロックは、アンロック(***Unlock***)を呼び出すか、帳票の保存後、帳票の提出(***Submit****)を行うと解除されます。 ターミナル支払申込兼入金通知書に関する詳細については、[ターミナル支払申込兼入金通知書について]()を参照ください。 |
|
PATCH | /API/v2/Reports/TerminalPayments/SetCancel/{reportId} |
ターミナル支払申込兼入金通知書の申請種別をキャンセルします 帳票ID(***reportId***)を指定して、ターミナル支払申込兼入金通知書の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 ターミナル支払申込兼入金通知書に関する詳細については、[ターミナル支払申込兼入金通知書について]()を参照ください。 |
|
PATCH | /API/v2/Reports/TerminalPayments/Submit/{reportId} |
ターミナル支払申込兼入金通知書を提出します 帳票ID(***reportId***)を指定して、更新(***Update***)したターミナル支払申込兼入金通知書を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、ターミナル問合せが参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ターミナル支払申込兼入金通知書もロックされた状態のままなので、ご注意ください。 ターミナル支払申込兼入金通知書に関する詳細については、[ターミナル支払申込兼入金通知書について]()を参照ください。 |
|
PATCH | /API/v2/Reports/TerminalPayments/Unlock/{reportId} |
ターミナル支払申込兼入金通知書のロックを解除します 帳票ID(***reportId***)を指定して、ターミナル支払申込兼入金通知書のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 ターミナル支払申込兼入金通知書に関する詳細については、[ターミナル支払申込兼入金通知書について]()を参照ください。 |
|
PATCH | /API/v2/Reports/TerminalPayments/Update/{reportId} |
ターミナル支払申込兼入金通知書を更新します。 帳票ID(***reportId***)を指定して、ターミナル支払申込兼入金通知書を更新します。 このメソッドでは、ターミナル支払申込兼入金通知書の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 ターミナル支払申込兼入金通知書に関する詳細については、[ターミナル支払申込兼入金通知書について]()を参照ください。 |
|
POST | /API/v2/Reports/TerminalPayments/UploadFile |
ターミナル支払申込兼入金通知書にファイルを添付します。 指定されたターミナル支払申込兼入金通知書に、ファイルを添付します。 帳票にファイルを添付できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
Trades
取引
UnLoCodes
国連LOCODE
API | Description | ||
---|---|---|---|
GET | /API/v2/General/UnLoCodes/Get/{unLoCode} |
国連LOCODEを取得します。 国連LOCODE(***unLoCode***)を指定して、国連LOCODEを取得します。 NACCSから連携されるマスターデータに関する詳細については、[NACCSから連携されるマスターデータについて]()を参照ください。 |
|
GET | /API/v2/General/UnLoCodes/GetList?unLoCode=!{unLoCode}&countryCode=!{countryCode}&areaCode=!{areaCode}&areaName=!{areaName}&iataCode=!{iataCode}&countryNameAb=!{countryNameAb}&destinationRegion=!{destinationRegion}&isAirportOrPort=!{isAirportOrPort}&isInternalOrExternal=!{isInternalOrExternal} |
国連LOCODEを取得します。 検索条件に該当する国連LOCODEを全て取得します。 NACCSから連携されるマスターデータに関する詳細については、[NACCSから連携されるマスターデータについて]()を参照ください。 |
UsedWebhooks
組織のWebhook設定
API | Description | ||
---|---|---|---|
DELETE | /API/v2/Organizations/UsedWebhooks/Delete/{usedWebhookId} |
組織からWebhook設定を削除します。 組織のWebhook設定ID(***usedWebhookId***)を指定して、組織からWebhook設定を削除します。 このメソッドは会社の管理者(***/API/v2/Companies/Administrators***)として登録された利用者が利用できます。 Webhook設定に関する詳細については、[Webhook設定について]()を参照ください。 |
|
GET | /API/v2/Organizations/UsedWebhooks/Get/{usedWebhookId} |
組織で使用するWebhook設定を取得します。 組織のWebhook設定ID(***usedWebhookId***)を指定して、組織に使用するWebhook設定を取得します。 Webhook設定に関する詳細については、[Webhook設定について]()を参照ください。 |
|
GET | /API/v2/Organizations/UsedWebhooks/GetList?webhookId=!{webhookId}&webhookName=!{webhookName}&organizationId=!{organizationId} |
組織に使用するWebhook設定を全て取得します。 組織ID(***organizationId***)を指定して、組織に使用するWebhook設定を全て取得します。 Webhook設定に関する詳細については、[Webhook設定について]()を参照ください。 |
|
POST | /API/v2/Organizations/UsedWebhooks/Register |
組織で使用するWebhook設定を登録します。 管理者が所属する会社の組織に、Webhook設定を登録します。 このメソッドは会社の管理者(***/API/v2/Companies/Administrators***)として登録された利用者が利用できます。 Webhook設定に関する詳細については、[Webhook設定について]()を参照ください。 |
UseNaccsUsers
利用者が使用するNACCS利用者
API | Description | ||
---|---|---|---|
DELETE | /API/v2/Employees/UseNaccsUsers/Delete/{useNaccsUserId} |
利用者が使用するNACCS利用者を削除します。 利用者が使用するNACCS利用者ID(***useNaccsUserId***)を指定して、ログインしている利用者が使用するNACCS利用者を削除します。 このメソッドは会社の管理者(***/API/v2/Companies/Administrators***)として登録された利用者が利用できます。 NACCS 利用者に関する詳細については、[NACCS 利用者について]()を参照ください。 |
|
GET | /API/v2/Employees/UseNaccsUsers/Get/{useNaccsUserId} |
利用者が使用するNACCS利用者を取得します。 利用者が使用するNACCS利用者ID(***useNaccsUserId***)を指定して、ログインしている利用者が使用するNACCS利用者を取得します。 NACCS 利用者に関する詳細については、[NACCS 利用者について]()を参照ください。 |
|
GET | /API/v2/Employees/UseNaccsUsers/GetList |
自社に登録されている利用者が使用するNACCS利用者を取得します。 NACCS 利用者に関する詳細については、[NACCS 利用者について]()を参照ください。 |
|
GET | /API/v2/Employees/UseNaccsUsers/GetMyNaccsUser |
自身のNACCS利用者を取得します。 NACCS 利用者に関する詳細については、[NACCS 利用者について]()を参照ください。 |
|
POST | /API/v2/Employees/UseNaccsUsers/Register |
利用者が使用するNACCS利用者を登録します。 管理者が所属する会社の利用者が使用するNACCS利用者を登録します。 このメソッドは会社の管理者(***/API/v2/Companies/Administrators***)として登録された利用者が利用できます。 NACCS 利用者に関する詳細については、[NACCS 利用者について]()を参照ください。 |
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でのレスポンスデータを編集し、指定するようにしてください。 |
VanningCyCarryInRegistrationCalls
VAH11
API | Description | ||
---|---|---|---|
POST | /API/v1/NaccsReport/VanningCyCarryInRegistrationCalls/Create |
帳票:VAH11を作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 帳票:VAH11が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。 |
|
DELETE | /API/v1/NaccsReport/VanningCyCarryInRegistrationCalls/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:VAH11を削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
GET | /API/v1/NaccsReport/VanningCyCarryInRegistrationCalls/Get/{dealReportId} |
帳票:VAH11を取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/NaccsReport/VanningCyCarryInRegistrationCalls/GetAttachFileMetaList/{dealReportId} |
添付ファイル情報一覧を取得します。 |
|
POST | /API/v1/NaccsReport/VanningCyCarryInRegistrationCalls/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/VanningCyCarryInRegistrationCalls/Register |
帳票:VAH11を保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。 このバージョン識別子(***_etag***)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。 Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。 |
VanningCyCarryInRegistrations
VAH
API | Description | ||
---|---|---|---|
POST | /API/v1/NaccsReport/VanningCyCarryInRegistrations/Create |
帳票:VAHを作成します。 ## 概要 帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 |
|
DELETE | /API/v1/NaccsReport/VanningCyCarryInRegistrations/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:VAHを削除します。 ## 概要 帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。 |
|
GET | /API/v1/NaccsReport/VanningCyCarryInRegistrations/Get/{dealReportId} |
帳票:VAHを取得します。 ## 概要 帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してRead権限が必要です。 取引・帳票ID(***dealReportId***)は帳票を一意に識別するIDです。 |
|
GET | /API/v1/NaccsReport/VanningCyCarryInRegistrations/GetAttachFileMetaList/{dealReportId} |
添付ファイル情報一覧を取得します。 |
|
POST | /API/v1/NaccsReport/VanningCyCarryInRegistrations/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/VanningCyCarryInRegistrations/Register |
帳票:VAHを保存します。 ## 概要 帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対して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でのレスポンスデータを編集し、指定するようにしてください。 |
VanningInstructions
バンニング作業依頼書
API | Description | ||
---|---|---|---|
POST | /API/v2/Reports/VanningInstructions/Create |
バンニング作業依頼書を作成します。 バンニング作業依頼書を作成するには、利用者がバンニング作業依頼書を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 バンニング作業依頼書に関する詳細については、[バンニング作業依頼書について]()を参照ください。 |
|
DELETE | /API/v2/Reports/VanningInstructions/Delete/{reportId} |
バンニング作業依頼書を削除します。 帳票ID(***reportId***)を指定して、バンニング作業依頼書を削除します。 バンニング作業依頼書を削除しても、ルートドキュメントの内容までは削除されません。 申請種別を使用して、作成したバンニング作業依頼書のキャンセルを伝える場合は、キャンセル(***Cancel***)を実施後、帳票の提出(***Submit***)を実施してください。 バンニング作業依頼書に関する詳細については、[バンニング作業依頼書について]()を参照ください。 |
|
DELETE | /API/v2/Reports/VanningInstructions/DeleteFile/{fileId} |
バンニング作業依頼書の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、バンニング作業依頼書の添付ファイルを削除します。 帳票の添付ファイルを削除できるのは、そのファイルを添付したパートナーに所属している利用者だけです。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
GET | /API/v2/Reports/VanningInstructions/Get/{reportId} |
バンニング作業依頼書を取得します。 帳票ID(***reportId***)を指定して、バンニング作業依頼書を取得します。 編集が行われていない場合は、ルートドキュメントから最新のバンニング作業依頼書を取得します。 編集中の場合は、先に保存した、バンニング作業依頼書を取得します。 バンニング作業依頼書に関する詳細については、[バンニング作業依頼書について]()を参照ください。 |
|
GET | /API/v2/Reports/VanningInstructions/GetFile/{fileId} |
バンニング作業依頼書に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、バンニング作業依頼書に添付されたファイルを取得します。 帳票の添付ファイルを獲得できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
GET | /API/v2/Reports/VanningInstructions/GetList?tradeNo=!{tradeNo}&uniqueNo=!{uniqueNo}&bookingNo=!{bookingNo}&blNo=!{blNo} |
バンニング作業依頼書を全て取得します。 検索条件に該当するバンニング作業依頼書を全て取得します。 編集が行われていない場合は、ルートドキュメントから最新のバンニング作業依頼書を取得します。 編集中の場合は、先に保存した、バンニング作業依頼書を取得します。 バンニング作業依頼書に関する詳細については、[バンニング作業依頼書について]()を参照ください。 |
|
PATCH | /API/v2/Reports/VanningInstructions/Lock/{reportId} |
編集するため、バンニング作業依頼書をロックします 帳票ID(***reportId***)を指定して、バンニング作業依頼書をロックします。 バンニング作業依頼書を作成(***Create***)した時点では、バンニング作業依頼書をロックが掛かりますが、取得(***Get***)したあとで、バンニング作業依頼書を編集する場合は、このメソッドを呼び出して、バンニング作業依頼書をロックします。 ロックされたバンニング作業依頼書は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、バンニング作業依頼書をルートドキュメントから参照できますが、編集中(ロック中)のバンニング作業依頼書は参照できません。 このロックは、アンロック(***Unlock***)を呼び出すか、帳票の保存後、帳票の提出(***Submit****)を行うと解除されます。 バンニング作業依頼書に関する詳細については、[バンニング作業依頼書について]()を参照ください。 |
|
PATCH | /API/v2/Reports/VanningInstructions/SetCancel/{reportId} |
バンニング作業依頼書の申請種別をキャンセルします 帳票ID(***reportId***)を指定して、バンニング作業依頼書の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 バンニング作業依頼書に関する詳細については、[バンニング作業依頼書について]()を参照ください。 |
|
PATCH | /API/v2/Reports/VanningInstructions/Submit/{reportId} |
バンニング作業依頼書を提出します 帳票ID(***reportId***)を指定して、更新(***Update***)したバンニング作業依頼書を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、バンニング作業依頼書が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、バンニング作業依頼書もロックされた状態のままなので、ご注意ください。 バンニング作業依頼書に関する詳細については、[バンニング作業依頼書について]()を参照ください。 |
|
PATCH | /API/v2/Reports/VanningInstructions/Unlock/{reportId} |
バンニング作業依頼書のロックを解除します 帳票ID(***reportId***)を指定して、バンニング作業依頼書のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 バンニング作業依頼書に関する詳細については、[バンニング作業依頼書について]()を参照ください。 |
|
PATCH | /API/v2/Reports/VanningInstructions/Update/{reportId} |
バンニング作業依頼書を更新します。 帳票ID(***reportId***)を指定して、バンニング作業依頼書を更新します。 このメソッドでは、バンニング作業依頼書の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 バンニング作業依頼書に関する詳細については、[バンニング作業依頼書について]()を参照ください。 |
|
POST | /API/v2/Reports/VanningInstructions/UploadFile |
バンニング作業依頼書にファイルを添付します。 指定されたバンニング作業依頼書に、ファイルを添付します。 帳票にファイルを添付できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
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でのレスポンスデータを編集し、指定するようにしてください。 |
VerifiedGrossMassReports
コンテナ確定重量報告書
API | Description | ||
---|---|---|---|
POST | /API/v2/Reports/VerifiedGrossMassReports/Create |
コンテナ確定重量報告書を作成します。 コンテナ確定重量報告書を作成するには、利用者がコンテナ確定重量報告書を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 コンテナ確定重量報告書に関する詳細については、[コンテナ確定重量報告書について]()を参照ください。 |
|
DELETE | /API/v2/Reports/VerifiedGrossMassReports/Delete/{reportId} |
コンテナ確定重量報告書を削除します。 帳票ID(***reportId***)を指定して、コンテナ確定重量報告書を削除します。 コンテナ確定重量報告書を削除しても、ルートドキュメントの内容までは削除されません。 申請種別を使用して、作成したコンテナ確定重量報告書のキャンセルを伝える場合は、キャンセル(***Cancel***)を実施後、帳票の提出(***Submit***)を実施してください。 コンテナ確定重量報告書に関する詳細については、[コンテナ確定重量報告書について]()を参照ください。 |
|
DELETE | /API/v2/Reports/VerifiedGrossMassReports/DeleteFile/{fileId} |
コンテナ確定重量報告書の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、コンテナ確定重量報告書の添付ファイルを削除します。 帳票の添付ファイルを削除できるのは、そのファイルを添付したパートナーに所属している利用者だけです。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
GET | /API/v2/Reports/VerifiedGrossMassReports/Get/{reportId} |
コンテナ確定重量報告書を取得します。 帳票ID(***reportId***)を指定して、コンテナ確定重量報告書を取得します。 編集が行われていない場合は、ルートドキュメントから最新のコンテナ確定重量報告書を取得します。 編集中の場合は、先に保存した、コンテナ確定重量報告書を取得します。 コンテナ確定重量報告書に関する詳細については、[コンテナ確定重量報告書について]()を参照ください。 |
|
GET | /API/v2/Reports/VerifiedGrossMassReports/GetFile/{fileId} |
コンテナ確定重量報告書に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、コンテナ確定重量報告書に添付されたファイルを取得します。 帳票の添付ファイルを獲得できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
GET | /API/v2/Reports/VerifiedGrossMassReports/GetList?tradeNo=!{tradeNo}&uniqueNo=!{uniqueNo}&bookingNo=!{bookingNo}&blNo=!{blNo} |
コンテナ確定重量報告書を全て取得します。 検索条件に該当するコンテナ確定重量報告書を全て取得します。 編集が行われていない場合は、ルートドキュメントから最新のコンテナ確定重量報告書を取得します。 編集中の場合は、先に保存した、コンテナ確定重量報告書を取得します。 コンテナ確定重量報告書に関する詳細については、[コンテナ確定重量報告書について]()を参照ください。 |
|
PATCH | /API/v2/Reports/VerifiedGrossMassReports/Lock/{reportId} |
編集するため、コンテナ確定重量報告書をロックします 帳票ID(***reportId***)を指定して、コンテナ確定重量報告書をロックします。 コンテナ確定重量報告書を作成(***Create***)した時点では、コンテナ確定重量報告書をロックが掛かりますが、取得(***Get***)したあとで、コンテナ確定重量報告書を編集する場合は、このメソッドを呼び出して、コンテナ貨物搬入票をロックします。 ロックされたコンテナ確定重量報告書は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、コンテナ確定重量報告書をルートドキュメントから参照できますが、編集中(ロック中)のコンテナ確定重量報告書は参照できません。 このロックは、アンロック(***Unlock***)を呼び出すか、帳票の保存後、帳票の提出(***Submit****)を行うと解除されます。 コンテナ確定重量報告書に関する詳細については、[コンテナ確定重量報告書について]()を参照ください。 |
|
PATCH | /API/v2/Reports/VerifiedGrossMassReports/SetCancel/{reportId} |
コンテナ確定重量報告書の申請種別をキャンセルします 帳票ID(***reportId***)を指定して、コンテナ確定重量報告書の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 コンテナ確定重量報告書に関する詳細については、[コンテナ確定重量報告書について]()を参照ください。 |
|
PATCH | /API/v2/Reports/VerifiedGrossMassReports/Submit/{reportId} |
コンテナ確定重量報告書を提出します 帳票ID(***reportId***)を指定して、更新(***Update***)したコンテナ確定重量報告書を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、コンテナ確定重量報告書が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、コンテナ確定重量報告書もロックされた状態のままなので、ご注意ください。 コンテナ確定重量報告書に関する詳細については、[コンテナ確定重量報告書について]()を参照ください。 |
|
PATCH | /API/v2/Reports/VerifiedGrossMassReports/Unlock/{reportId} |
コンテナ確定重量報告書のロックを解除します 帳票ID(***reportId***)を指定して、コンテナ確定重量報告書のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 コンテナ確定重量報告書に関する詳細については、[コンテナ確定重量報告書について]()を参照ください。 |
|
PATCH | /API/v2/Reports/VerifiedGrossMassReports/Update/{reportId} |
コンテナ確定重量報告書を更新します。 帳票ID(***reportId***)を指定して、コンテナ確定重量報告書を更新します。 このメソッドでは、コンテナ確定重量報告書の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 コンテナ確定重量報告書に関する詳細については、[コンテナ確定重量報告書について]()を参照ください。 |
|
POST | /API/v2/Reports/VerifiedGrossMassReports/UploadFile |
コンテナ確定重量報告書にファイルを添付します。 指定されたコンテナ確定重量報告書に、ファイルを添付します。 帳票にファイルを添付できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
VgmCertifiedCompanies
VGM確定事業者
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***) |
Warehousings
入庫票
API | Description | ||
---|---|---|---|
POST | /API/v2/Reports/Warehousings/Create |
入庫票を作成します。 入庫票を作成するには、利用者が入庫票を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 入庫票に関する詳細については、[入庫票について]()を参照ください。 |
|
DELETE | /API/v2/Reports/Warehousings/Delete/{reportId} |
入庫票を削除します。 帳票ID(***reportId***)を指定して、入庫票を削除します。 入庫票を削除しても、ルートドキュメントの内容までは削除されません。 申請種別を使用して、作成した入庫票のキャンセルを伝える場合は、キャンセル(***Cancel***)を実施後、帳票の提出(***Submit***)を実施してください。 入庫票に関する詳細については、[入庫票について]()を参照ください。 |
|
DELETE | /API/v2/Reports/Warehousings/DeleteFile/{fileId} |
入庫票の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、入庫票の添付ファイルを削除します。 帳票の添付ファイルを削除できるのは、そのファイルを添付したパートナーに所属している利用者だけです。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
GET | /API/v2/Reports/Warehousings/Get/{reportId} |
入庫票を取得します。 帳票ID(***reportId***)を指定して、入庫票を取得します。 編集が行われていない場合は、ルートドキュメントから最新の入庫票を取得します。 編集中の場合は、先に保存した、入庫票を取得します。 入庫票に関する詳細については、[入庫票について]()を参照ください。 |
|
GET | /API/v2/Reports/Warehousings/GetFile/{fileId} |
入庫票に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、入庫票に添付されたファイルを取得します。 帳票の添付ファイルを獲得できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
GET | /API/v2/Reports/Warehousings/GetList?tradeNo=!{tradeNo}&uniqueNo=!{uniqueNo}&bookingNo=!{bookingNo}&blNo=!{blNo} |
入庫票を全て取得します。 検索条件に該当する入庫票を全て取得します。 編集が行われていない場合は、ルートドキュメントから最新の入庫票を取得します。 編集中の場合は、先に保存した、入庫票を取得します。 入庫票に関する詳細については、[入庫票について]()を参照ください。 |
|
PATCH | /API/v2/Reports/Warehousings/Lock/{reportId} |
編集するため、入庫票をロックします 帳票ID(***reportId***)を指定して、入庫票をロックします。 入庫票を作成(***Create***)した時点では、入庫票をロックが掛かりますが、取得(***Get***)したあとで、入庫票を編集する場合は、このメソッドを呼び出して、入庫票をロックします。 ロックされた入庫票は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、入庫票をルートドキュメントから参照できますが、編集中(ロック中)の入庫票は参照できません。 このロックは、アンロック(***Unlock***)を呼び出すか、帳票の保存後、帳票の提出(***Submit****)を行うと解除されます。 入庫票に関する詳細については、[入庫票について]()を参照ください。 |
|
PATCH | /API/v2/Reports/Warehousings/SetCancel/{reportId} |
入庫票の申請種別をキャンセルします 帳票ID(***reportId***)を指定して、入庫票の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 入庫票に関する詳細については、[入庫票について]()を参照ください。 |
|
PATCH | /API/v2/Reports/Warehousings/Submit/{reportId} |
入庫票を提出します 帳票ID(***reportId***)を指定して、更新(***Update***)した入庫票を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、入庫票が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、入庫票もロックされた状態のままなので、ご注意ください。 入庫票に関する詳細については、[入庫票について]()を参照ください。 |
|
PATCH | /API/v2/Reports/Warehousings/Unlock/{reportId} |
入庫票のロックを解除します 帳票ID(***reportId***)を指定して、入庫票のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 入庫票に関する詳細については、[入庫票について]()を参照ください。 |
|
PATCH | /API/v2/Reports/Warehousings/Update/{reportId} |
入庫票を更新します。 帳票ID(***reportId***)を指定して、入庫票を更新します。 このメソッドでは、入庫票の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 入庫票に関する詳細については、[入庫票について]()を参照ください。 |
|
POST | /API/v2/Reports/Warehousings/UploadFile |
入庫票にファイルを添付します。 指定された入庫票に、ファイルを添付します。 帳票にファイルを添付できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
Webhooks
Webhook設定
API | Description | ||
---|---|---|---|
DELETE | /API/v2/Webhooks/Delete/{webhookId} |
Webhook設定を削除します。 Webhook設定ID(***webhookId***)を指定して、Webhook設定を削除します。 このメソッドは会社の管理者(***/API/v2/Companies/Administrators***)として登録された利用者が利用できます。 Webhook設定に関する詳細については、[Webhook設定について]()を参照ください。 |
|
GET | /API/v2/Webhooks/Get/{webhookId} |
Webhook設定を取得します。 Webhook設定ID(***webhookId***)を指定して、Webhook設定を取得します。 Webhook設定に関する詳細については、[Webhook設定について]()を参照ください。 |
|
GET | /API/v2/Webhooks/GetList?webhookId=!{webhookId}&webhookName=!{webhookName} |
会社のWebhook設定を全て取得します。 ログインしている利用者が所属する会社配下に登録されている全てのWebhook設定を取得します。 Webhook設定に関する詳細については、[Webhook設定について]()を参照ください。 |
|
POST | /API/v2/Webhooks/Register |
所属する会社にWebhook設定を登録します。 管理者が所属する会社に、Webhook設定を登録します。 このメソッドは会社の管理者(***/API/v2/Companies/Administrators***)として登録された利用者が利用できます。 Webhook設定に関する詳細については、[Webhook設定について]()を参照ください。 |
|
PATCH | /API/v2/Webhooks/Update/{webhookId} |
Webhook設定を更新します。 Webhook設定ID(***webhookId***)を指定して、Webhook設定を更新します。 このメソッドは会社の管理者(***/API/v2/Companies/Administrators***)として登録された利用者が利用できます。 Webhook設定に関する詳細については、[Webhook設定について]()を参照ください。 |