MAPI Manual

NAME

CHECKIN

FUNCTION

User check in by device ID

SYNOPSIS

action: CHECKIN
device_id

DESCRIPTION

This function allows users to check into the current user session. It can be called if the user has already logged into the system.
Both GET and POST methods can be used to perform the request.

Required Parameters

* action: specifies the requested function. Sets to CHECKIN.
* device_id: a unique ID of the device. The system can use it as a key to identify users.

RETURN DATA

For each valid request, the server returns a response in XML format.

Each response will contain the following attributes:
* user_id: a string containing the user ID assigned to the user.
* session_id: a string containing the session ID.
* org_id: a string containing the ID of the organization that the user belongs to.
* role: a string specifying the role of the user within the organization, such as "manager", "admin", "accountmanager" or "root". This field will be used for authorization purposes.
* language: a number indicating language of the system, e.g., "1" representing English.

For an invalid request, the response XML contains the following attribute:
* msg: a string containing the error message.

ROLE PERMITTED

All roles

EXAMPLES

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

Request:
http://app02.yvntech.com/MapIHttpS/MapIS?action=CHECKIN&device_id=mytestid

Response:
<result tftype='1' infotype='0' requestid='LOGIN'>
    <field name='user_id'>6009000</field>
    <field name='session_id'>22838:172.31.28.208:20140627124717:name@example.com</field>
    <field name='org_id'>9000</field>
    <field name='role'>manager</field>
    <field name='language'>1</field>
    <field name='login_name'>name@example.com</field>
    <field name='user_theme'></field>
    <field name='timezone'></field>
</result>

TIPS

ENVIRONMENT

AUTHOR

YVN Tech

SEE ALSO

LOGIN

Mweb v2.0 YVNTECH 2014