Follow

Get Fillin Fields

The Get Fillin Fields command allows you to view a list of all Fillin Fields defined in a specified Template and/or List. The command requires the following arguments: Command, Realm, Password, List, Template, and Output Format.

api_web?r=myrealm&p=mypass&c=getfillinfields&list_id=5&template_id=42&output_format=csv

The command is 'getfillinfields', the realm is 'myrealm', the password is 'mypass', and the format of the returned data is 'csv', returning a list of all Fillin Fields defined in the list '5' and template '42'.  

Example

Using 'getfillinfields' with all commands and arguments:

api_web?r=myrealm&p=mypass&c=getfillinfields&list_id=5&template_id=42&output_format=csv&headers=1

Successful results return:

"Name" ,"Required"
"city","false"
"state","false"
"from address","true"
"from decor","true
"

Results

The Get Fillin Fields command outputs either the results of the search or a FAILURE message. 

Success

The command does not explicitly return a Success code.  Instead, it outputs the Name and Requirement status of each field.  Use the Output Format argument to return the results in an alternate format.

Failure

The command will fail if a List or Template are not defined or invalid. The result format is:

FAILURE: [Reason]

Arguments

This command supports the following arguments:

Name Req? Description Argument
Command Yes

Defines the command to use.

cmd=getfillinfields

c=getfillinfields

Realm Yes Name of the realm to run the command. This is required, and the command will fail if the realm and password do not match.

realm=[realm_name]

r=[realm_name]

Password Yes Authentication code for API access. This is required, and the command will fail if the realm and password do not match.

pwd=[password]

p=[password]

List Identification Yes

ID of the list to display. 

list_id=[list_id]

Template Identification *

ID of the template to display.  Template ID is only required if no Default Template is defined in the list.

template_id=[template_id]

Output Format Yes

To specify the format of the list output, use one of two arguments.

csv=1

OR

output_format=[xml,json,csv,csv_tab,csv_pipe]

Header  

To define the data with a label, use the Header argument.  This argument does not affect the XML or JSON output formats.

headers=[0,1]

DEFAULT==0

 

*Feature released in v12.06.0

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments

Powered by Zendesk