acl-field-info

Availability

Breeze 5, Connect Enterprise Web Services 6

Description

Returns information about a principal, account, or SCO, as defined in an access control list (ACL).

The returned information includes fields and their values. Each field has an ID--a name that describes the field.

To call acl-field-info, you must have view permission for the principal, account, or object. You must also specify a value for acl-id, which is the object the principal has access to. The acl-id can be a sco-id, an account-id, or a principal-id. You can call principal-list to determine the account-id or principal-id, or sco-shortcuts or sco-contents to get a sco-id.

Request URL

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

Parameters

Name	Type	Required	Description
`acl-id`	Integer	Y	The ID of the SCO, account, or principal for which you want field information. Can be a valid `sco-id`, `account-id`, or `principal-id`.
`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-fields>
        <field acl-id=integer field-id=string>
            <value>string</value>
        </field>
        ... 
    </acl-fields>
</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-fields`		Container	Information about all fields describing the principal, account, or object.
`field`		Container	One field describing the principal, account, or object.
	`acl-id`	Integer	The `acl-id` specified in the request, which is a `sco-id`, `principal-id`, or `account-id`.
	`field-id`	String	The name of the field.
`value`		String	The value of the field.

Sample request

https://example.com/api/xml?action=acl-field-info&acl-id=2006258745

Sample response

<?xml version="1.0" encoding="utf-8" ?> 
<results> 
    <status code="ok" /> 
    <acl-fields> 
        <field acl-id="2006258745" field-id="email"> 
            <value>joy@acme.com</value> 
        </field> 
        <field acl-id="2006258745" field-id="first-name"> 
            <value>Joy</value> 
        </field> 
        <field acl-id="2006258745" field-id="last-name"> 
            <value>Smith</value> 
        </field> 
    </acl-fields> 
</results>