پرش به مطلب اصلی

Get submit schema

GET 
/v1/open-platform/assets/submit-schema/:category_slug

این API به شما امکان دریافت قالب ثبت آگهی برای یک دسته‌بندی مشخص را می‌دهد. پاسخ در قالب JSON Schema است.

قالب تعریف کننده ساختار و قوانین برای فیلدهای فرم زمانی که آگهی در یک دسته‌بندی مشخص ثبت می‌شود. هر فیلد در قالب می‌تواند یکی از انواع زیر را داشته باشد:

انواع اصلی:

  • string: فیلدهای ورودی متنی (مانند عنوان، توضیحات، مقادیر زمانی)
  • integer: فیلدهای ورودی عددی برای اعداد صحیح (مانند قیمت، تعداد، اندازه)
  • float: فیلدهای ورودی عددی برای اعداد اعشاری
  • boolean: فیلدهای ورودی بولین (صحیح/غلط)
  • array: فیلدهای ورودی چندگانه که امکان انتخاب چند مقدار را دارند

فیلدهای Enum: فیلدها با گزینه‌های پیش‌تعریف شده از enum و enumNames استفاده می‌کنند:

  • enum: آرایه از مقادیر داخلی استفاده شده برای ارتباط API
  • enumNames: آرایه از برچسب‌های نمایشی نشان داده شده به کاربر (معمولاً به زبان فارسی)
  • اینها برای فیلدهای ورودی چندگانه (مانند انتخاب طبقه، امکان استفاده از پارکینگ) استفاده می‌شوند

فیلدهای آرایه با Enum: فیلدهای ورودی چندگانه ترکیب type: "array" با کلید Enum را دارند:

  • items.enum: گزینه‌های موجود برای انتخاب
  • items.enumNames: برچسب‌های نمایشی برای هر گزینه
  • کاربران می‌توانند چند مقدار را انتخاب کنند (مانند امکانات رفاهی، سیستم‌های گرمایش)

ویژگی‌های فیلد:

  • title: نام نمایشی فارسی برای فیلد
  • required: آرایه از نام فیلدهای اجباری که باید ارائه شوند
  • type: نوع داده فیلد

مثال استفاده:

{
  "properties": {
    "size": {
      "title": "متراژ (متر مربع)",
      "type": "integer"
    },
    "elevator": {
      "enum": ["دارد", "ندارد"],
      "enumNames": ["دارد", "ندارد"],
      "title": "آسانسور",
      "type": "string"
    },
    "comfort_amenities": {
      "items": {
        "enum": ["اینترنت_پرسرعت", "تلویزیون"],
        "enumNames": ["اینترنت پرسرعت", "تلویزیون"],
        "type": "string"
      },
      "title": "امکانات رفاهی",
      "type": "array"
    }
  }
}

Request​

Responses​

پاسخ موفقیت‌آمیز.