<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><title>Python: module jotform</title>
</head><body bgcolor="#f0f0f8">
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
<tr bgcolor="#7799ee">
<td valign=bottom> <br>
<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong>jotform</strong></big></big></font></td
><td align=right valign=bottom
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/Users/imac/Desktop/Projects/jotform-api-python/jotform.py">/Users/imac/Desktop/Projects/jotform-api-python/jotform.py</a></font></td></tr></table>
<p><tt># -*- coding: utf-8 -*-<br>
#<br>
# Jotform API Wrapper<br>
# copyright : Interlogy LLC<br>
#</tt></p>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#aa55cc">
<td colspan=3 valign=bottom> <br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
<tr><td bgcolor="#aa55cc"><tt> </tt></td><td> </td>
<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="json.html">json</a><br>
</td><td width="25%" valign=top><a href="urllib.html">urllib</a><br>
</td><td width="25%" valign=top><a href="urllib2.html">urllib2</a><br>
</td><td width="25%" valign=top></td></tr></table></td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ee77aa">
<td colspan=3 valign=bottom> <br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td>
<td width="100%"><dl>
<dt><font face="helvetica, arial"><a href="jotform.html#JotformAPIClient">JotformAPIClient</a>
</font></dt></dl>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom> <br>
<font color="#000000" face="helvetica, arial"><a name="JotformAPIClient">class <strong>JotformAPIClient</strong></a></font></td></tr>
<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td>
<td width="100%">Methods defined here:<br>
<dl><dt><a name="JotformAPIClient-__init__"><strong>__init__</strong></a>(self, apiKey, debug<font color="#909090">=False</font>, outputType<font color="#909090">='json'</font>)</dt></dl>
<dl><dt><a name="JotformAPIClient-clone_form"><strong>clone_form</strong></a>(self, formID)</dt><dd><tt>Clone a single form.<br>
<br>
Args:<br>
formID (string): Form ID is the numbers you see on a form URL. You can get form IDs when you call /user/forms.<br>
<br>
Returns:<br>
Status of request.</tt></dd></dl>
<dl><dt><a name="JotformAPIClient-create_conditions"><strong>create_conditions</strong></a>(self, offset, limit, filterArray, order_by)</dt></dl>
<dl><dt><a name="JotformAPIClient-create_form_submissions"><strong>create_form_submissions</strong></a>(self, formID, submission)</dt><dd><tt>Submit data to this form using the API.<br>
<br>
Args:<br>
formID (string): Form ID is the numbers you see on a form URL. You can get form IDs when you call /user/forms.<br>
submission (array): Submission data with question IDs.<br>
<br>
Returns:<br>
Posted submission ID and URL.</tt></dd></dl>
<dl><dt><a name="JotformAPIClient-create_form_webhook"><strong>create_form_webhook</strong></a>(self, formID, webhookURL)</dt><dd><tt>Add a new webhook<br>
<br>
Args:<br>
formID (string): Form ID is the numbers you see on a form URL. You can get form IDs when you call /user/forms.<br>
webhookURL (string): Webhook URL is where form data will be posted when form is submitted. <br>
<br>
Returns:<br>
List of webhooks for a specific form.</tt></dd></dl>
<dl><dt><a name="JotformAPIClient-delete_form_question"><strong>delete_form_question</strong></a>(self, formID, qid)</dt><dd><tt>Delete a single form question.<br>
<br>
Args:<br>
formID (string): Form ID is the numbers you see on a form URL. You can get form IDs when you call /user/forms.<br>
qid (string): Identifier for each question on a form. You can get a list of question IDs from /form/{id}/questions.<br>
<br>
Returns:<br>
Status of request.</tt></dd></dl>
<dl><dt><a name="JotformAPIClient-delete_submission"><strong>delete_submission</strong></a>(self, sid)</dt><dd><tt>Delete a single submission.<br>
<br>
Args:<br>
sid (string): You can get submission IDs when you call /form/{id}/submissions.<br>
<br>
Returns:<br>
Status of request.</tt></dd></dl>
<dl><dt><a name="JotformAPIClient-edit_submission"><strong>edit_submission</strong></a>(self, sid, submission)</dt><dd><tt>Edit a single submission.<br>
<br>
Args:<br>
sid (string): You can get submission IDs when you call /form/{id}/submissions.<br>
submission (array): New submission data with question IDs.<br>
<br>
Returns:<br>
Status of request.</tt></dd></dl>
<dl><dt><a name="JotformAPIClient-fetch_url"><strong>fetch_url</strong></a>(self, url, params<font color="#909090">=None</font>, method<font color="#909090">=None</font>)</dt></dl>
<dl><dt><a name="JotformAPIClient-get_folder"><strong>get_folder</strong></a>(self, folderID)</dt><dd><tt>Get folder details<br>
<br>
Args:<br>
folderID (string): Get a list of folders from /user/folders<br>
<br>
Returns:<br>
A list of forms in a folder, and other details about the form such as folder color.</tt></dd></dl>
<dl><dt><a name="JotformAPIClient-get_folders"><strong>get_folders</strong></a>(self)</dt><dd><tt>Get a list of form folders for this account.<br>
<br>
Returns:<br>
Name of the folder and owner of the folder for shared folders.</tt></dd></dl>
<dl><dt><a name="JotformAPIClient-get_form"><strong>get_form</strong></a>(self, formID)</dt><dd><tt>Get basic information about a form.<br>
<br>
Args:<br>
formID (string): Form ID is the numbers you see on a form URL. You can get form IDs when you call /user/forms.<br>
<br>
Returns:<br>
Form ID, status, update and creation dates, submission count etc.</tt></dd></dl>
<dl><dt><a name="JotformAPIClient-get_form_files"><strong>get_form_files</strong></a>(self, formID)</dt><dd><tt>List of files uploaded on a form.<br>
<br>
Args:<br>
formID (string): Form ID is the numbers you see on a form URL. You can get form IDs when you call /user/forms.<br>
<br>
Returns:<br>
Uploaded file information and URLs on a specific form.</tt></dd></dl>
<dl><dt><a name="JotformAPIClient-get_form_properties"><strong>get_form_properties</strong></a>(self, formID)</dt><dd><tt>Get a list of all properties on a form.<br>
<br>
Args:<br>
formID (string): Form ID is the numbers you see on a form URL. You can get form IDs when you call /user/forms.<br>
<br>
Returns:<br>
Form properties like width, expiration date, style etc.</tt></dd></dl>
<dl><dt><a name="JotformAPIClient-get_form_property"><strong>get_form_property</strong></a>(self, formID, propertyKey)</dt><dd><tt>Get a specific property of the form.<br>
<br>
Args:<br>
formID (string): Form ID is the numbers you see on a form URL. You can get form IDs when you call /user/forms.<br>
propertyKey (string): You can get property keys when you call /form/{id}/properties.<br>
<br>
Returns:<br>
Given property key value.</tt></dd></dl>
<dl><dt><a name="JotformAPIClient-get_form_question"><strong>get_form_question</strong></a>(self, formID, qid)</dt><dd><tt>Get details about a question<br>
<br>
Args:<br>
formID (string): Form ID is the numbers you see on a form URL. You can get form IDs when you call /user/forms.<br>
qid (string): Identifier for each question on a form. You can get a list of question IDs from /form/{id}/questions.<br>
<br>
Returns:<br>
Question properties like required and validation.</tt></dd></dl>
<dl><dt><a name="JotformAPIClient-get_form_questions"><strong>get_form_questions</strong></a>(self, formID)</dt><dd><tt>Get a list of all questions on a form.<br>
<br>
Args:<br>
formID (string): Form ID is the numbers you see on a form URL. You can get form IDs when you call /user/forms.<br>
<br>
Returns:<br>
Question properties of a form.</tt></dd></dl>
<dl><dt><a name="JotformAPIClient-get_form_submissions"><strong>get_form_submissions</strong></a>(self, formID, offset<font color="#909090">=None</font>, limit<font color="#909090">=None</font>, filterArray<font color="#909090">=None</font>, order_by<font color="#909090">=None</font>)</dt><dd><tt>List of a form submissions.<br>
<br>
Args:<br>
formID (string): Form ID is the numbers you see on a form URL. You can get form IDs when you call /user/forms.<br>
offset (string): Start of each result set for form list. (optional)<br>
limit (string): Number of results in each result set for form list. (optional)<br>
filterArray (array): Filters the query results to fetch a specific form range.(optional)<br>
order_by (string): Order results by a form field name. (optional)<br>
<br>
Returns:<br>
Submissions of a specific form.</tt></dd></dl>
<dl><dt><a name="JotformAPIClient-get_form_webhooks"><strong>get_form_webhooks</strong></a>(self, formID)</dt><dd><tt>Get list of webhooks for a form<br>
<br>
Args:<br>
formID (string): Form ID is the numbers you see on a form URL. You can get form IDs when you call /user/forms.<br>
<br>
Returns:<br>
List of webhooks for a specific form.</tt></dd></dl>
<dl><dt><a name="JotformAPIClient-get_forms"><strong>get_forms</strong></a>(self, offset<font color="#909090">=None</font>, limit<font color="#909090">=None</font>, filterArray<font color="#909090">=None</font>, order_by<font color="#909090">=None</font>)</dt><dd><tt>Get a list of forms for this account<br>
<br>
Args:<br>
offset (string): Start of each result set for form list. (optional)<br>
limit (string): Number of results in each result set for form list. (optional)<br>
filterArray (array): Filters the query results to fetch a specific form range.(optional)<br>
order_by (string): Order results by a form field name. (optional)<br>
<br>
Returns:<br>
Basic details such as title of the form, when it was created, number of new and total submissions.</tt></dd></dl>
<dl><dt><a name="JotformAPIClient-get_history"><strong>get_history</strong></a>(self)</dt><dd><tt>Get user activity log.<br>
<br>
Returns:<br>
Activity log about things like forms created/modified/deleted, account logins and other operations.</tt></dd></dl>
<dl><dt><a name="JotformAPIClient-get_report"><strong>get_report</strong></a>(self, reportID)</dt><dd><tt>Get report details<br>
<br>
Args:<br>
reportID (string): You can get a list of reports from /user/reports.<br>
<br>
Returns:<br>
Properties of a speceific report like fields and status.</tt></dd></dl>
<dl><dt><a name="JotformAPIClient-get_reports"><strong>get_reports</strong></a>(self)</dt><dd><tt>List of URLS for reports in this account.<br>
<br>
Returns:<br>
Reports for all of the forms. ie. Excel, CSV, printable charts, embeddable HTML tables.</tt></dd></dl>
<dl><dt><a name="JotformAPIClient-get_settings"><strong>get_settings</strong></a>(self)</dt><dd><tt>Get user's settings for this account.<br>
<br>
Returns:<br>
User's time zone and language.</tt></dd></dl>
<dl><dt><a name="JotformAPIClient-get_submission"><strong>get_submission</strong></a>(self, sid)</dt><dd><tt>Get submission data<br>
<br>
Args:<br>
sid (string): You can get submission IDs when you call /form/{id}/submissions.<br>
<br>
Returns:<br>
Information and answers of a specific submission.</tt></dd></dl>
<dl><dt><a name="JotformAPIClient-get_submissions"><strong>get_submissions</strong></a>(self, offset<font color="#909090">=None</font>, limit<font color="#909090">=None</font>, filterArray<font color="#909090">=None</font>, order_by<font color="#909090">=None</font>)</dt><dd><tt>Get a list of submissions for this account.<br>
<br>
Args:<br>
offset (string): Start of each result set for form list. (optional)<br>
limit (string): Number of results in each result set for form list. (optional)<br>
filterArray (array): Filters the query results to fetch a specific form range.(optional)<br>
order_by (string): Order results by a form field name. (optional)<br>
<br>
Returns:<br>
Basic details such as title of the form, when it was created, number of new and total submissions.</tt></dd></dl>
<dl><dt><a name="JotformAPIClient-get_subusers"><strong>get_subusers</strong></a>(self)</dt><dd><tt>Get a list of sub users for this account.<br>
<br>
Returns:<br>
List of forms and form folders with access privileges.</tt></dd></dl>
<dl><dt><a name="JotformAPIClient-get_usage"><strong>get_usage</strong></a>(self)</dt><dd><tt>Get number of form submissions received this month.<br>
<br>
Returns:<br>
Number of submissions, number of SSL form submissions, payment form submissions and upload space used by user.</tt></dd></dl>
<dl><dt><a name="JotformAPIClient-get_user"><strong>get_user</strong></a>(self)</dt><dd><tt>Get user account details for a JotForm user.<br>
<br>
Returns:<br>
User account type, avatar URL, name, email, website URL and account limits.</tt></dd></dl>
</td></tr></table></td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#55aa55">
<td colspan=3 valign=bottom> <br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
<tr><td bgcolor="#55aa55"><tt> </tt></td><td> </td>
<td width="100%"><strong>__author__</strong> = 'canerbalci@gmail.com (Caner Balci)'</td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#7799ee">
<td colspan=3 valign=bottom> <br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Author</strong></big></font></td></tr>
<tr><td bgcolor="#7799ee"><tt> </tt></td><td> </td>
<td width="100%">canerbalci@gmail.com (Caner Balci)</td></tr></table>
</body></html>