Allows user (based on account owner ID) to get all forms of a specific type.
XML Request Example:
<?xml version="1.0" encoding="UTF-8"?>
<xmlrequest>
<username>JohnDoe</username>
<usertoken>abc123abc123abc123abc123</usertoken>
<requesttype>Forms</requesttype>
<requestmethod>GetForms</requestmethod>
<details>
<owner>13</owner> <!-- required -->
<type>subscribe</type> <!-- required -->
</details>
</xmlrequest><xmlrequest> element
| Field Name | Description |
| username | Username used to login to Pinpointe |
| usertoken | Unique token assigned to Pinpointe account |
| requesttype | Forms |
| requestmethod | GetForms |
<details> element
Please note: ALL OPTIONAL elements that are not used should be deleted from submitted call. User must specify a form type OR delete the "type": "{*form_type*}" element.
| Field Name | Description |
| owner (Required) | The owner ID for the account |
| type | The form type. There are four form types. Valid values are:
|
Successful Response:
<response> element
| Field Name | Description |
| status | Will return SUCCESS if form was successfully retrieved |
| data | Form type (single letter) Form count for that type of form If the type of form searched for is not present, but call itself is successful, the value for the <count></count> tag will be "0". |
<response> <data> <forms>
| Field Name | Description |
| item | Specific form ID Form type Form name Owner ID for that form The HTML code |
Unsuccessful Response:
<response> element
| Field Name | Description |
| status | Will return FAILED if call unsuccessful |
| errormessage | Text explaining why request failed |