Follow

Get All Account Profile Fields

The Get All Account Profile Fields command allows you to view a list of Names of all account profile fields.

The Get All Account Profile Fields command requires the following arguments: Command, Realm, Password and Output Format.

api_web?r=myrealm&p=mypass&c=acctprogetfields&output_format=csv

The command is 'acctprogetfields', the realm is 'myrealm', the password is 'mypass', and the format of the returned data is 'csv'.

Example

Using 'acctprogetfields' with all commands and arguments:

api_web?r=myrealm&p=mypass&c=acctprogetfields&output_format=csv&headers=1

Successful results return:

"acct_pro_city"
"acct_pro_contactemail"
"acct_pro_contactname"
"acct_pro_logo"
"acct_pro_name"
"acct_pro_url"

Results

The Get All Account Profile 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 of each Account Profile Field.  Use the Output Format argument to return the results in an alternate format.

Failure

The command will fail if an Output Format is not specified or invalid data is defined. 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=acctprogetfields

c=acctprogetfields

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]

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

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

Comments

Powered by Zendesk