会員登録＿API
概要
KIZUNAを利用している監理団体の新規作成・編集を行うAPIです。
エンドポイント
| メソッド |
URI |
Headers |
| POST |
/api/organization |
Default |
リクエストパラメーター
| パラメーター名 |
型 |
内容 |
特記 |
| id |
int |
id |
(※) 新規作成時は不要。更新時のみ必要。 |
| verified |
int |
認証済フラグ |
0：未認証、1：認証済 |
| corporate_number |
int |
法人番号 |
|
| name |
string |
監理団体名 |
|
| kana |
string |
監理団体名 ふりがな |
(※)新規作成時はこの項目は存在しない。更新時は任意。 |
| romaji |
string |
監理団体名 ローマ字 |
(※)新規作成時はこの項目は存在しない。更新時は任意。 |
| representative_sei |
string |
代表者：姓 |
|
| representative_mei |
string |
代表者：名 |
|
| representative_kana_sei |
string |
代表者：姓 ふりがな |
(※)新規作成時はこの項目は存在しない。更新時は任意。 |
| representative_kana_mei |
string |
代表者：名 ふりがな |
(※)新規作成時はこの項目は存在しない。更新時は任意。 |
| representative_family_name |
string |
代表者：姓 ローマ字 |
(※)新規作成時はこの項目は存在しない。更新時は任意。 |
| representative_first_name |
string |
代表者：名 ローマ字 |
(※)新規作成時はこの項目は存在しない。更新時は任意。 |
| representative_rank |
int |
代表者役職 |
|
| insurance_office_number |
int |
雇用保険適用事業所番号 |
|
| zip1 |
int |
郵便番号 郵便区番号 |
|
| zip2 |
int |
郵便番号 町域番号 |
|
| address |
string |
所在地 |
|
| address_kana |
string |
所在地 ふりがな |
(※)新規作成時はこの項目は存在しない。更新時は任意。 |
| address_romaji |
string |
所在地 ローマ字 |
(※)新規作成時はこの項目は存在しない。更新時は任意。 |
| phone1 |
int |
TEL 市外局番 |
|
| phone2 |
int |
TEL 市内局番 |
|
| phone3 |
int |
TEL 加入者番号 |
|
| registration_number |
string |
許可番号 |
|
| license_type |
int |
許可の別 |
|
| email |
string |
メールアドレス |
|
| code |
int |
販売代理店CODE |
(※)任意 |
| cmps_account_id |
int |
担当者ID |
(※)任意 |
| cancelled_date |
date |
解約予定日 |
(※)新規作成時はこの項目は存在しない。 |
| cmps_remarks |
string |
備考 |
(※)新規作成時はこの項目は存在しない。 |
| basic_charge_unit_price |
int |
基本料金単価 |
(※)申込入力フォームから遷移してきた場合この項目は存在しない |
| pay_per_use_price |
int |
従量課金単価 |
(※)申込入力フォームから遷移してきた場合この項目は存在しない |
{
'id' : 1
'verified' : 1
'corporate_number' : 1234567890123,
'name' : 'テスト監理団体',
'kana' : 'てすとかんりだんたい',
'romaji' : 'tesutokanridantai',
'representative_sei' : '代表者氏',
'representative_mei' : '代表者名',
'representative_kana_sei' : '代表者：姓 ふりがな',
'representative_kana_mei' : '代表者：名 ふりがな',
'representative_family_name' : '代表者：姓 ローマ字',
'representative_first_name' : '代表者：名 ローマ字',
'representative_rank' : '代表者役職',
'insurance_office_number' : 12345678,
'zip1' : 000,
'zip2' : 0000,
'address' : '東京都台東区台東',
'address_kana' : 'とうきょうとたいとうくたいとう',
'address_romaji' : 'tokyoutotaitoukutaitou',
'phone1' : 00,
'phone2' : 0000,
'phone3' : 0000,
'registration_number' : '123456789012345',
'license_type' : 1,
'email' : 'admin@gmail.com',
'code' : '12345678',
'cmps_account_id' : 1,
'cancelled_date' : '2021/07/08',
'cmps_remarks' : '不必要になった。',
'basic_charge_unit_price' : 50000,
'pay_per_use_price' : 1000,
}
※ 代理店CODEがない（削除されている）場合があるので、注意
レスポンス
成功時
| パラメーター名 |
型 |
内容 |
特記 |
| id |
int |
id |
|
{
"result" : true,
"errors" : "",
"data" : {
'id': 1,
},
}
{primary} 成功時、登録のあるメールアドレスへ認証メールを送付します。詳細は本ページ下部を参照ください。
失敗時
ステータスコード：200
| パラメーター名 |
型 |
内容 |
特記 |
| result |
boolean |
リクエスト結果 |
|
| 'corporate_number' |
string |
notnull / int / ～13 |
|
| 'name' |
string |
notnull / string |
|
| 'representative_sei' |
string |
notnull |
|
| 'representative_mei' |
string |
notnull |
|
| representative_kana_sei |
string |
nullable / ～50 |
|
| representative_kana_mei |
string |
nullable / ～50 |
|
| representative_family_name |
string |
nullable / ～50 |
|
| representative_first_name |
string |
nullable / ～50 |
|
| representative_rank |
int |
notnull / int / ～1 |
|
| 'insurance_office_number' |
string |
notnull / int / ～11 |
|
| 'zip1' |
string |
notnull |
|
| 'zip2' |
string |
notnull |
|
| 'address' |
string |
notnull |
|
| 'address_kana' |
string |
notnull |
|
| 'address_romaji' |
string |
notnull |
|
| 'phone1' |
string |
notnull |
|
| 'phone2' |
string |
notnull |
|
| 'phone3' |
string |
notnull |
|
| 'registration_number' |
string |
notnull |
|
| 'license_type' |
string |
notnull |
|
| 'email' |
string |
notnull / メール |
|
| 'sales_agent_id' |
int |
nullable / int |
|
| 'cmps_account_id' |
int |
nullable / int |
|
| 'cancelled_date' |
date |
date |
解約申込日を保存/その日付の末日に解約へ |
| 'cmps_remarks' |
string |
string |
CMPS用管理のための備考欄 |
| 'basic_charge_unit_price' |
string |
notnull / int / 6桁まで |
|
| 'pay_per_use_price' |
string |
notnull / int / 6桁まで |
|
{
"result" : false,
"errors" : {
'corporate_number' : '必須項目です。|13桁以下で入力してください。',
'name' : '必須項目です。',
'representative_sei' : '必須項目です。',
'representative_mei' : '必須項目です。',
'representative_kana_sei' : '50文字以下で入力してください。',
'representative_kana_mei' : '50文字以下で入力してください。',
'representative_family_name' : '50文字以下で入力してください。',
'representative_first_name' : '50文字以下で入力してください。',
'representative_rank' : '必須項目です。|数値で入力してください。|1桁以下で入力してください。',
'insurance_office_number' : '必須項目です。|11桁以下で入力してください。',
'zip1' : '必須項目です。',
'zip2' : '必須項目です。',
'address' : '必須項目です。',
'address_kana' : '',
'address_romaji' : '',
'phone1' : '必須項目です。',
'phone2' : '必須項目です。',
'phone3' : '必須項目です。',
'registration_number' : '必須項目です。',
'license_type' : '必須項目です。',
'email' : '必須項目です。|メールアドレスで入力してください',
'sales_agent_id' : '数値で入力してください',
'cmps_account_id' : '数値で入力してください',
'cancelled_date' : '日付で入力してください',
'basic_charge_unit_price' : '必須項目です。|数値で入力してください|6桁以下で入力してください',
'pay_per_use_price' : '必須項目です。|数値で入力してください|6桁以下で入力してください',
},
"data" : "",
}
バリデーション
| 画面項目名 |
フィールド名 |
チェック内容 |
備考 |
| 法人番号 |
corporate_number |
required |
|
|
|
max:13 |
|
| 監理団体名 |
name |
required |
|
|
|
string |
|
|
|
max:100 |
|
| 代表者氏名 姓 |
representative_sei |
required |
|
|
|
string |
|
|
|
max:50 |
|
| 代表者氏名 名 |
representative_mei |
required |
|
|
|
max:50 |
|
| 代表者氏名 姓 ふりがな |
representative_kana_sei |
string |
|
|
|
max:50 |
|
| 代表者氏名 名 ふりがな |
representative_kana_mei |
string |
|
|
|
max:50 |
|
| 代表者氏名 姓 ローマ字 |
representative_family_name |
string |
|
|
|
max:50 |
|
| 代表者氏名 名 ローマ字 |
representative_first_name |
string |
|
|
|
max:50 |
|
| 代表者役職 |
representative_rank |
required |
|
|
|
integer |
|
|
|
digits:1 |
|
| 郵便番号 郵便区番号 |
zip1 |
required |
|
|
|
digits:3 |
|
| 郵便番号 町域番号 |
zip2 |
required |
|
|
|
digits:4 |
|
| 所在地 |
address |
required |
|
|
|
max:255 |
|
| 所在地 ふりがな |
address_kana |
string |
|
|
|
max:255 |
|
| 所在地 ローマ字 |
address_romaji |
string |
|
|
|
max:255 |
|
| TEL 市外局番 |
phone1 |
required |
|
|
|
max:5 |
|
| TEL 市内局番 |
phone2 |
required |
|
|
|
max:4 |
|
| TEL 加入者番号 |
phone3 |
required |
|
|
|
max:4 |
|
| 許可番号 |
registration_number |
required |
|
|
|
digits:15 |
|
| 許可の別 |
license_type |
required |
|
| メールアドレス |
email |
required |
|
|
|
email |
|
|
|
max:255 |
|
| 販売代理店ID |
sales_agent_id |
int |
|
| 担当者ID |
cmps_account_id |
int |
|
| 基本料金単価 |
basic_charge_unit_price |
required |
|
|
|
digits_between:1,6 |
|
| 従量課金単価 |
pay_per_use_price |
required |
|
|
|
digits_between:1,6 |
|
データストア
application_informations, organizations
| 物理名 |
フィールド名 |
型 |
備考 |
| 法人番号 |
corporate_number |
char |
|
| 監理団体名 |
name |
varchar |
|
| 代表者氏名 姓 |
representative_sei |
varchar |
|
| 代表者氏名 名 |
representative_mei |
varchar |
|
| 代表者氏名 姓 ふりがな |
representative_kana_sei |
varchar |
|
| 代表者氏名 名 ふりがな |
representative_kana_mei |
varchar |
|
| 代表者氏名 姓 ローマ字 |
representative_family_name |
varchar |
|
| 代表者氏名 名 ローマ字 |
representative_first_name |
varchar |
|
| 代表者役職 |
representative_rank |
tinyint |
|
| 郵便番号 郵便区番号 |
zip1 |
char |
|
| 郵便番号 町域番号 |
zip2 |
char |
|
| 所在地 |
address |
varchar |
|
| 所在地 ふりがな |
address_kana |
varchar |
|
| 所在地 ローマ字 |
address_romaji |
varchar |
|
| TEL 市外局番 |
phone1 |
varchar |
|
| TEL 市内局番 |
phone2 |
varchar |
|
| TEL 加入者番号 |
phone3 |
varchar |
|
| 許可番号 |
registration_number |
varchar |
|
| 許可の別 |
license_type |
tinyint |
|
| メールアドレス |
email |
varchar |
|
| 販売代理店ID |
sales_agent_id |
int |
|
| 担当者ID |
cmps_account_id |
int |
|
organization_payment_settings
| 物理名 |
フィールド名 |
型 |
備考 |
| 基本料金単価 |
basic_charge_unit_price |
int |
|
| 従量課金単価 |
pay_per_use_price |
int |
|
成功後の処理
{danger} 新規作成～請求フロー をチェック
RUN