listUserFieldChoices

This method returns a comma-separated list of the valid values for a given field in the constituent record, if a list of valid values is defined. For fields which do not have a range of predefined values, this method returns an empty result set. For Date attributes, this method returns a list of valid Years.

Client Servlet	Server Servlet	HTTP Methods Supported	Requires Authentication
CRConsAPI	SRConsAPI	GET, POST	Server.

Client API Syntax

https://secure2.convio.net/organization/site/CRConsAPI?method=listUserFieldChoices &api_key=value &v=value [ &center_id=value ] [ &error_redirect=value ] [ &redirect=value ] [ &response_format=xml | json ] [ &sign_redirects=value ] [ &source=value ] [ &sub_source=value ] [ &success_redirect=value ] [ &suppress_response_codes=value ] &field=value

Server API Syntax

https://secure2.convio.net/organization/site/SRConsAPI?method=listUserFieldChoices & api_key =value & login_name =value & login_password =value & v =value [ & center_id =value ] [ & response_format =xml |json ] [ & source =value ] [ & sub_source =value ] [ & suppress_response_codes =value ] & field =value

Client API Parameters

Common Client Parameters

See topic Common Parameters.

field

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

Type xsd:string.

Server API Parameters

Common Server Parameters

See topic Common Parameters.

field

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

Type xsd:string.

Response

See topic HTTP Status Codes.

XML response

<?xml version="1.0" encoding="UTF-8"?>
<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>Miss</choice>
  <choice>Dr.</choice>
</listConsFieldChoicesResponse>

JSON response

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

Luminate Online