MAPI Manual

NAME

ADD_AGILE_BYSTENCIL_START

FUNCTION

Add an agile by stencil and start it

SYNOPSIS

agile_title, keep_draft, funtemplate_id, funtemplate_stencil_id, xlabel_id_list, xlabel1...xlabelN, web_address, start_mode

DESCRIPTION

This function allows users to create an agile by stencil and start it.

Required Parameters
* action: ADD_AGILE_BYSTENCIL_START.
* agile_title: title of the agile.
* keep_draft: whether the draft will be saved or not. The value is either "ON" or "OFF". "ON" means the draft will be saved.
* funtemplate_id: the template ID.
* funtemplate_stencil_id: the stencil ID.
* xlabel1...xlabelN: specifies values for the fields of the stencil. The fields are represented in the form of numbered xlabels.
* xlabel_id_list: a list of xlabel IDs for this stencil.

Optional Parameters
* web_address: the web address.
* start_mode: value is either "NORMAL_MODE" or "EXPRESS_MODE". Default is NORMAL_MODE. EXPRESS_MODE will set agile end_date to current_datetime + 5 days.

Below are the xlabels for existing stencils of function templates:

Note: Smart Content can be inserted into the message content in the following tables. Please visit this page to learn more.

Send SMS

Function template ID

100

Function stencil ID

1

xlabel id group

2,3

xlabel_id_list

2_1,3_12

xlabel2

Set the recipient’s mobile number. The number needs to be prefixed with + and country codeEg, +61412345678.

xlabel3

Message content













Send Group SMS

Function template ID

100

Function stencil ID

2

xlabel id group

10,11,12,13

xlabel_id_list

10_1,11_25,12_22,13_10001

xlabel10

Recipient type. Value is 12.

xlabel11

Contact group ID

xlabel12

Mobile column ID

xlabel13

Message content. Include the column name within [%%] to show the value of the column. For example, [%name%] shows the value of the name column. For a list of Smart Content that can be included within this message, please visit this page.


Send Group SMS Repeat

Function template ID

100

Function stencil ID

12

xlabel id group

10,11,12,13,20,21

xlabel_id_list

10_1,11_25,12_22,13_10001,20_1,21_501

xlabel10

Recipient type. Value is 12.

xlabel11

Contact group ID

xlabel12

Mobile column ID

xlabel13

Message content. Include the column name within [%%] to show the value of the column. For example, [%name%] shows the value of the name column. For a list of Smart Content that can be included within this message, please visit this page.

xlabel20

Value is 1

xlabel21

Repeat schedule. For example, if repeating Every 1 days, maximum 5 times From: 2014-09-01 13:00:00 To: 2014-09-10 12:00:00, the value is 00 13 */1 * * * * * 2014-09-01_13:00:00 2014-09-10_12:00:00 5.


Send Group Email

Function template ID

200

Function stencil ID

2

xlabel id group

10,11,12,35,36,37,40,43

xlabel_id_list

10_1,11_25,12_22,35_10002,36_10002,37_1,40_1,43_10112

xlabel10

Recipient type. Value is 12.

xlabel11

Contact group ID

xlabel12

Email column ID

xlabel35

Cc field of the email

xlabel36

Bcc field of the email

xlabel37

Sender email address

xlabel40

Email subject

xlabel43

Email content. Include the column name within [%%] to show the value of the column. For example, [%name%] shows the value of the name column. For a list of Smart Content that can be included within this email, please visit this page.


RETURN DATA

The response contains the following attribute:
* msg: a string indicating an agile has been created and started successfully.

ROLE PERMITTED

Manager

EXAMPLES

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

Request:

http://app02.yvntech.com/MapIHttpS/MapIS?action=ADD_AGILE_BYSTENCIL_START&agile_title=Agile%20sample&keep_draft=ON&funtemplate_id=100&funtemplate_stencil_id=2&xlabel10=12&xlabel11=164&xlabel12=2&xlabel13=Hello%20agile&xlabel_id_list=10_1%2C11_25%2C12_22%2C13_10001&login_name=user@example.com&login_passwd=1111

Response:

<result tftype='1' infotype='0'>
    <field name='msg'>SUCCESS</field>
</result>

TIPS

ENVIRONMENT

AUTHOR

YVN Tech

SEE ALSO

ADD_AGILE_BYSTENCIL, START_AGILE

Mweb v2.0 YVNTECH 2014