owndefinedparameters

List Own defined fields

Lists Own defined fields that has a "Parametername in API" an can be used on persons. Own defined fields can be created at Back Office > Persons > Own defined fields, read more Own defined fields

Request

HTTP GET /owndefinedparameters

Example:

APIURL/owndefinedparameters.xml?apikey=33893457438

Response

Tag	Date type	Example	Description

Tag	Date type	Example	Description
owndefinedparameters		<owndefinedparameters>	Owndefinedparameters-tag
id	ID	<id>3</id>	Inique ID for the field
name	String	<name>field_favvofarg</name>	Name of field
caption	String	<caption>Favorite color</caption>	Name of field
type	String	<type>List</type>	Type of field. The available types are: 'String', 'DecimalNumber', 'Date', 'List', 'Boolean', 'DateInterval', 'MultipleSelectionsList', 'TextArea'
isforperson	Boolean	<isforperson>true</isforperson>	If used on person
required	Boolean	<required>true</required>	Required field
sortorder	Integer	<sortorder>4</sortorder>	Sort order
selectablevalues		<selectablevalues>	Available choices if the type is list or multilist
id	ID	<id>4</id>	Unique ID for selection
text	String	<text>Blue</text>	Name of selection

<owndefinedparameters>
  <owndefinedparameter>
    <id>47</id>
    <name>field_favorite_color</name>
    <caption>Favorite color</caption>
    <type>List</type>
    <isforperson>true</isforperson>
    <required>true</required>
    <sortorder>4</sortorder>
    <selectablevalues>
      <selectablevalue>
        <id>4</id>
        <text>Red</text>
      </selectablevalue>
      <selectablevalue>
        <id>5</id>
        <text>Blue</text>
      </selectablevalue>
    </selectablevalues>
  </owndefinedparameter>
  <owndefinedparameter>
    <id>42</id>
    <name>field_middlename</name>
    <caption>Middle name</caption>
    <type>String</type>
    <isforperson>true</isforperson>
    <required>true</required>
    <sortorder>5</sortorder>
  </owndefinedparameter>
  ...
</owndefinedparameters>