acl-field-list

Availability

Breeze 5; Connect Enterprise Web Services 6

Description

Returns a list of values for all instances of a field name on your Enterprise Server or in your Enterprise Hosted account.

For example, to list the first names of all users in the account, call acl-field-list with
field-id=first-name.

You can call acl-field-info first to get a list of field names.

Request URL

http://server_name/api/xml
    ?action=acl-field-list
    &field-id=string
    &session=BreezeSessionCookieValue

Parameters

Name	Type	Required	Description
`field-id`	String	Y	The name of a field in the access control list for which you want values and IDs. Only one field name is allowed.
`session`	String	N	The value of the `BREEZESESSION cookie`. Use this parameter if you do not use a client-side cookie management library.

Filters

Results cannot be filtered or sorted.

Response structure

<?xml version="1.0" encoding="utf-8" ?> 
<results> 
    <status code=allowedValue /> 
    <acl-field-list> 
        <acl acl-id=integer> 
            <value>string</value> 
        </acl>
        ...
    </acl-field-list>
</results

Response values

Element	Attribute	Type	Description
`results`		Container	All results the action returns.
`status`		Empty, with attributes	The status of the response.
	`code`	Allowed value	A code indicating the response status (see status).
`acl-field-list`		Container	Information about all of the values in the account for the specified field.
`acl`		Container	Information about one value for the specified field.
	`acl-id`	Integer	The ID of the principal, SCO, or account the field belongs to.
`value`		String	The value of the field.

Sample request

https://example.com/api/xml?action=acl-field-list&field-id=first-name

Sample response

<?xml version="1.0" encoding="utf-8" ?>
<results>
    <status code="ok"/>
    <acl-field-list>
        <acl acl-id="381223">
            <value>John</value>
        </acl>
        <acl acl-id="381302">
            <value>Daryl</value>
        </acl>
        <acl acl-id="381405">
            <value>Mary</value>
        </acl>
    </acl-field-list>
</results>