This method returns the list of fields in the constituent record that can be viewed or changed by the caller. If include_choices is true, then it will return choices with each field when they are available. If sort_order is "group", then it will return field sorted by group information.
| Client Servlet | Server Servlet | HTTP Methods Supported | Requires Authentication |
|---|---|---|---|
| CRConsAPI | SRConsAPI | GET, POST | Server. |
This method provides detailed information about each of the fields available to the calling user. The elements within each field element of the response document include:
The possible values for the valueType element are:
See topic Common Parameters.
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.
Type xsd:string.
Default is view.
Optional. The flag to indicate whether or not each textfield contains choice information.
Type xsd:boolean.
Default is false.
Optional. Specifies the order of the records. If the value is "field", then response will be sorted alphabetically in field name. If the value is "group", then response will be sorted by group.
Type xsd:string.
Default is field.
See topic Common Parameters.
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.
Type xsd:string.
Default is view.
Optional. The flag to indicate whether or not each textfield contains choice information.
Type xsd:boolean.
Default is false.
Optional. Specifies the order of the records. If the value is "field", then response will be sorted alphabetically in field name. If the value is "group", then response will be sorted by group.
Type xsd:string.
Default is field.
See topic HTTP Status Codes.
XML response
<?xml version="1.0" encoding="UTF-8"?>
<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>
<label>Text Field Label</label>
<name>text_field</name>
<required>true</required>
<maxChars>255</maxChars>
<choices>
<choice>Choice Label One</choice>
<choice>Choice Label Two</choice>
</choices>
<group>Group Label</group>
<groupOrder>3</groupOrder>
<subGroup>Sub Group Label</subGroup>
<subGroupOrder>1</subGroupOrder>
<valueType>TEXT</valueType>
<isSensitive>false</isSensitive>
<requiredForUser>true</requiredForUser>
<isUserModifiable>true</isUserModifiable>
</field>
<field>
<label>Number Field Label</label>
<name>number_field</name>
<required>false</required>
<group>Group Label</group>
<subGroup>Sub Group Label</subGroup>
<groupOrder>2</groupOrder>
<valueType>NUMBER</valueType>
<isSensitive>false</isSensitive>
<requiredForUser>false</requiredForUser>
<isUserModifiable>true</isUserModifiable>
</field>
<field>
<label>Boolean Field Label</label>
<name>boolean_field</name>
<required>false</required>
<valueType>BOOLEAN</valueType>
<isSensitive>false</isSensitive>
<requiredForUser>false</requiredForUser>
<isUserModifiable>true</isUserModifiable>
</field>
<field>
<label>Enum Field Label</label>
<name>enum_field</name>
<required>false</required>
<valueType>ENUMERATION</valueType>
<isSensitive>false</isSensitive>
<requiredForUser>false</requiredForUser>
<isUserModifiable>false</isUserModifiable>
</field>
<field>
<label>Money Field Label</label>
<name>money_field</name>
<required>false</required>
<valueType>MONEY</valueType>
<isSensitive>false</isSensitive>
<requiredForUser>false</requiredForUser>
<isUserModifiable>false</isUserModifiable>
</field>
<field>
<label>Date Field Label</label>
<name>date_field</name>
<required>false</required>
<valueType>DATE</valueType>
<isSensitive>false</isSensitive>
<requiredForUser>false</requiredForUser>
<isUserModifiable>true</isUserModifiable>
</field>
</listConsFieldsResponse>
JSON response
{"listConsFieldsResponse":{"field":[{"isUserModifiable":"true","maxChars":"255","choices":{"choice":["Choice Label One","Choice Label Two"]},"label":"Text Field Label","requiredForUser":"true","name":"text_field","groupOrder":"3","subGroupOrder":"1","subGroup":"Sub Group Label","valueType":"TEXT","isSensitive":"false","required":"true","group":"Group Label"},{"isUserModifiable":"true","requiredForUser":"false","groupOrder":"2","name":"number_field","valueType":"NUMBER","subGroup":"Sub Group Label","label":"Number Field Label","isSensitive":"false","group":"Group Label","required":"false"},{"isUserModifiable":"true","requiredForUser":"false","name":"boolean_field","valueType":"BOOLEAN","label":"Boolean Field Label","isSensitive":"false","required":"false"},{"isUserModifiable":"false","requiredForUser":"false","name":"enum_field","valueType":"ENUMERATION","label":"Enum Field Label","isSensitive":"false","required":"false"},{"isUserModifiable":"false","requiredForUser":"false","name":"money_field","valueType":"MONEY","label":"Money Field Label","isSensitive":"false","required":"false"},{"isUserModifiable":"true","requiredForUser":"false","name":"date_field","valueType":"DATE","label":"Date Field Label","isSensitive":"false","required":"false"}]}}