倉庫エリア紐付マスタ入力 API仕様書
1. 概要
| 項目 |
内容 |
| サービス名 |
倉庫エリア紐付マスタ入力 |
| ベースURL |
https://web.kosmos.kokugo.co.jp |
| 認証方式 |
Bearerトークン(リクエストヘッダー Authorization) |
| 文字コード |
UTF-8 |
| データ形式 |
JSON |
2. 初期化API
2.1 概要
データの初期化
| 項目 |
内容 |
| エンドポイント |
/api/master/inputMAreaSokoR/index |
| HTTPメソッド |
POST |
| リクエスト形式 |
application/json |
| レスポンス形式 |
application/json |
2.2 リクエストパラメータ
ヘッダー
| 項目 |
必須 |
説明 |
例 |
Authorization |
必須 |
Bearerトークン |
Bearer eyJhbGciOiJIUzI1NiJ9... |
Content-Type |
必須 |
コンテンツタイプ |
application/json |
X-Requested-With |
必須 |
AJAXリクエスト識別子 |
XMLHttpRequest |
Accept |
推奨 |
レスポンス形式 |
application/json |
ボディ(リクエストJSON)
| フィールド |
型 |
必須 |
最大長 |
説明 |
例 |
row_ver |
integer |
必須 |
– |
行バージョン |
1 |
soko_c |
string |
必須 |
3 |
倉庫コード |
102 |
soko_area_c |
string |
必須 |
3 |
倉庫エリアコード |
101 |
order_num |
integer |
必須 |
– |
優先順位 |
1 |
2.3 リクエスト例
{}
2.4 レスポンス
成功時(200 OK)
{
"code": 200,
"msg": "処理が完了しました",
"data": {
"cre_func": null,
"cre_timestamp": null,
"cre_user_id": null,
"order_num": null,
"row_ver": 1,
"soko_area_c": null,
"soko_area_nm": null,
"soko_c": null,
"soko_nr": null,
"upd_func": null,
"upd_timestamp": null,
"upd_user_id": null
}
}
レスポンスフィールド
| フィールド |
型 |
説明 |
code |
integer |
ステータスコード(200: 成功) |
msg |
string |
処理結果メッセージ |
data |
object |
レスポンスデータ |
data フィールド詳細
| フィールド |
型 |
説明 |
例 |
data.cre_func |
string |
作成処理 |
ikou |
data.cre_timestamp |
string |
作成日時 |
2015-09-28 12:00:28 |
data.cre_user_id |
string |
作成ユーザID |
tanaka360 |
data.order_num |
integer |
優先順位 |
1 |
data.row_ver |
integer |
行バージョン |
1 |
data.soko_area_c |
string |
倉庫エリアコード |
101 |
data.soko_area_nm |
string |
倉庫エリア名 |
東京倉庫 |
data.soko_c |
string |
倉庫コード |
102 |
data.soko_nr |
string |
倉庫名 |
東京倉庫 |
data.upd_func |
string |
更新処理 |
ikou |
data.upd_timestamp |
string |
|
2015-10-01 08:49:00 |
data.upd_user_id |
string |
更新ユーザID |
tanaka360 |
3. 参照API
3.1 概要
データの参照
| 項目 |
内容 |
| エンドポイント |
/api/master/inputMAreaSokoR/load |
| HTTPメソッド |
POST |
| リクエスト形式 |
application/json |
| レスポンス形式 |
application/json |
3.2 リクエストパラメータ
ヘッダー
| 項目 |
必須 |
説明 |
例 |
Authorization |
必須 |
Bearerトークン |
Bearer eyJhbGciOiJIUzI1NiJ9... |
Content-Type |
必須 |
コンテンツタイプ |
application/json |
X-Requested-With |
必須 |
AJAXリクエスト識別子 |
XMLHttpRequest |
Accept |
推奨 |
レスポンス形式 |
application/json |
ボディ(リクエストJSON)
| フィールド |
型 |
必須 |
最大長 |
説明 |
例 |
soko_c |
string |
必須 |
3 |
倉庫コード |
102 |
soko_area_c |
string |
必須 |
3 |
倉庫エリアコード |
101 |
3.3 リクエスト例
{
"soko_area_c": "101",
"soko_c": "102"
}
3.4 レスポンス
成功時(200 OK)
{
"code": 200,
"msg": "処理が完了しました",
"data": {
"cre_func": "ikou",
"cre_timestamp": "2015-09-28 12:00:28",
"cre_user_id": "tanaka360",
"order_num": 1,
"row_ver": 1,
"soko_area_c": "101",
"soko_area_nm": "東京倉庫",
"soko_c": "102",
"soko_nr": "東京倉庫",
"upd_func": "ikou",
"upd_timestamp": "2015-10-01 08:49:00",
"upd_user_id": "tanaka360"
}
}
レスポンスフィールド
| フィールド |
型 |
説明 |
code |
integer |
ステータスコード(200: 成功) |
msg |
string |
処理結果メッセージ |
data |
object |
レスポンスデータ |
data フィールド詳細
| フィールド |
型 |
説明 |
例 |
data.cre_func |
string |
作成処理 |
ikou |
data.cre_timestamp |
string |
作成日時 |
2015-09-28 12:00:28 |
data.cre_user_id |
string |
作成ユーザID |
tanaka360 |
data.order_num |
integer |
優先順位 |
1 |
data.row_ver |
integer |
行バージョン |
1 |
data.soko_area_c |
string |
倉庫エリアコード |
101 |
data.soko_area_nm |
string |
倉庫エリア名 |
東京倉庫 |
data.soko_c |
string |
倉庫コード |
102 |
data.soko_nr |
string |
倉庫名 |
東京倉庫 |
data.upd_func |
string |
更新処理 |
ikou |
data.upd_timestamp |
string |
|
2015-10-01 08:49:00 |
data.upd_user_id |
string |
更新ユーザID |
tanaka360 |
4. 登録API
4.1 概要
データの挿入
| 項目 |
内容 |
| エンドポイント |
/api/master/inputMAreaSokoR/insert |
| HTTPメソッド |
POST |
| リクエスト形式 |
application/json |
| レスポンス形式 |
application/json |
4.2 リクエストパラメータ
ヘッダー
| 項目 |
必須 |
説明 |
例 |
Authorization |
必須 |
Bearerトークン |
Bearer eyJhbGciOiJIUzI1NiJ9... |
Content-Type |
必須 |
コンテンツタイプ |
application/json |
X-Requested-With |
必須 |
AJAXリクエスト識別子 |
XMLHttpRequest |
Accept |
推奨 |
レスポンス形式 |
application/json |
ボディ(リクエストJSON)
| フィールド |
型 |
必須 |
最大長 |
説明 |
例 |
cre_func |
string |
|
– |
作成処理 |
ikou |
cre_timestamp |
string |
|
– |
作成日時 |
2015-09-28 12:00:28 |
cre_user_id |
string |
|
– |
作成ユーザID |
tanaka360 |
order_num |
integer |
必須 |
– |
優先順位 |
1 |
row_ver |
integer |
必須 |
– |
行バージョン |
1 |
soko_area_c |
string |
必須 |
3 |
倉庫エリアコード |
101 |
soko_area_nm |
string |
|
– |
倉庫エリア名 |
東京倉庫 |
soko_c |
string |
必須 |
3 |
倉庫コード |
102 |
soko_nr |
string |
|
– |
倉庫名 |
東京倉庫 |
upd_func |
string |
|
– |
更新処理 |
ikou |
upd_timestamp |
string |
|
– |
|
2015-10-01 08:49:00 |
upd_user_id |
string |
|
– |
更新ユーザID |
tanaka360 |
4.3 リクエスト例
{
"cre_func": "",
"cre_timestamp": "",
"cre_user_id": "",
"order_num": 1,
"row_ver": 1,
"soko_area_c": "101",
"soko_area_nm": "",
"soko_c": "102",
"soko_nr": "",
"upd_func": "",
"upd_timestamp": "",
"upd_user_id": ""
}
4.4 レスポンス
成功時(200 OK)
{
"code": 200,
"msg": "処理が完了しました",
"data": {
"cre_func": "ikou",
"cre_timestamp": "2015-09-28 12:00:28",
"cre_user_id": null,
"order_num": 1,
"row_ver": 1,
"soko_area_c": "101",
"soko_area_nm": "東京倉庫",
"soko_c": "102",
"soko_nr": "東京倉庫",
"upd_func": "ikou",
"upd_timestamp": "2015-10-01 08:49:00",
"upd_user_id": null
}
}
レスポンスフィールド
| フィールド |
型 |
説明 |
code |
integer |
ステータスコード(200: 成功) |
msg |
string |
処理結果メッセージ |
data |
object |
レスポンスデータ |
data フィールド詳細
| フィールド |
型 |
説明 |
例 |
data.cre_func |
string |
作成処理 |
ikou |
data.cre_timestamp |
string |
作成日時 |
2015-09-28 12:00:28 |
data.cre_user_id |
string |
作成ユーザID |
tanaka360 |
data.order_num |
integer |
優先順位 |
1 |
data.row_ver |
integer |
行バージョン |
1 |
data.soko_area_c |
string |
倉庫エリアコード |
101 |
data.soko_area_nm |
string |
倉庫エリア名 |
東京倉庫 |
data.soko_c |
string |
倉庫コード |
102 |
data.soko_nr |
string |
倉庫名 |
東京倉庫 |
data.upd_func |
string |
更新処理 |
ikou |
data.upd_timestamp |
string |
|
2015-10-01 08:49:00 |
data.upd_user_id |
string |
更新ユーザID |
tanaka360 |
5. 更新API
5.1 概要
データの更新
| 項目 |
内容 |
| エンドポイント |
/api/master/inputMAreaSokoR/update |
| HTTPメソッド |
POST |
| リクエスト形式 |
application/json |
| レスポンス形式 |
application/json |
5.2 リクエストパラメータ
ヘッダー
| 項目 |
必須 |
説明 |
例 |
Authorization |
必須 |
Bearerトークン |
Bearer eyJhbGciOiJIUzI1NiJ9... |
Content-Type |
必須 |
コンテンツタイプ |
application/json |
X-Requested-With |
必須 |
AJAXリクエスト識別子 |
XMLHttpRequest |
Accept |
推奨 |
レスポンス形式 |
application/json |
ボディ(リクエストJSON)
| フィールド |
型 |
必須 |
最大長 |
説明 |
例 |
cre_func |
string |
|
– |
作成処理 |
ikou |
cre_timestamp |
string |
|
– |
作成日時 |
2015-09-28 12:00:28 |
cre_user_id |
string |
|
– |
作成ユーザID |
tanaka360 |
order_num |
integer |
必須 |
– |
優先順位 |
1 |
row_ver |
integer |
必須 |
– |
行バージョン |
1 |
soko_area_c |
string |
必須 |
3 |
倉庫エリアコード |
101 |
soko_area_nm |
string |
|
– |
倉庫エリア名 |
東京倉庫 |
soko_c |
string |
必須 |
3 |
倉庫コード |
102 |
soko_nr |
string |
|
– |
倉庫名 |
東京倉庫 |
upd_func |
string |
|
– |
更新処理 |
ikou |
upd_timestamp |
string |
|
– |
|
2015-10-01 08:49:00 |
upd_user_id |
string |
|
– |
更新ユーザID |
tanaka360 |
5.3 リクエスト例
{
"cre_func": "",
"cre_timestamp": "",
"cre_user_id": "",
"order_num": 1,
"row_ver": 1,
"soko_area_c": "101",
"soko_area_nm": "",
"soko_c": "102",
"soko_nr": "",
"upd_func": "",
"upd_timestamp": "",
"upd_user_id": ""
}
5.4 レスポンス
成功時(200 OK)
{
"code": 200,
"msg": "処理が完了しました",
"data": {
"cre_func": "ikou",
"cre_timestamp": "2015-09-28 12:00:28",
"cre_user_id": "tanaka360",
"order_num": 1,
"row_ver": 2,
"soko_area_c": "101",
"soko_area_nm": "東京倉庫",
"soko_c": "102",
"soko_nr": "東京倉庫",
"upd_func": "ikou",
"upd_timestamp": "2015-10-01 08:49:00",
"upd_user_id": "tanaka360"
}
}
レスポンスフィールド
| フィールド |
型 |
説明 |
code |
integer |
ステータスコード(200: 成功) |
msg |
string |
処理結果メッセージ |
data |
object |
レスポンスデータ |
data フィールド詳細
| フィールド |
型 |
説明 |
例 |
data.cre_func |
string |
作成処理 |
ikou |
data.cre_timestamp |
string |
作成日時 |
2015-09-28 12:00:28 |
data.cre_user_id |
string |
作成ユーザID |
tanaka360 |
data.order_num |
integer |
優先順位 |
1 |
data.row_ver |
integer |
行バージョン |
1 |
data.soko_area_c |
string |
倉庫エリアコード |
101 |
data.soko_area_nm |
string |
倉庫エリア名 |
東京倉庫 |
data.soko_c |
string |
倉庫コード |
102 |
data.soko_nr |
string |
倉庫名 |
東京倉庫 |
data.upd_func |
string |
更新処理 |
ikou |
data.upd_timestamp |
string |
|
2015-10-01 08:49:00 |
data.upd_user_id |
string |
更新ユーザID |
tanaka360 |
6. 削除API
6.1 概要
データの削除
| 項目 |
内容 |
| エンドポイント |
/api/master/inputMAreaSokoR/delete |
| HTTPメソッド |
POST |
| リクエスト形式 |
application/json |
| レスポンス形式 |
application/json |
6.2 リクエストパラメータ
ヘッダー
| 項目 |
必須 |
説明 |
例 |
Authorization |
必須 |
Bearerトークン |
Bearer eyJhbGciOiJIUzI1NiJ9... |
Content-Type |
必須 |
コンテンツタイプ |
application/json |
X-Requested-With |
必須 |
AJAXリクエスト識別子 |
XMLHttpRequest |
Accept |
推奨 |
レスポンス形式 |
application/json |
ボディ(リクエストJSON)
| フィールド |
型 |
必須 |
最大長 |
説明 |
例 |
row_ver |
integer |
必須 |
– |
行バージョン |
1 |
soko_c |
string |
必須 |
3 |
倉庫コード |
102 |
soko_area_c |
string |
必須 |
3 |
倉庫エリアコード |
101 |
6.3 リクエスト例
{
"soko_area_c": "101",
"soko_c": "102",
"row_ver": 1
}
6.4 レスポンス
成功時(200 OK)
{
"code": 200,
"msg": "削除しました。"
}
レスポンスフィールド
| フィールド |
型 |
説明 |
code |
integer |
ステータスコード(200: 成功) |
msg |
string |
処理結果メッセージ |
7. 改訂履歴
| 日付 |
バージョン |
変更内容 |
作成者 |
| 2026/05/27 |
1.0.0 |
初版作成 |
API生成システム |