準備機関 - 詳細取得 API

概要

{primary} ルートパラメータのIDに紐づくレコードを返却します。

エンドポイント

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

ROUTEパラメータ

パラメーター名 型 内容 特記
id int 請求書ID

レスポンス

成功時
パラメーター名 型 内容 特記
result boolean リクエスト結果 true
errors array 成功のためエラーがないので空配列が返ってきます
id int id
country int 送出国
preparation_agency_type int 種別
name string 機関名称
address string 所在地
representative_name string 代表者氏名
main_business string 主要業務
phone string 電話番号
email string メールアドレス
founding_date date 設立年月日
numof_employee int 常勤職員数
capital_amount int 資本金（金額）
capital_unit int 資本金（単位）
capital_rate string 資本金（レート）
capital_amount_yen int 資本金（日本円）
supervisor_rank string 責任者役職
supervisor_name string 責任者氏名 
{
    "result"   : true,
    "errors"   : "",
    "data"     : {
        "id"                      : 1,
        "country"                 : 1,
        "preparation_agency_type" : 1,
        "name"                    : "ミャンマー送出機関",
        "address"                 : "東京都千代田区東神田2-7-9",
        "representative_name"     : "",
        "main_business"           : "",
        "phone"                   : "090-1234-5678",
        "email"                   : "text@gmail.com",
        "founding_date"           : "2023/01/01",
        "numof_employee"          : "500",
        "capital_amount"          : "100000",
        "capital_unit"            : 1,
        "capital_rate"            : "100",
        "capital_amount_yen"      : "100000",
        "supervisor_rank"         : "代表取締役",
        "supervisor_name"         : "山田太郎",
        }
    },
}
失敗時

ステータスコード：200

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

{primary} 何もなければ空配列で返却。検索条件で何も引っかからなかった場合を

想定しています。取得するデータが存在しないため

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

エラー件数は上限100件までとします。

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

データ取得

  • 実際はfindで取得します。
SELECT
    *
FROM
    `organization_bills`
WHERE
        `id` = $request->getInput('id')
    AND `organization_bills`.`deleted_at` IS NULL