listUserFields

This method returns a list of the constituent record fields that can be viewed or changed by the caller. Use this method to list user fields when calling from a Web Client.

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/CRConsAPI.  Here you'll notice that demo-secure.convio.net is used for the domain, and demo829 is used for the organization. 

Authentication

The methods available from a web client do not require authentication of the caller.

Parameters

The parameters for this method include all user fields that can be viewed or updated by the caller, plus 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 API use the value "listUserFields"

response_format

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

redirect

Optional. Specifies a URL redirect to send back to the browser after processing.

access

Optional. Specifies the type of constituent record access for which to list the available fields. If the value is "view" then the response includes fields that the caller can view. If the value is "update" then the response includes fields that the caller can change. The default value is "view".

Code Examples

 

Response

The HTTP status code is 200. 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: 
<listConsFieldsResponse 
  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">


<field>
   <name>accepts_postal_mail</name>
   <label>Accept Mail</label>
   <valueType>BOOLEAN</valueType>
</field>
<field>
   <name>name.first</name>
   <label>First Name</label>
   <valueType>TEXT</valueType>
   <maxChars>50</maxChars>
</field>
...


</listConsFieldsResponse>

 

JSON format: 
{"listConsFieldsResponse":{"field":[{
"valueType":"BOOLEAN","label":"Accept Mail",
"name":"accepts_postal_mail"},
{"valueType":"TEXT","label":"First Name",
"maxChars":"50","name":"name.first"},...]}}

 

Elements within a "field" element:

  • name  - this is the name of the HTTP parameter to use to set the field in a request to create or update a constituent. Dots in the name reflect the structure of nested elements in the response to a request to get a constituent's record.
  • label - this is what the Convio system uses as a field label when presenting the field in its UI.
  • value type - indicates the type of data in the field which will be one of the following:

Type

Description

BOOLEAN

These fields have a value of "true" or "false".

DATE

These fields have a date and time value formatted as defined by the XML Schema specification, which is derived from the ISO 8601 specification. This format has a date part, a time part, and a time zone part. If the time zone part is omitted, then the time zone configured for the site is used. If the time part is omitted, then the time is set to the beginning of the day (00:00:00) in the time zone used.

ENUMERATION

These fields have a finite set of possible values which are specified in the XML Schema document.

MONEY

These fields have monetary values that are formatted as currency using the site's configured locale information.

NUMBER

These fields have integer values with no formatting (no punctuation such as commas or points).

TEXT

These fields have text strings.

  • maxChars - for "TEXT" type fields, this indicates the maximum number of characters that can be stored.

See the complete list of HTTP Status codes and Error codes for calling from a Web Client.
 

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

Community