Home → FormSpring API → Methods → submission

2.4. submission

This method returns a single submission collected for a form.

Authentication

This method requires an API key with data or write permissions for the form. If the API key does not have permissions to access the form, a 404 (not found) will be returned

Arguments

• api_key (required)
• id - submission id (required)
• encryption_password - data encryption password, if one is set. (optional)

Example Request

https://www.formspring.com/api/submission?api_key=ABCDE&id=1001

Response

• id - submission id, unique to each entry
• timestamp - date/time of the submission in YYYY-MM-DD HH:MM:SS format.
• user_agent - user agent string taken from the submitter's browser
• remote_addr - IP address taken from the submitter
• data - key/value pairs, with one entry per field on the form
  • field - field id
  • value - the value that was submitted for this field

Example XML Response

<?xml version="1.0" encoding="utf-8"?>
<response status="ok">
<id>1001</id>
<timestamp>2007-01-01 01:01:01</timestamp>
<user_agent>Mozilla/4.0 (compatible; MSIE 7.0; Windows NT 5.1)</user_agent>
<remote_addr>127.0.0.1</remote_addr>
<data>
<item>
<field>1111</field>
<value>John Smith</value>
</item>
<item>
<field>2222</field>
<value>Apple</value>
</item>
</data>
</response>

Example JSON Response

{
"status" : "ok",
"response" : {
"id" : "1001",
"timestamp" : "2007-01-01 01:01:01",
"user_agent" : "Mozilla/4.0 (compatible; MSIE 7.0; Windows NT 5.1)",
"remote_addr" : "127.0.0.1",
"data" : [ {
"field" : "1111",
"value" : "John Smith"
}, {
"field" : "2222",
"value" : "Apple"
} ]
}
}

Example PHP Response

a:2:{s:6:"status";s:2:"ok";s:8:"response";a:5:{s:2:"id";s:4:"1001";s:9:"timestamp";s:19:"2007-01-01 01:01:01";s:10:"user_agent";s:50:"Mozilla/4.0 (compatible; MSIE 7.0; Windows NT 5.1)";s:11:"remote_addr";s:9:"127.0.0.1";s:4:"data";a:2:{i:0;a:2:{s:5:"field";s:4:"1111";s:5:"value";s:10:"John Smith";}i:1;a:2:{s:5:"field";s:4:"2222";s:5:"value";s:5:"Apple";}}}}