actions_tagger_get_label Class Reference

A REST HTTP action for retrieving a tag's label given information about the source record and tagger field. More...

Public Member Functions
	handle ($params)
	Handles HTTP request.
	out ($params)
	Outputs JSON given a data structure input.

---

Detailed Description

A REST HTTP action for retrieving a tag's label given information about the source record and tagger field.

This action takes the following GET parameters:

Parameters:

string	-table The source table name.
string	-src-record-id Optional source record id.
string	-field The name of the source table's field (i.e. the field using the tagger widget).
string	-record-id The id of the target record.

Returns:

This action will return a JSON object with the following structure:

 {
                code: <int>                     // The response code.  200 for success.
                message: <string>               // The response message.
                recordID: <string>              // The record ID of the target record (i.e. the record that is represented by the tag).
                label: <string>                 // The associated tag label for the record.
  }

Definition at line 42 of file tagger_get_label.php.

---

Member Function Documentation

handle

(

$

params

)

Handles HTTP request.

Definition at line 46 of file tagger_get_label.php.

out

(

$

params

)

Outputs JSON given a data structure input.

Definition at line 184 of file tagger_get_label.php.

---

The documentation for this class was generated from the following file:

• actions/tagger_get_label.php