REST - POST
ePermission allows you to pass information to be pre-filled to a form. Make sure you have a developer key before you proceed.
POST PARAMETERS:
In order to accept your post, ePermission will be expecting the following format:
Please note that some fields may be required depending on your form's configuration. For example, if you for requires a last name, the API will be expecting to receive a value for the field last_name.
Please note that some fields may be required depending on your form's configuration. For example, if you for requires a last name, the API will be expecting to receive a value for the field last_name.
Field | Required | Format | Description |
dpk | YES | Text | Developer private KEY |
transaction_id | NO | Text | Your transaction ID Reference. Also returned by the IFN if configured. |
transaction_misc | NO | Text | Miscellaneous information that you would like to get back with the form. |
return_url_params | NO | Text | List of URL parameters that will be added to your return URL configured in the form designer. For example, if my return url is: https://mysite.com/ and this fields contains abc=1&xyz=hj35s , the return url may look like: https://mysite.com/?abc=1&xyz=hj35s |
first_name | ? | Text | First name to be printed on the form. |
last_name | ? | Text | Last name to be printed on the form. |
last_name | ? | Text | Last name to be printed on the form. |
birthdate | ? | Date (YYYY-MM-DD) | birthdate name to be printed on the form. |
address_1 | ? | Text | Address line 1 to be printed on the form. |
address_2 | Optional | Text | Address line 2 to be printed on the form. |
city | ? | Text | City to be printed on the form. |
country | ? | Text | ISO Country format. CA=Canada, US=USA etc. Full list: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#CA |
state | ? | Text | 2 Letters format for Canada (ON,BC,QC ...) & USA (CA,NY,TX ...). 512 character limit for other locations. |
postal_code | ? | Text | Postal code to be printed on the form. |
? | Email to be printed on the form and will also be used for confirmation if your form is setup to trigger email confirmation. | ||
phone_number | ? | Text | Phone number to be printed on the form |
If you have turned on "Is your organization a school and your would like to activate the Classes & Students mode?:" in the preferences, you will also be able to use the following fields:
Field | Required | Format | Description |
student_first_name | ? | Text | First name to be printed on the form. |
student_last_name | ? | Text | Last name to be printed on the form. |
student_birthdate | ? | Date (YYYY-MM-DD) | birthdate name to be printed on the form. |
student_address_1 | ? | Text | Address line 1 to be printed on the form. |
student_address_2 | Optional | Text | Address line 2 to be printed on the form. |
student_city | ? | Text | City to be printed on the form. |
student_country | ? | Text | ISO Country format. CA=Canada, US=USA etc. Full list: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#CA |
student_state | ? | Text | 2 Letters format for Canada (ON,BC,QC ...) & USA (CA,NY,TX ...). 512 character limit for other locations. |
student_postal_code | ? | Text | Postal code to be printed on the form. |
POST URL FORMAT:
The URL of your post is the same people use for the direct link share. However, when your service posts information to our engine, our engine will be looking for a private key and your form parameters.
A post in JAVA may look like this:
HttpClient httpclient = HttpClients.createDefault();
HttpPost httppost = new HttpPost("https://secure.epermission.io/f/?l=xxxxxx ");
// Request parameters and other properties.
List params = new ArrayList(3);
params.add(new BasicNameValuePair("dpk", "xxxx-xxxx-xxxx-xxxx-xxxxx ..."));
params.add(new BasicNameValuePair("first_name", "Joe"));
params.add(new BasicNameValuePair("last_name", "Demo"));
...
httppost.setEntity(new UrlEncodedFormEntity(params, "UTF-8"));
//Execute and get the response.
HttpResponse response = httpclient.execute(httppost);
HttpEntity entity = response.getEntity();
if (entity != null) {
InputStream instream = entity.getContent();
try {
// do something useful
} finally {
instream.close();
}
}
A post in JAVA may look like this:
HttpClient httpclient = HttpClients.createDefault();
HttpPost httppost = new HttpPost("https://secure.epermission.io/f/?l=xxxxxx ");
// Request parameters and other properties.
List
params.add(new BasicNameValuePair("dpk", "xxxx-xxxx-xxxx-xxxx-xxxxx ..."));
params.add(new BasicNameValuePair("first_name", "Joe"));
params.add(new BasicNameValuePair("last_name", "Demo"));
...
httppost.setEntity(new UrlEncodedFormEntity(params, "UTF-8"));
//Execute and get the response.
HttpResponse response = httpclient.execute(httppost);
HttpEntity entity = response.getEntity();
if (entity != null) {
InputStream instream = entity.getContent();
try {
// do something useful
} finally {
instream.close();
}
}