برای استفاده از تمامی API های موجود، نیاز به داشتن یک کلید اختصاصی دارید. برای دریافت این کلید، می‌توانید به صفحه‌ی کلید‌های API مراجعه کنید(api ایجاد پرسشنامه و آزمون آنلاین).
General
APIهای مشترک بین پرسشنامه و آزمون در این بخش قرار دارند .
POST api/General/Duplicate?key={key}&id={id}&newTitle={newTitle}
اطلاعات درخواست
پارامترهای URI
پارامترهای بدنه‌ی درخواست
هیچ پارامتری وجود ندارد
اطلاعات پاسخ
مقدار برگشتی
ID پرسشنامه (آزمون) جدیدی که ساخته شده است
integer
قالب‌های پاسخ
application/json, text/json
application/xml, text/xml
نمونه
<long xmlns=”http://schemas.microsoft.com/2003/10/Serialization/”>1</long>
GET api/General/ShareUrl?key={key}&id={id}
آدرس عمومی پاسخ به پرسشنامه (آزمون) را به دست می‌آورد. از این آدرس می‌توان به صورت نامحدود برای پاسخگویی استفاده کرد.
اطلاعات درخواست
پارامترهای URI
پارامترهای بدنه‌ی درخواست
هیچ پارامتری وجود ندارد
اطلاعات پاسخ
مقدار برگشتی
آدرس عمومی پاسخ به پرسشنامه (آزمون)
string
قالب‌های پاسخ
application/json, text/json
نمونه
“sample string 1”
application/xml, text/xml
نمونه
<string xmlns=”http://schemas.microsoft.com/2003/10/Serialization/”>sample string 1</string>
POST api/General/CreateParticipantsByTokensList?key={key}&id={id}
آدرس‌های منحصر به فردی را برای پاسخ به پرسشنامه (آزمون) ایجاد می‌کند. از هر کدام از این آدرس‌های تنها یک بار می‌توان برای پاسخ به پرسشنامه (آزمون) استفاده کرد. همچنین اطلاعات اضافی مورد نظر خود (همچون آدرس ایمیل پاسخ دهنده، نام و…) را می‌توان برای هر آدرس ذخیره کرد.
پارامترهای بدنه‌ی درخواست
مجموعه اطلاعاتی در مورد پاسخ‌دهندگان که قصد ذخیره‌ی آن را دارید. این مجوعه آرایه‌ای از آرایه‌ای از نوع Token است. هر Token یکی از اطلاعات مورد نظر برای یک پاسخ‌دهنده را ذخیره می‌کند. به عنوان مثال می‌توان آدرس ایمیل، نام و نام خانوادگی پاسخ‌دهنده را در سه Token ارسال کرد. به همین خاطر، یک آرایه از Token اطلاعات یک پاسخ‌دهنده را توصیف می‌کند. می‌توانید اطلاعات چندین پاسخ‌دهنده را به صورت همزمان و در یک درخواست ارسال کنید.
قالب‌های درخواست
application/json, text/json
نمونه
[ [ { “Title”: “Email”, “Value”: “[email protected]” }, { “Title”: “Name”, “Value”: “Name of respondent #1” } ], [ { “Title”: “Email”, “Value”: “[email protected]” }, { “Title”: “Name”, “Value”: “Name of respondent #2” } ] ]
application/xml, text/xml
<ArrayOfArrayOfToken xmlns:i=”http://www.w3.org/2001/XMLSchema-instance” xmlns=”http://schemas.datacontract.org/2004/07/DigiSurvey.api.Models”>
<ArrayOfToken>
<Token>
<Title>Email</Title>
<Value>[email protected]</Value>
</Token>
<Token>
<Title>Name</Title>
<Value>Name of respondent #1</Value>
</Token>
</ArrayOfToken>
<ArrayOfToken>
<Token>
<Title>Email</Title>
<Value>[email protected]</Value>
</Token>
<Token>
<Title>Name</Title>
<Value>Name of respondent #2</Value>
</Token>
</ArrayOfToken>
</ArrayOfArrayOfToken>
اطلاعات پاسخ
مقدار برگشتی
مجموعه‌ای از آدرس‌های منحصر به فرد و یک بار مصرف برای پاسخ به پرسشنامه.
قالب‌های پاسخ
application/json, text/json, application/xml, text/xml
POST api/General/CreateParticipants?key={key}&id={id}&count={count}
به تعداد مورد نیاز، لینک یک بار مصرف برای پاسخ به پرسشنامه (آزمون) ایجاد می‌کند
اطلاعات درخواست
پارامترهای URI
پارامترهای بدنه‌ی درخواست
هیچ پارامتری وجود ندارد
اطلاعات پاسخ
مقدار برگشتی
مجموعه‌ای از آدرس‌های یک بار مصرف برای پاسخ به پرسشنامه (آزمون).
قالب‌های پاسخ
application/json, text/json, application/xml, text/xml
امیدوارم که با api ایجاد پرسشنامه و آزمون آنلاین به خوبی آشنا شده باشید جهت استفاده و آشنایی بیشتر به لینک https://www.digisurvey.net/apihelp مراجعه نمائید .