MAPI Manual

NAME

SEARCH_BROADCAST

FUNCTION

Search broadcasts

SYNOPSIS

user_id, broadcast_status_list, keyword_set, ctime_from, ctime_to, order_by, search_limit

DESCRIPTION

This function allows users to search broadcasts.

Required Parameters
* action: SEARCH_BROADCAST.

Optional Parameters
* user_id: ID of the user who creates the broadcast.
* broadcast_status_list: searches the broadcasts for status matching the given status list. The values are separated by a comma, e.g., "sent,pause,draftonly". Special characters must be URL encoded. Below is a complete list of status: 'draft','stop','start','delete','complete','sent','starting','starting_error','pause','draftonly'.  
* keyword_set: searches the broadcasts for titles and descriptions matching the given keyword set.
* ctime_from: the start time. It searches the broadcasts for timestamp between the start time and end time. The time is expressed as "YYYY-MM-DD HH:MM:SS". Special characters must be URL encoded.
* ctime_to: the end time.
* order_by: specifies the list order of the results. The results can be ordered by any column of a broadcast. Default is ordered by the "last_update_dt" in descending order.
* search_limit: imposes a limit on the number of list results. It accepts two formats - either a number or two numbers separated by a comma. For example, if value is "5", the function will return the first five results to users; if value is "5,10", the function will only return the results that are ordered within this range.

RETURN DATA

The response contains the following attributes:
* mcp_broadcast_id: broadcast ID.
* broadcast_title: broadcast title.
* broadcast_description: description of the broadcast.
* mcp_dialogmap_id: ID of the dialog map which the broadcast uses.
* broadcast_rate: the broadcast rate. This imposes a limit on the number of recipients who will receive the broadcast per minute, e.g., "10" means ten recipients. Default is 0, which means no limitations.
* broadcast_priority: priority of the broadcast.
* begin_dt: the start time of the broadcast.
* end_dt: the end time of the broadcast.
* tz_abbr_forschedule: time zone abbreviation for scheduling of the broadcast.
* mcp_schedule_id: ID of the schedule.
* mcp_acl_id: ID of the access control list.
* completedcondition_type: value is "MCPTYPE_NOTASK" or "MCPTYPE_ENDDATE". "MCPTYPE_NOTASK" means the broadcast finishes when no tasks are left. "MCPTYPE_ENDDATE" means the broadcast is due to finish on the specified end date.
* mcp_integration_partner_id: integration partner ID.
* mcp_integration_broadcast_id: integration broadcast ID.
* status: status of the broadcast.
* status_dt: timestamp of the status.
* last_update_dt: timestamp of the last update.
* mcp_destinfo: recipient group of the broadcast.

ROLE PERMITTED

Manager

EXAMPLES

The following example shows a successful HTTP GET request and response.

Request:
http://app02.yvntech.com/MapIHttpS/MapIS?action=SEARCH_BROADCAST&login_name=user@example.com&login_passwd=1111

Response:
<result tftype='1' infotype='0'>
    <resultset name='mcp_broadcast' search_found_rows='105'>
        <row>
            <field name='mcp_broadcast_id'>775</field>
            <field name='broadcast_title'>Find a Worker</field>
            <field name='broadcast_description'>2014-08-25 15:23:14</field>
            <field name='mcp_dialogmap_id'>1396</field>
            <field name='broadcast_rate'>0</field>
            <field name='broadcast_priority'>0</field>
            <field name='begin_dt'>2014-09-09 13:46:47</field>
            <field name='end_dt'>2014-09-14 13:46:47</field>
            <field name='tz_abbr_forschedule'>TZ89</field>
            <field name='mcp_schedule_id'>1</field>
            <field name='mcp_acl_id'>0</field>
            <field name='completedcondition_type'>MCPTYPE_NOTASK</field>
            <field name='mcp_integration_partner_id'>0</field>
            <field name='mcp_integration_broadcast_id'></field>
            <field name='status'>complete</field>
            <field name='status_dt'>2014-09-09 15:51:25</field>
            <field name='last_update_dt'>2014-09-09 13:46:47</field>
            <field name='mcp_destinfo'>new team one</field>
            <field name='ui_icon'>map_template_customer_findaworker_icon.jpg</field>
        </row>
        ...
        ...
    </resultset>
</result>

TIPS

ENVIRONMENT

AUTHOR

YVN Tech

SEE ALSO

GET_BROADCAST_EXPRESS

Mweb v2.0 YVNTECH 2014