GET /v2/charter/warranty

Charter: List Warranties

این اندپوینت برای بازیابی لیستی کامل از تمام گارانتی‌های مرتبط با یک چارتر مشخص (main_id) استفاده می‌شود. به ازای هر گارانتی، اطلاعات تکمیلی شامل جزئیات گارانتی‌کننده (همکار) و لیست اتاق‌های اختصاص‌داده‌شده (برای چارترهای اقامتگاهی) نیز بازگردانده می‌شود. این اندپوینت از یک مکانیزم کش (Caching) با استفاده از Redis برای بهینه‌سازی و افزایش سرعت دریافت اطلاعات همکاران بهره می‌برد.

Request Overview

Access Control

Request Parameters (Query String)

این اندپوینت اطلاعات مورد نیاز خود را از طریق Query String دریافت می‌کند.

Example Request

GET /v2/charter/warranty?id=451

Logic Details

فرآیند پردازش درخواست به شرح زیر است:

Response Structure

پاسخ موفق (Success)

در صورت موفقیت، پاسخ 200 OK به همراه یک ساختار JSON استاندارد حاوی لیست گارانتی‌ها بازگردانده می‌شود.

{
  "status": true,
  "time": 1733271000, // Unix Timestamp
  "data": [
    {
      "id": 99,
      "item_id": 102, // شناسه آیتم (مثلا نوع اتاق)
      "guarantor": { // اطلاعات کامل همکار از کش یا دیتابیس
        "id": 25,
        "title_fa": "آژانس مسافرتی بهار",
        "title_en": "Bahar Agency",
        "first_name": "علی",
        "last_name": "رضایی",
        "credit_amount": 50000000,
        "status": 1
      },
      "warranty": {
        "adult": {
          "number": 2,
          "price": 2500000
        },
        "child": {
          "number": 1,
          "price": 1800000
        },
        "infant": {
          "number": 0,
          "price": 0
        }
      },
      "room_id": [ // لیست اتاق های این گارانتی
        {
          "id": 210,
          "warranty_id": 99,
          "room_id": 305
        },
        {
          "id": 211,
          "warranty_id": 99,
          "room_id": 306
        }
      ],
      "sank_cost": 0,
      "service_price": 150000,
      "start_date": "2025-12-10",
      "end_date": "2025-12-15",
      "status": 1
    },
    {
      "id": 88,
      "item_id": 101, // شناسه آیتم (مثلا کلاس پروازی)
      "guarantor": { ... },
      "warranty": { ... },
      "room_id": false, // این گارانتی اقامتگاهی نیست یا اتاقی ندارد
      "sank_cost": 500000,
      "service_price": 0,
      "start_date": null,
      "end_date": null,
      "status": 1
    }
  ]
}

پاسخ خطا (Error)

در صورت بروز هرگونه استثناء (Exception) در سرور، یک پاسخ با ساختار زیر و کد وضعیت (معمولا 200 OK به دلیل مدیریت خطا در کد) بازگردانده می‌شود.
توجه: نمایش trace خطا در محیط پروداکشن توصیه نمی‌شود.

{
    "status": false,
    "time": 1733271000,
    "message": "Error message from the exception.",
    "trace": [ ... ] // Stack trace of the error
}