グループを作成する
Description
入力情報をもとにグループ情報の登録を行います。
Method
POST
共通リクエストヘッダーを参照してください。
Argument
なし
URI
Parameters in request body
共通仕様はこちらを参照してください。
下記の例には一部項目を記載しています。全項目の詳細は表を参照してください。
Example
{
"entry_id":"O00000000000003",
"group_name":"○○グループ",
"free_item":{
"free1":"AAA",
"free2":"BBB",
"free3":"CCC"
},
"free_item1":"AAA",
"free_item2":"BBB",
"free_item3":"CCC",
"free_item4":"DDD",
"free_item5":"EEE",
"free_item6":"FFF",
"free_item7":"GGG",
"free_item8":"HHH",
"free_item9":"III",
"free_item10":"JJJ"
}
Parameters
Name |
Type |
Required |
Length
(Long /Decimalの場合はValue) |
Description |
entry_id |
String |
Yes |
1 ~ 15 |
登録者ID
登録の処理を行ったユーザーのID |
group_name |
String |
|
1 ~ 40 |
グループ名 |
free_item |
String |
|
1 ~ 30000 |
フリー項目 |
free_item1 |
String |
|
1 ~ 1000 |
フリー項目1 |
free_item2 |
String |
|
1 ~ 1000 |
フリー項目2 |
free_item3 |
String |
|
1 ~ 1000 |
フリー項目3 |
free_item4 |
String |
|
1 ~ 1000 |
フリー項目4 |
free_item5 |
String |
|
1 ~ 1000 |
フリー項目5 |
free_item6 |
String |
|
1 ~ 1000 |
フリー項目6 |
free_item7 |
String |
|
1 ~ 1000 |
フリー項目7 |
free_item8 |
String |
|
1 ~ 1000 |
フリー項目8 |
free_item9 |
String |
|
1 ~ 1000 |
フリー項目9 |
free_item10 |
String |
|
1 ~ 1000 |
フリー項目10 |
Return Codes
Code |
Description |
200 |
レスポンスが正常の場合は処理成功。レスポンスが異常の場合は入力パラメータエラー。 |
401 |
認証エラー。API認証時のエラー。 |
403 |
アクセス不可。 |
404 |
対象なし。対象の情報が見つからない場合。 |
500 |
業務不整合。整合性チェックエラー、またはその他のサーバー側のエラー。 |
なし
Response Parameter
共通仕様はこちらを参照してください。
Example
{
"group_id":"00000001",
"version_info":1,
"result_information":{
"result":"OK"
}
Parameters
Name |
Type |
Required |
Length
(Long /Decimalの場合はValue) |
Description |
group_id |
String |
|
8 |
グループID
グループを一意に識別するID |
version_info |
Long |
|
1 ~ 999999999 |
バージョン情報
共通仕様はこちらを参照 |
result_information |
list |
|
Single |
結果情報 |
|
result |
String |
|
2 |
結果
OKまたはNGを返却 |
detailed_result |
String |
|
1 ~ 256 |
結果詳細
NGの場合、エラー内容を返却 |
Top