listUserFieldChoices

This method returns a list of the possible values for a constituent record field. Use this method to list possible values for a constituent record field when calling from another application or server.

Post URL

Deconstructing the URL
* In most cases secure2.convio.net matches a client's secure domain.  However, in some cases this will be different.  If your organization uses Convio for fundraising, the correct secure domain for the API is identical to the secure domain for your fundraising forms.  So if the sample above does not work, look for the unique secure domain used for your organization and replace the secure2.convio.net portion above with this URL. 

*Here, organization is a client's unique identifier in the Convio system.  Every client has a unique value that represents their instance of the product. If you're organization uses a custom secure URL for donations, the organization portion of the URL may not be necessary, contact support for assistance.

Example: https://demo-secure.convio.net/demo829/site/SRConsAPI.  Here you'll notice that demo-secure.convio.net is used for the domain, and demo829 is used for the organization. 

Authentication

Authenticating Convio Server API calls is a three stage process. First, the IP address of the server invoking the API call will be checked against the list of allowed IP ranges, per the Convio Site Configuration parameters. If the API is being invoked from a server in the allowed IP range, then the login_name and login_password parameters will be used to login to the Convio site. Finally, once the login credentials have been verified, the account specified by the login credentials will be examined to ensure that it has the Contact Management “Use Convio API” permission. If all the above hold, the caller will be authenticated and the API call will proceeed. If any of the above fail, then the call will not be authenticated and an error message will be returned.

Parameters

The parameters for this method include the following:

Name

Description

api_key Required. An arbitrary value that must be passed when invoking the Convio Client and Server APIs. The value passed by the caller must match the value in the CONVIO_API_KEY site configuration parameter, which is unique for each Convio site.
v Required. API version to invoke. Must be "1.0".

method

Required. Specifies which method to perform. To invoke this method use the value "listUserFieldChoices"

response_format

Optional. Specifies the format in which to return the response. Can be either "xml" (the default value) or "json".

login_name Required. Specifies the user name of the account to authenticate.
login_password Required. Specifies the password of the account to authenticate.

field

Required. Specifies the name of the constituent field for which to return the possible values.

 

Response

The HTTP status code of 200 indicates a successful invocation. The response is formatted as XML by default, but the response_format input parameter can be used to specify either XML or JSON formatting. A successful invocation might appear as follows:

XML format: 
<listConsFieldChoicesResponse 
  xsi:schemaLocation=http://convio.com/crm/v1.0
  http://service.convio.net/xmlschema/crm.public.v1.xsd
  xmlns="http://convio.com/crm/v1.0"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">


<choice>Mr.</choice>
<choice>Ms.</choice>
<choice>Mrs.</choice>
<choice>Dr.</choice>


</listConsFieldChoicesResponse>

 

JSON format: 
{"listConsFieldChoicesResponse":{"choice":["Mr.","Ms.","Mrs.","Dr."]}}

 

Errors

After an error occurs during processing, the structure of the response is an "errorResponse" element. It contains two other elements: a "code" element and a "message" element. The "code" element contains a number corresponding to the error conditions documented on the error code list page. The "message" element contains a text message that may provide further detail about the error.

XML format: 

<errorResponse
  xsi:schemaLocation=http://convio.com/crm/v1.0
  http://service.convio.net/xmlschema/crm.public.v1.xsd
  xmlns="http://convio.com/crm/v1.0"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">


<code>18</code>
<message>The specified field does not exist.</message>


</errorResponse>

 

JSON format: 
{"errorResponse":{"code":"18",
"message":"The specified field does not exist."}}

 

See the complete list of HTTP Status codes and Error codes for calling from another application.
 

Client Community
Log in to chat with other clients and partners using APIs and share code snippets.

Community