準備機関 - 一覧 API

概要

{primary} 検索条件にて絞り込んだ監理費請求のレコードのリストを返却します。

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

エンドポイント

メソッド URI Headers
GET /api/application/preparation_agency/list Default

リクエストパラメータ

パラメーター名 型 内容 特記
per_page int 件数 default:50
pages int ページ数 何 P 目をリクエストするか
keyword int 準備機関名のキーワード検索 半角スペース区切りのLIKEOR検索
country int 国籍 NULLの場合全て

レスポンス

成功時
パラメーター名 型 内容 特記
result boolean リクエスト結果 true
errors array 成功のためエラーがないので空配列が返ってきます
id string 準備機関ID
company int 送出国
name string 名称
address string 所在地
agency_type int 種別
updated_at string 最終更新日
progress string 進捗率 
{
    "result"   : true,
    "errors"   : "",
    "data"     : {
        0 : {
            "id"              : 1,
            "company"         : 1,
            "name"            : "ミャンマー準備機関",
            "address"         : "東京都千代田区東神田2-7-9",
            "agency_type"     : 1,
            "updated_at"      : "2023/02/01 12:00",
            "progress"        : 60,
        }
    },
}
失敗時

ステータスコード：200

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

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

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

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

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

データ取得

  • キーワード検索のsearchは、半角スペース区切り$request->getInput('search')を分解し、$search1,2,3...とします。
SELECT
    *
FROM
    `organization_bills`
WHERE
        `organization_id` = Auth::organizationId()
    AND `company_id` = $request->getInput('company_id')
    AND `billing_ym` = $request->getInput('billing_ym')
    AND `organization_bills`.`deleted_at` IS NULL
    AND (
            `subject` = $search1
        OR  `subject` = $search2
        OR  `subject` = $search3 .....
    )