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

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

وب سرویس دوره های آموزشی

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

متد Create

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

آدرس متد

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

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

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

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

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

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

متد Update

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

آدرس متد

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

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

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

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

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

                                            
    {   
        "success" : true,
        "response" : "10024",
        "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/List/{customerId}

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

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

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

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

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

                                            
    [
        {
            "VideoCount": 3,
            "UseSpace": 161406192.0,
            "VideoGroup_ID": 20015,
            "VideoGroup_Customer_Ref": 42231,
            "VideoGroup_Parent_Ref": null,
            "VideoGroup_Name": "برنامه نویسی اندروید",
            "ChildCount": 1
        },
        {
            "VideoCount": 0,
            "UseSpace": 0.0,
            "VideoGroup_ID": 20017,
            "VideoGroup_Customer_Ref": 42231,
            "VideoGroup_Parent_Ref": null,
            "VideoGroup_Name": "برنامه نویسی سی شارپ پیشرفته",
            "ChildCount": 0
        }
    ]

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

نام پارامتر نوع پارامتر توضیحات
VideoCount int تعداد ویدیوهای دوره.
UseSpace double فضای ویدیوها به بایت.
VideoGroup_ID long کد دوره آموزشی
VideoGroup_Customer_Ref long کد مشتری
VideoGroup_Parent_Ref long nullable کد سرگروه که برای دوره null می باشد.
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": 20015,
        "VideoGroup_Customer_Ref": 42231,
        "VideoGroup_Parent_Ref": null,
        "VideoGroup_Name": "برنامه نویسی اندروید",
        "ChildCount": 1
    }

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

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