MAPI Manual

NAME

ADDSIGNUP

FUNCTION

User sign up

SYNOPSIS

DESCRIPTION

This function allows users to sign up for the system, with the option to send notifications for verification purposes.

Required Parameters

* action: ADDSIGNUP.

* signup_productname: ID of the organization that the new user will be signed up.

* signup_code: authentication code for the organization.

* signup_firstname: firstname of the user.
* signup_lastname: lastname of the user.
* signup_loginname: login name of the user. Must use a valid email address.
* signup_mobile: mobile number. Must use a valid mobile number. Plus sign and country code must be added. E.g., +61412345678.
* signup_passwd: user password.
* signup_language: user language. For more information about the languages supported by the system, see LIST_LANGUAGES.

* signup_location: user's location information. For more information about the countries, see LIST_LOCATIONS.
* signup_tzabbr: user's time zone information. The time zone must be in abbreviated format, e.g., "TZ89" stands for Australian Eastern Standard Time. For more information, see LIST_TIMEZONES.

* login_name: the account used for signing up a user.
* login_passwd: the password of the account used for signing up a user.

Optional Parameters

* notify_channel: value is "sms" or "email". It specifies the channel through which the notification is sent. If channel is set to "sms", the sms_content parameter must be provided; otherwise, email_content must be provided.
* email_subject: the email subject.
* email_content: the email body. It must include "[%email_checkcode%]" which will be replaced by a string of characters and numbers and will be used for email verification. It can include "[%first_name%]" and "[%last_name%]" which will be replaced by the user's firstname and lastname respectively. Special characters must be URL encoded. This parameter is required for email.
* from_email: email address of the sender.
* sender_name: name of the sender of the email.
* email_cc: Cc field of the email.
* email_bcc: Bcc field of the email.
* sms_content: body of the Sms text. It must include "[%sms_checkcode%]" which will be replaced by a string of characters and numbers and will be used for Sms verification. It can include "[%first_name%]" and "[%last_name%]" which will be replaced by the user's firstname and lastname respectively. Special characters must be URL encoded. This parameter is required for Sms.

* from_mobile: Sender number.

RETURN DATA

The response contains the following attributes:
* signup_id: new user ID.
* email_checkcode: a string of numbers and characters. Used for email verification.

* sms_checkcode: a string of numbers. Used for SMS verification.

ROLE PERMITTED

EXAMPLES

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

Request:

http://app02.yvntech.com/MapIHttpS/MapIS?action=ADDSIGNUP&signup_productname=9000&signup_code=9999&signup_firstname=stephen&signup_lastname=smith&signup_loginname=name@example.com&signup_mobile=+6140000000&signup_passwd=12345&signup_language=en&signup_location=sydney&signup_tzabbr=TZ89&notify_channel=email&email_subject=SignUp&email_content=%5B%25first_name%25%5D+%5B%25last_name%25%5D+Your+code+is+%5B%25email_checkcode%25%5D&from_email=account@yvntech.com&sender_name=Mweb&login_name=signup_account@yvntech.com&login_passwd=1111

Response:

<result tftype='1' infotype='0'>
    <field name='signup_id'>21</field>
    <field name='email_checkcode'>33c7fd308af4067a4b343a0654dd822c</field>
    <field name='sms_checkcode'>3759</field>
</result>

TIPS

ENVIRONMENT

AUTHOR

YVN Tech

SEE ALSO

LIST_TIMEZONES, LIST_LANGUAGES, LIST_LOCATIONS

Mweb v2.0 YVNTECH 2014