وب سرویس دریافت گزارش نوبتهای رزرو و نوبت دهی USSD

وب سرویسهای زیربه شما این امکان را میدهد که گزارشی جامع از نوبتهای ثبت شده بر روی کد یو اس اس دی خود به صورت JSON دریافت کنید.
در نظر داشته باشید در اولین ارتباط توالی صحیح فراخوانی وب سرویسها میبایست رعایت شود و پس از دریافت اطلاعات مورد نظر در فراخوانیهای بعدی میتوانید از دیتاهای دریافت شده خود استفاده نمایید .

  1. وب سرویس دریافت اطلاعات کمپانی
    1. نمونه ورودی json
    2. ساختار خروجی
    3. ساختار وضعیتها
  2. وب سرویس دریافت اطلاعات خدمات و سرویسهای تعریف شده
    1. نمونه ورودی json
    2. ساختار خروجی
    3. ساختار وضعیتها
  3. وب سرویس دریافت اطلاعات افراد و پرسنل تعریف شده
    1. نمونه ورودی json
    2. ساختار خروجی
    3. ساختار وضعیتها
  4. وب سرویس دریافت اطلاعات ملزومات تعریف شده
    1. نمونه ورودی json
    2. ساختار خروجی
    3. ساختار وضعیتها
  5. وب سرویس دریافت لیست کامل اطلاعات رزرو و نوبت دهی
    1. نمونه ورودی json
    2. ساختار خروجی
    3. ساختار وضعیتها

دریافت اطلاعات کمپانی

با دریافت اطلاعات کمپانی از وب سرویس زیر و قرار دادن اطلاعات دریافتی در وب سرویسهای دیگر میتوانید مشخصات تعریف شده در پنل رزرو و نوبت دهی را دریافت کنید . اجرای این وب سرویس در اولین بار برای دریافت کمپانی آی دی الزامی میباشد .
برای ارسال پارامترهای ورودی میبایست ابتدا وب سرویس با آدرس زیر را با متد " پست/POST " فراخوانی کنید:
https://restful.inoti.com/api/USSD/GetCompany
ساختار ورودی:

Description Variable Type Variable Name
توکن قابل دریافت در ناحیه کاربری string Token

نمونه JSON رودی:

copy 
    
{
    "Token":"your token"
}

ساختار خروجی:

پاسخ دریافتی به صورت JSON میباشد .

Description Data Type Variable
شامل اطلاعات کمپانی درخواستی List ObjGetCompanyOutput
کد پاسخ/خطا int Status
پیام پاسخ/خطا string Message

ساختار GetCompanyOutput:

پاسخ دریافتی به صورت JSON میباشد .

Description Data Type Variable
شناسه کمپانی long CompanyID
نام کمپانی string CompanyName
کد یو اس اس دی string USSDCode 

                            
{
    "ObjGetCompanyOutput": [
        {
            "CompanyID": 1,
            "CompanyName": "مشاوره فنی",
        "USSDCode": "*6655*123#"
        },
        {
            "CompanyID": 2,
            "CompanyName": "کلینیک پوست و مو"
        "USSDCode": "*6655*1234#"
        },
        {
            "CompanyID": 3,
            "CompanyName": "وکالت دعاوی"
        "USSDCode": "*6655*12345#"
        },
    ],
    "Status": 1,
    "Message": "Compeleted Successfully"
}

وضعیتها:

در صورت وجود هرگونه خطا، مقدار خطا را به صورت عددی در پاسخ status برمیگرداند که مطابق جدول زیر میباشد

Description Status Code
"Compeleted Successfully" 1
"Exception Error" -1
"Invalid Token" -2
"Request Error" -3

دریافت اطلاعات خدمات و سرویسهای تعریف شده

دریافت اطلاعات خدمات و سرویسهای تعریف شده از طریق وب سرویس زیر امکان پذیر میباشد در نظر داشته باشید شما میبایست با وب سرویس کمپانی ابتدا آی دی کمپانی خود را به دست آورده و سپس از این وب سرویس در صورت نیاز استفاده کنید.
برای ارسال پارامترهای ورودی میبایست ابتدا وب سرویس با آدرس زیر را با متد " پست/POST " فراخوانی کنید:
https://restful.inoti.com/api/USSD/GetServices
ساختار ورودی:

Description Variable Type Variable Name
توکن قابل دریافت در ناحیه کاربری string Token
شناسه کمپانی (کسب و کار ) long CompanyID

نمونه JSON ورودی:

copy 
    
{
    "Token":"your token"
    "CompanyID": 1
}

ساختار خروجی:

پاسخ دریافتی به صورت JSON میباشد .

Description Data Type Variable
شامل اطلاعات سرویسهای درخواستی List ObjGetServicesOutput
کد پاسخ/خطا int Status
پیام پاسخ/خطا string Message

ساختار GetServicesOutput:

پاسخ دریافتی به صورت JSON میباشد .

Description Data Type Variable
شناسه سرویس long ServiceID
نام سرویس string ServiceName 

                            
{
    "ObjGetServicesOutput": [
        {
            "ServiceID": 1,
            "ServiceName": "مشاوره امنیت داده ها"
        },
        {
            "ServiceID": 2,
            "ServiceName": "مشاوره برنامه نویسی"
        },
        {
            "ServiceID": 3,
            "ServiceName": "مشاوره وب سرویس"
        },
    ],
    "Status": 1,
    "Message": "Compeleted Successfully"
}

وضعیتها:

در صورت وجود هرگونه خطا، مقدار خطا را به صورت عددی در پاسخ status برمیگرداند که مطابق جدول زیر میباشد

Description Status Code
"Compeleted Successfully" 1
"Exception Error" -1
"Invalid Token" -2
"Request Error" -3

دریافت اطلاعات پرسنل تعریف شده

دریافت اطلاعات پرسنل تعریف شده از طریق وب سرویس زیر امکان پذیر میباشد در نظر داشته باشید شما میبایست با وب سرویس کمپانی ابتدا آی دی کمپانی خود را به دست آورده و سپس از این وب سرویس در صورت نیاز استفاده کنید.
برای ارسال پارامترهای ورودی میبایست ابتدا وب سرویس با آدرس زیر را با متد " پست/POST " فراخوانی کنید:
https://restful.inoti.com/api/USSD/GetPersons
ساختار ورودی:

Description Variable Type Variable Name
توکن قابل دریافت در ناحیه کاربری string Token
شناسه کمپانی (کسب و کار ) long CompanyID

نمونه JSON ورودی:

copy 
    
{
    "Token":"your token"
    "CompanyID": 1
}

ساختار خروجی:

پاسخ دریافتی به صورت JSON میباشد .

Description Data Type Variable
شامل اطلاعات پرسنل درخواستی List ObjGetPersonsOutput
کد پاسخ/خطا int Status
پیام پاسخ/خطا string Message

ساختار GetServicesOutput:

پاسخ دریافتی به صورت JSON میباشد .

Description Data Type Variable
شناسه پرسنل long PersonID
نام پرسنل string PersonName 

                            
{
    "ObjGetPersonsOutput": [
        {
            "PersonID": 1,
            "PersonName": "علی محمدی"
        },
        {
            "PersonID": 2,
            "PersonName": "رضا اکبری"
        },
        {
            "PersonID": 3,
            "PersonName": "زهرا نوری"
        },
    ],
    "Status": 1,
    "Message": "Compeleted Successfully"
}

وضعیتها:

در صورت وجود هرگونه خطا، مقدار خطا را به صورت عددی در پاسخ status برمیگرداند که مطابق جدول زیر میباشد

Description Status Code
"Compeleted Successfully" 1
"Exception Error" -1
"Invalid Token" -2
"Request Error" -3

دریافت اطلاعات ملزومات تعریف شده

دریافت اطلاعات ملزومات تعریف شده از طریق وب سرویس زیر امکان پذیر میباشد در نظر داشته باشید شما میبایست با وب سرویس کمپانی ابتدا آی دی کمپانی خود را به دست آورده و سپس از این وب سرویس در صورت نیاز استفاده کنید.
برای ارسال پارامترهای ورودی میبایست ابتدا وب سرویس با آدرس زیر را با متد " پست/POST " فراخوانی کنید:
https://restful.inoti.com/api/USSD/GetObjects
ساختار ورودی:

Description Variable Type Variable Name
توکن قابل دریافت در ناحیه کاربری string Token
شناسه کمپانی (کسب و کار ) long CompanyID

نمونه JSON ورودی:

copy 
    
{
    "Token":"your token"
    "CompanyID": 1
}

ساختار خروجی:

پاسخ دریافتی به صورت JSON میباشد .

Description Data Type Variable
شامل اطلاعات ملزومات درخواستی List ObjGetObjectsOutput
کد پاسخ/خطا int Status
پیام پاسخ/خطا string Message

ساختار ObjGetObjectsOutput:

پاسخ دریافتی به صورت JSON میباشد .

Description Data Type Variable
شناسه ملزومات long ObjectID
نام ملزومات string ObjectName 

                            
{
    "ObjGetObjectsOutput": [
        {
            "ObjectID": 1,
            "ObjectName": "اطاق مشاوره"
        },
        {
            "ObjectID": 2,
            "ObjectName": "دستگاه ویدیو کنفرانس"
        },
        {
            "ObjectID": 3,
            "ObjectName": " تخته وایت برد هوشمند" 
        },
    ],
    "Status": 1,
    "Message": "Compeleted Successfully"
}

وضعیتها:

در صورت وجود هرگونه خطا، مقدار خطا را به صورت عددی در پاسخ status برمیگرداند که مطابق جدول زیر میباشد

Description Status Code
"Compeleted Successfully" 1
"Exception Error" -1
"Invalid Token" -2
"Request Error" -3

دریافت اطلاعات رزرو و نوبت دهی تعریف شده

دریافت کلیه اطلاعات رزرو و نوبت دهیهای تعریف شده از طریق وب سرویس زیر امکان پذیر میباشد در نظر داشته باشید شما میبایست با وب سرویس کمپانی ابتدا آی دی کمپانی خود را به دست آورده و سپس از این وب سرویس در صورت نیاز استفاده کنید.
برای ارسال پارامترهای ورودی میبایست ابتدا وب سرویس با آدرس زیر را با متد " پست/POST " فراخوانی کنید:
https://restful.inoti.com/api/USSD/GetReserveReport
ساختار ورودی:

Defult Value Mandatory Description Variable Type Variable Name
ندارد اجباری توکن قابل دریافت در ناحیه کاربری string Token
ندارد اجباری شناسه کمپانی (کسب و کار ) long CompanyID
String.Empty اختیاری کد رهگیری string TracingNo
-1 اختیاری شناسه سرویس long ServiceID
-1 اختیاری شناسه پرسنل long PersonID
-1 اختیاری شناسه ملزومات long ObjectID
-1 اختیاری وضعیت رزرو int ReserveStatusID
1900-01-01 اختیاری تاریخ شروع بازه زمانی DateTime FromDT
1900-01-01 اختیاری تاریخ پایان بازه زمانی DateTime ToDT
String.Empty اختیاری شماره موبایل رزرو کننده وقت string Mobile
-1 اختیاری وضعیت پرداخت int PayStatus
String.Empty اختیاری شماره مرجع رسید بانکی string RefKey

اطلاعات ورودی وضعیتهای رزرو:

Description ReserveStatusID
آزاد 0
رزرو شده 1
غیرقابل رزرو 2
کنسل شده 3
در انتظار پرداخت 4
حذف شده 9

اطلاعات ورودی وضعیتهای رزرو:

Description PayStatus
all -1
not payed 0
payed 1

نمونه JSON ورودی:

copy 
    
{
    "Token": "your_token_value",
    "CompanyID": 1,
    "TracingNo": "",
    "ServiceID": -1,
    "PersonID": -1,
    "ObjectID": -1,
    "StatusID": -1,
    "FromDT": "1900-01-01T00:00:00",
    "ToDT": "1900-01-01T00:00:00",
    "Mobile": "",
    "PayStatus": -1,
    "RefKey": ""
}

ساختار خروجی:

پاسخ دریافتی به صورت JSON میباشد .

Description Data Type Variable
شامل اطلاعات رزرو و نوبت دهی درخواستی List ObjReserveReportOutputList
کد پاسخ/خطا int Status
پیام پاسخ/خطا string Message

ساختار ObjReserveReportOutputList:

پاسخ دریافتی به صورت JSON میباشد .

Description Data Type Variable
شناسه کمپانی long CompanyID
نام گمپانی string CompanyName
کد یو اس اس دی string USSDCode
شناسه سرویس long ServiceID
نام سرویس string ServiceName
شناسه پرسنل long PersonID
نام پرسنل string PersonName
شناسه ملزومات long ObjectID
نام ملزومات string ObjectName
شماره موبایل string Mobile
کد ملی string NationalCode
ایمیل string Email
تاریخ رزرو میلادی DateTime ReserveDateTime
تاریخ رزرو شمسی string ReserveDateSh
ساعت رزرو string ReserveTime
مدت زمان وقت رزرو به دقیقه int MinuteDuration
مبلغ پرداختی کاربر long Price
وضعیت پرداخت int PayStatus
شماره رهگیری پرداخت string PayDigitalRef
تاریخ و زمان پرداخت DateTime PayDateTime
شماره پیگیری نوبت string TracingNo
وضعیت زمان رزرو نوبت دهی int ReserveStatusID
عنوان وضعیت string StatusName
توضیحات long Note 

                            
{
    "ReserveReportOutput": [
        {
            "CompanyID": 1,
            "CompanyName": "مشاوره فنی",
            "USSDCode": "*6655*123*093",
            "ServiceID": 1,
            "ServiceName": "مشاوره امنیت داده ها",
            "PersonID": 1,
            "PersonName": "علی محمدی",
            "ObjectID": 0,
            "ObjectName": "",
            "Mobile": "09121234567",
            "NationalCode": "",
            "Email": "",
            "ReserveDateTime": "2021-01-13T11:00:01",
            "ReserveDateSh": "1399/10/24",
            "ReserveTime": "11:00:01",
            "MinuteDuration": 60,
            "Price": 300000,
            "PayStatus": 1,
            "PayDigitalRef": "48364137",
            "PayDateTime": "2021-01-12T15:28:00",
            "TracingNo": "66551170",
            "StatusID": 1,
            "StatusName": "رزرو شده",
            "Note": ""
        },
        {
            "CompanyID": 1,
            "CompanyName": "مشاوره فنی",
            "USSDCode": "*6655*123*093",
            "ServiceID": 1,
            "ServiceName": "مشاوره امنیت داده ها",
            "PersonID": 1,
            "PersonName": "علی محمدی",
            "ObjectID": 0,
            "ObjectName": "",
            "Mobile": "09121232367",
            "NationalCode": "",
            "Email": "",
            "ReserveDateTime": "2021-01-13T12:00:01",
            "ReserveDateSh": "1399/10/24",
            "ReserveTime": "11:00:01",
            "MinuteDuration": 60,
            "Price": 300000,
            "PayStatus": 1,
            "PayDigitalRef": "48364237",
            "PayDateTime": "2021-01-12T16:28:00",
            "TracingNo": "66551270",
            "StatusID": 1,
            "StatusName": "رزرو شده",
            "Note": ""
        }
    ],
    "Status": 1,
    "Message": "Compeleted Successfully"
}

وضعیتها:

در صورت وجود هرگونه خطا، مقدار خطا را به صورت عددی در پاسخ status برمیگرداند که مطابق جدول زیر میباشد

Description Status Code
"Compeleted Successfully" 1
"Exception Error" -1
"Invalid Token" -2
"Request Error" -3