SOAP API method Database_orderedField
Description
In a database one field can be assigned to be 'ordered by default'. When the database is displayed, the profiles will be displayed ordered on this field. This method returns the field that is ordered by default, or false if no field was assigned.
Parameters
| Name | Type | Description |
|---|---|---|
| id * | int | Unique identifier (id) of the object Database. The method only applies to the database with this id. |
| login | Structure of type 'login' | Optional login data (soon deprecated) |
| access_token | string | Optional api access token |
| * required parameters | ||
Return values
| Name | Type | Description |
|---|---|---|
| field | Structure of type 'field' |
Structure 'login'
| Name | Type | Description |
|---|---|---|
| username | string | The username of the login attempt |
| account | string | The account name of the login attempt |
| password | string | The password for the login attempt |
Structure 'field'
| Name | Type | Description |
|---|---|---|
| id | int | The ID of the field. |
| name | string | The name of the field. |
| big | boolean | Is this field a big field?. |
| pixelwidth | int | The width of this field. |
| weight | int | The weight of this field. |
| type | string | The type of this field. |
| value | string | The default value of this field. |
| specialcontent | string | The special content of this field. |
| ordered | boolean | Is this the field that we order by by default? |
| displayed | boolean | Is this field displayed? |
| indatatable | boolean | Is this field added to the data table? |
| length | integer | Get the length of the field |
| lines | integer | Get the number of lines in this field |
| hidden | boolean | Is this field hidden? |
| index | boolean | Is this field indexed? |