Follow

Get Account Profile

The Get Account Profile command allows you to view the Name and Value of each field within a specified profile.

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

api_web?r=myrealm&p=mypass&c=acctprogetprofile&acct_pro_id=5&output_format=csv

The command is 'acctprogetprofile', the realm is 'myrealm', the password is 'mypass'. The ID of the desired profile is '5', and the format of the returned data is 'csv'.

Example

Using 'acctprogetprofile' with all commands and arguments:

api_web?r=myrealm&p=mypass&c=acctprogetprofile&acct_pro_id=5&output_format=csv&headers=1

Successful results return:

"ID","Name","Description","Account Profile Field 1","Account Profile Field 2","Account Profile Field 3" "5","My Profile","My Profile Description","Field Value 1","Field Value 2","Field Value 3" 

Results

The Get Account Profile 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 ID, Name, Description, and Field Values of the specified Account Profile.  Use the Output Format argument to return the results in an alternate format.

The result format is:

"ID","Name","Description","Account Profile Field Name 1","Account Profile Field Name 2","Account Profile Field Name n"
"Account Profile ID","Account Profile Name","Account Profile Description","Field Value 1","Field Value 2","Field Value n"

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=acctprogetprofile

c=acctprogetprofile

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]

Account Profile ID Yes ID of the desired profile. acct_pro_id=[profile_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

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

Comments

Powered by Zendesk