مستندات وب‌سرویس و API

ورود به سامانه

وب سرویس سرفصل های دوره

آخرین به روز رسانی: 14 بهمن 1400

متد Create

از این متد جهت ایجاد و افزودن سرفصل به دوره آموزشی استفاده فرمایید

آدرس متد

Method Urlhttps://stream.yoursite.xyz/api/v1/Group/Create

پارامتر های ورودی

نام پارامتر نوع پارامتر ضروری توضیحات
customerId String بله شماره مشتری
title String بله عنوان سرفصل
parentId String بله کد دوره آموزشی

مقدار بازگشتی

مقدار بازگشتی در response همان کد سرفصل افزوده شده می باشد

                                            
    {   
        "success" : true,
        "response" : "20026",
        "error": ""
    }

متد Update

از این متد جهت ویرایش و اصلاح سرفصل استفاده فرمایید

آدرس متد

Method Urlhttps://stream.yoursite.xyz/api/v1/Group/Update

پارامتر های ورودی

نام پارامتر نوع پارامتر ضروری توضیحات
groupId String بله کد سرفصل
title String بله عنوان سرفصل

مقدار بازگشتی

مقدار بازگشتی در response همان کد سرفصل اصلاح شده می باشد

                                            
    {   
        "success" : true,
        "response" : "20026",
        "error": ""
    }

متد Delete

از این متد جهت حذف سرفصل استفاده فرمایید

آدرس متد

Method Urlhttps://stream.yoursite.xyz/api/v1/Group/Delete/{id}

پارامتر های ورودی

نام پارامتر نوع پارامتر ضروری توضیحات
id long بله کد سرفصل

مقدار id را در انتهای url بفرستید

مثال: https://.../api/v1/group/delete/10024

مقدار بازگشتی

                                            
        {
        "success" : true,
        "response" : "گروه حذف شد",
        "error": ""
        }

متد List

از این متد جهت دریافت لیست سرفصل های یک دوره آموزشی خود استفاده فرمایید

آدرس متد

Method Urlhttps://stream.yoursite.xyz/api/v1/Group/{customerId}/{groupId}

پارامتر های ورودی

نام پارامتر نوع پارامتر ضروری توضیحات
customerId long بله کد مشتری
groupId long بله کد دوره آموزشی

مقدار customerId و groupId را در انتهای url بفرستید

مثال: https://.../api/v1/group/list/42231/20015

مقدار بازگشتی

    
    [
        {
            "VideoCount": 3,
            "UseSpace": 161406192.0,
            "VideoGroup_ID": 20016,
            "VideoGroup_Customer_Ref": 42231,
            "VideoGroup_Parent_Ref": 20015,
            "VideoGroup_Name": "نصب و راه اندازی اندروید استودیو",
            "ChildCount": 0
        }
    ]

شرح مقادیر بازگشتی

نام پارامتر نوع پارامتر توضیحات
VideoCount int تعداد ویدیوهای سرفصل.
UseSpace double فضای ویدیوها به بایت.
VideoGroup_ID long کد سرفصل
VideoGroup_Customer_Ref long کد مشتری
VideoGroup_Parent_Ref long nullable کد دوره آموزشی
VideoGroup_Name String نام سرفصل.
ChildCount int تعداد زیر گروه که برای سرفصل صفر می باشد

متد Get

از این متد جهت دریافت اطلاعات یک سرفصل استفاده فرمایید

آدرس متد

Method Urlhttps://stream.yoursite.xyz/api/v1/Group/Get/{id}

پارامتر های ورودی

نام پارامتر نوع پارامتر ضروری توضیحات
id long بله کد سرفصل

مقدار id را در انتهای url بفرستید

مثال: https://.../api/v1/group/get/20015

مقدار بازگشتی

    
    {
        "VideoCount": 3,
        "UseSpace": 161406192.0,
        "VideoGroup_ID": 20016,
        "VideoGroup_Customer_Ref": 42231,
        "VideoGroup_Parent_Ref": 20015,
        "VideoGroup_Name": "نصب و راه اندازی اندروید استودیو",
        "ChildCount": 0
    }

شرح مقادیر بازگشتی

نام پارامتر نوع پارامتر توضیحات
VideoCount int تعداد ویدیوهای سرفصل.
UseSpace double فضای ویدیوها به بایت.
VideoGroup_ID long کد سرفصل
VideoGroup_Customer_Ref long کد مشتری
VideoGroup_Parent_Ref long nullable کد دوره آموزشی.
VideoGroup_Name String نام سرفصل.
ChildCount int تعداد زیر گروه ها که برای سرفصل صفر می باشد
-->