تعریف کلاس

این درخواست جهت ایجاد یک کلاس ( اطاق یا meet یا room) جدید کاربرد دارد

Content-type: application/json

آدرس درخواستها : api/

در این برنامه کاربر به دوع نوع دسته بندی میشوند . نوع اول کاربر معمولی است که دسترسی محدود دارد و نوع دوم کاربر مدیر که دسترسی کامل دارد.

پارامترهای درخواست ایجاد کلاس

            |

پارامتر	نوع	ضروری	توضیحات
Secret	string	No	به شکل پیشفرض نیاز نیست
Type	string	Yes	باید برابر "CreateMeet" باشد
Data	Json	Yes
Data.Title	string	Yes	عنوان کلاس
Data.UserNeedPass	bool	Yes	برای کاربر معمولی
Data.UserPass	string	No
Data.AdminNeedPass	bool	Yes	برای کاربر مدیر
Data.AdminPass	string	No
Data.UserCount	int	Yes	ظرقیت کلاس

در صورتی که مقدار UserNeedPass برابر false باشد کاربر معمولی بدون وارد کردن پسورد میتواند وارد کلاس شود .

در صورتی که مقدار UserNeedPass برابر true باشد کاربر معمولی جهت ورود به کلاس نیاز به پسورد دارد

مثال

{
  Secret: "",
  Type: "CreateMeet",
  Data: {
    UserPass: "",
    UserNeedPass: false,
    AdminNeedPass: true,
    AdminPass: "password",
    Title: "my room",
    UserCount: 100
  }
}

پاسخ ارسالی از سمت سرور

پارامتر	نوع	مقدار	توضیحات
Status	string	"ok"	در صورت صحت اطلاعات مقدار ok برگشت داده میشد
Message	string
ID	int	id کلاس

مثال پاسخ سرور

{
  "Status": "ok",
  "ID": 21,
  "Url": "/room/21",
  "Title": "my room",
  "Message": ""
}