Vision 6

getFolderIdForField

Returns the Folder ID for a File type Field in a List.

getFolderIdForField

Returns the Folder ID for a File type Field in a List.

Top ↑

Syntax

int getFolderIdForField( int api_key, int list_id, int field_id );

Parameters

api_key (int)

The key required to access the API. See Getting Started for more information.

list_id (int)

The list ID of the Field.

field_id (int)

The ID of the Field to get Folder ID for.

Return Value

Returns the Folder ID for the Field on success.

Examples

PHP

$list_id = 456789;      // See searchLists()
$field_id = 1234567;

$api = new Api($url, 'YOURAPIKEY');
$api->invokeMethod('getFolderIdForField', $list_id, $field_id);

JSON Request

{
    "id": 1,
    "method": "getFolderIdForField",
    "params": [
        "YOURAPIKEY",
        456789,
        1234567
    ]
}

JSON Response

{
    "id": 1,
    "result": 234567,
    "error": null
}

Error Codes

This method may return the following error codes in addition to the standard error codes:

Code Error Description
303 Unable to Load List list_id is not a valid List
313 Cannot Edit Account Lists list_id is an account List
315 Field Not Found field_id is not a valid Field in the List

See Also