forked from jotform/jotform-api-python
-
Notifications
You must be signed in to change notification settings - Fork 0
/
jotform.html
269 lines (233 loc) · 19.5 KB
/
jotform.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
<!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> = '[email protected] (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%">[email protected] (Caner Balci)</td></tr></table>
</body></html>