...
Return the object definition from the API including the fields, field definitions and available actions for the object.
| Code Block |
|---|
| theme | Eclipse |
|---|
| language | php | theme | Eclipse |
|---|
| linenumbers | true |
|---|
|
array(
"token" => $token,
"tokenHash" => $tokenHash,
"objectType" => "events",
"objectAction" => "define"
) |
| Code Block |
|---|
| theme | Eclipse |
|---|
| language | php | theme | Eclipse |
|---|
| linenumbers | true |
|---|
|
Array
(
[status] => ok
[messages] => Array
(
[generalMessages] => Array
(
)
[recordMessages] => Array
(
)
)
[data] => Array
(
[actions] => Array
(
[define] => Array
(
[modules] => Array
(
[0] => Events
)
[permissions] => Array
(
[0] => Volunteer
)
)
// Additional actions would be here...
)
[fields] => Array
(
[eventID] => Array
(
[name] => eventID
[friendlyname] => ID
[type] => key
[lengthMax] =>
[lengthMin] =>
[default] =>
[properties] => Array
(
)
)
// Additional fields would be here...
)
)
) |
...
Return the specified information about a specific record.
| Code Block |
|---|
| theme | Eclipse |
|---|
| language | php | theme | Eclipse |
|---|
| linenumbers | true |
|---|
|
array (
"token" => $token,
"tokenHash" => $tokenHash,
"objectType" => "locations",
"objectAction" => "view"
"values" => array(
[0] => array(
"locationID" => "4668"
),
[1] => array(
"locationID" => "5227"
)
),
"fields" => array("locationID", "locationName", "locationPostalcode")
) |
...
| Info |
|---|
| title | List() is limited to 500 rows |
|---|
|
Most list() actions are limited to 500 rows. If you need to return more than 500 rows you should use the search() method. |
| Code Block |
|---|
| theme | Eclipse |
|---|
| language | php | theme | Eclipse |
|---|
| linenumbers | true |
|---|
|
array (
"token" => $token,
"tokenHash" => $tokenHash,
"objectType" => "species",
"objectAction" => "list"
) |
| Code Block |
|---|
| theme | Eclipse |
|---|
| language | php | theme | Eclipse |
|---|
| linenumbers | true |
|---|
|
Array
(
[status] => ok
[messages] => Array (
[generalMessages] => Array ( )
[recordMessages] => Array ( )
)
[data] => Array (
[species] => Array (
[Alpacas] => Array (
[name] => Alpacas
[singular] => Alpacas
[plural] => Alpacas
[singularYoung] => Alpacas
[pluralYoung] => Alpacas
)
[Birds] => Array (
[name] => Birds
[singular] => Birds
[plural] => Birds
[singularYoung] => Birds
[pluralYoung] => Birds
),
[Cats] => Array (
[name] => Cats
[singular] => Cats
[plural] => Cats
[singularYoung] => Cats
[pluralYoung] => Cats
)
// More species included here...
)
)
) |
...
Many objects have associated settings that can be retrieved and set. The updateSettings action is the same for each of them.
| Code Block |
|---|
| theme | Eclipse |
|---|
| language | php | theme | Eclipse |
|---|
| linenumbers | true |
|---|
|
$data = array(
"token" => $token,
"tokenHash" => $tokenHash,
"objectType" => "animalsAdoptions",
"objectAction" => "updateSettings",
"values" => array(
array(
"showAppPending" => "Yes",
),
),
); |
