CyCarryInRegistrations : /API/v1/NaccsReport/CyCarryInRegistrations
Venndor name
0000000000000_CyberPort(港湾物流分野)
System name
CyberPort
Infomation | |
Category |
|
Field |
|
Governments |
|
Data / Business logic |
|
Paid / Free |
Free |
Fees |
|
Created by |
|
Maintainer |
|
Date created |
|
Last updated |
|
Update frequency |
|
Necessity of contract |
Unnecessary |
About contract |
|
Version |
|
Terms and Conditions |
|
API List
API | Description | |
POST |
/API/v1/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でのレスポンスデータを編集し、指定するようにしてください。
|
|