結果 - 一覧 API

概要

{primary} 本申請で新たに得た情報を保存し、当時の情報として保存し続けます。

監理団体のユーザのみ利用できます。

エンドポイント

メソッド URI Headers
GET /api/application/result/list/{id} Default

リクエストパラメータ

パラメーター名 型 内容 特記
per_page int 件数 default:50
pages int ページ数 何 P 目をリクエストするか

レスポンス

成功時
パラメーター名 型 内容 特記
result boolean リクエスト結果 true
errors array 成功のためエラーがないので空配列が返ってきます
id int 結果ID
appdoc_project_id int 計画認定ID
company_id int 実習実施先ID
trainee_id int 技能実習生ID
romaji string 技能実習生の名前
nationality tinyInteger 技能実習生の国籍
age int 技能実習生の年齢
target_trainee_class int 技能実習生の区分 1:第1号, 2:第2号, 3:第3号
intern_period_from date 実習期間　開始
intern_period_until date 実習期間　終了
certification_number char 認定番号
passport_number string パスポート番号
passport_expiration_date date パスポート有効期限
residence_card_number string 在留カード番号
residence_term date 在留期限
entry_date date 入国日 
{
    "result"   : true,
    "errors"   : "",
    "data"     : {
        0 : {
          'result'                   : true,
          'errors'                   : [],
          'id'                       : 1,
          'appdoc_project_id'        : 1,
          'company_id'               : 1,
          'trainee_id'               : 1,
          'romaji'                   : '実習生名',
          'nationality'              : '日本',
          'age'                      : 25,
          'target_trainee_class'     : 1,
          'intern_period_from'       : '2023/02/01',
          'intern_period_until'      : '2023/02/05',
          'certification_number'     : '1234567890123',
          'passport_number'          : '0123456789'
          'passport_expiration_date' : '2027/05/07',
          'residence_card_number'    : '057057057507',
          'residence_term'           : '2027/05/08',
          'entry_date'               : '2023/01/01'
        }
    },
}
失敗時

ステータスコード：200

パラメーター名 型 内容 特記
result boolean リクエスト結果
error List 失敗した理由を配列 
{
  "result"   : false,
  "errors"   : {
    'error'       : ['失敗しました'],
  },
  "data"     : "",
}

{primary} 何もなければ空配列で返却。取得するデータが存在しないため

失敗ではなく、成功として返却します。

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