Search Field

Users can retrieve all custom fields and field groups owned by an agency or branch. Users with branch-level authorization for retrieve are permitted to retrieve fields owned by their agency. The response provides pagination. If a max number of fields is returned in a given response, then the user can request “more.”

Request

1. Users specify the ID of the agency or branch for which they want to retrieve fields or field groups. When requesting branch-owned fields, the user may optionally request to also include all agency-owned fields in the same request.

2. For pagination, the user may additionally specify the following:

• The maximum number of records to be returned per request.

Note: If the user does not specify a maximum, the system-defined default (as defined in the schema) is used.

• The record number to start from in case the request is not starting from the beginning. For example, a follow-on request may set StartFromResult=50.

• Whether to include the fields owned by the parent profile too.

Searching for fields with parameters is not supported (e.g., users cannot search by name or description). The retrieve/search message returns all fields of the requested owner.  

Note: It is possible that, in the future, search by parameters could be provided, so keep in mind during design.

Response

For stand-alone fields, all attributes of the field are returned. Currently, these attributes include:

• Unique ID (system generated) of the field

• Owner of the field

• Name of field

• Description of the field

• Data Type of field

• Default Value of field

• Min Length of field

• Max Length of field

• Min Value of field

• Max Value of field

• The field's Immutable property

• Inheritability property

For a field within a group, the response also returns the following:

• Minimum number of occurrences permitted within the group

• Maximum number of occurrences permitted within the group

For a field group, all attributes of the group are returned. Currently, these attributes include:

• Unique ID (system generated) of the field group

• Name of the group

• Description of the group (optional)

• Whether the group is immutable

• Its child fields and all their details

For pagination, an additional attribute is returned to specify whether or not more results are available.

Retrieves the field and field group details based on ID provided. The ID can be a field ID or the field group ID.