会員情報取得＿API

概要

KIZUNAを利用している監理団体の詳細取得APIです。

エンドポイント

メソッド URI Headers
GET /api/organization/{verified}/{id} Default

リクエストパラメーター

パラメーター名 型 内容 特記
verified tinyint 認証済フラグ 0:未認証 1:認証済
id int 監理団体ID 
/api/organization/1/1

レスポンス

パラメーター名 型 内容 テーブル名 特記
id int id organizations or
application_informations
trainee_count int 技能実習生人数 ー tableにないのでカウント
plan int プラン人数 organization_payment_settings
client_count int 実習実施先数 ー tableにないのでカウント
corporate_number int 法人番号 organizations or
application_informations
code string 監理団体CODE organizations or
application_informations
name string 監理団体名 organizations or
application_informations
kana string 監理団体名（ふり） organizations or
application_informations
romaji string 監理団体名（roma） organizations or
application_informations
representative_sei string 代表者：姓 organizations or
application_informations
representative_mei string 代表者：名 organizations or
application_informations
representative_kana_sei string 代表者：姓（ふり） organizations or
application_informations
representative_kana_mei string 代表者：名（ふり） organizations or
application_informations
representative_family_name string 代表者：姓（roma） organizations or
application_informations
representative_first_name string 代表者：名（roma） organizations or
application_informations
insurance_office_number int 雇用保険適用事業所番号 organizations or
application_informations
zip1 int 郵便番号　郵便区番号 organizations or
application_informations
zip2 int 郵便番号　町域番号 organizations or
application_informations
address string 所在地 organizations or
application_informations
address_kana string 所在地　ふりがな organizations or
application_informations
address_romaji string 所在地　ローマ字 organizations or
application_informations
phone1 int TEL　市外局番 organizations or
application_informations
phone2 int TEL　市内局番 organizations or
application_informations
phone3 int TEL　加入者番号 organizations or
application_informations
registration_number string 許可番号 organizations or
application_informations
license_type int 許可の別 organizations or
application_informations
email string メールアドレス organizations or
application_informations
status int ステータス organizations
cancelled_date date 解約予定日 organizations
cmps_remarks string 備考 organizations
payment_method int 支払方法 organizations or
application_informations
basic_charge_unit_price int 基本料金単価 organization_payment_settings
pay_per_use_price int 従量課金単価 organization_payment_settings 
{
  "result"   : true,
  "errors"   : "",
  "data"     : {
    'id'                        : 1,
    'trainee_count'             : 10,
    'payment_plan'              : 15,
    'client_count'              : 20,
    'corporate_number'          : 1234567890123,
    'code'                      : 'devel',
    'name'                      : 'テスト監理団体',
    'kana'                      : 'てすとかんりだんたい',
    'romaji'                    : 'tesutokanridantai',
    'representative_sei'        : '代表者氏',
    'representative_mei'        :　'代表者名',
    'representative_kana_sei'   : 'だいひょうしゃし',
    'representative_kana_mei'   :'　だいひょうしゃめい',
    'representative_family_name': 'daihyousyasi',
    'representative_first_name' :'daihyousyamei',
    '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',
    'status'                    : 1,　// 1：未認証　5：認証済み　10：停止中　15：解約
    'cancelled_date'            : '2021/07/08',
    'cmps_remarks'              : '不必要になった。',
    'payment_method'            : 1,　//KIZUNAの支払方法　1：クレジット　5：コンビニ払い
    'basic_charge_unit_price'   : 50000,
    'pay_per_use_price'         : 1000,
  },
}

{primary} 何もなければ空配列で返却

{danger} 失敗時は200以外のエラーコードが返却されます。共通ルールのレスポンスをチェック。

データ取得

パラメータのvarifiedが、0:未認証の場合

  • 監理団体organizationsレコードが作成されていない状態のため、KIZUNA申込情報より値を取得します。
SELECT
    *
FROM
    `application_informations`
WHERE
    `application_informations`.`id` = $this->route('id')
AND `application_informations`.`deleted_at` IS NULL

パラメータのvarifiedが、1:認証済の場合

  • 監理団体organizationsより対象のレコードを取得します。
SELECT
    *
FROM
    `organizations`
WHERE
    `organizations`.`id` = $this->route('id')
AND `organizations`.`deleted_at` IS NULL
  • 認証済の場合、支払設定データ、所属実習生数、所属実施先数も取得します。
-- 支払設定データ取得
SELECT
    *
FROM
    `organization_payment_settings`
WHERE
    `organization_payment_settings`.`organization_id` = $this->route('id')
AND `organization_payment_settings`.`deleted_at` IS NULL
-- 所属実習生数取得
SELECT
    count(*)
FROM
    `trainees`
WHERE
    `trainees`.`organization_id` = $this->route('id')
AND `trainees`.`deleted_at` IS NULL
-- 所属実施先数取得
SELECT
    count(*)
FROM
    `clients`
WHERE
    `clients`.`organization_id` = $this->route('id')
AND `clients`.`deleted_at` IS NULL

RUN