1. Introduction

For all methods below adminAuthenticationDetails contains administrator user name & password. Administrator must have permissions to make changes on users for specific user types.
Always <userPIN xsi:nil=”true”/>

2. signUp

wsUserTmResponse signUp(adminAuthenticationDetails,
regUser,sendWelcomeEmail)

• adminAuthenticationDetails – An object that includes administrator user name & password.
• regUser – see section IV for object description.
• sendWelcomeEmail – Boolean that simple if to send welcome email.
Always <userPIN xsi:nil=”true” />

Example
<soapenv:Envelope
xmlns:soapenv=”http://schemas.xmlsoap.org/soap/envelope/”
xmlns:xsd=”http://www.w3.org/2001/XMLSchema”
xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance”>
<soapenv:Body>
<signUp xmlns=”http://localhost:8080/tmtypes”>
<AuthenticationDetails_1 xmlns=””>
<userLogin> administrator </userLogin>
<userPIN xsi:nil=”true” />
<userPassword>***********</userPassword>
</AuthenticationDetails_1>
<User_2 xmlns=””>
<businessPhone xsi:nil=”true” />
<country>US</country>
<email>test@user.com</email>
<fax xsi:nil=”true” />
<firstName>Misha</firstName>
<homePhone xsi:nil=”true” />
<identificationNumber xsi:nil=”true” />
<language>en</language>
<lastName>Grin</lastName>
<middleName xsi:nil=”true” />
<mobilePhone>972540032618</mobilePhone>
<password xsi:nil=”true” />
<timeZone>GMT</timeZone>
<type>147</type>
<uniqueCustomerCode xsi:nil=”true” />
<userName>972540032618</userName>
</User_2>
<boolean_3 xmlns=””>true</boolean_3>
</signUp>
</soapenv:Body>
</soapenv:Envelope>

3. updateUserLogin

tmResponse updateUserLogin(adminAuthenticationDetails,
oldUserAuthenticationDetails, newUserAuthenticationDetails)

• adminAuthenticationDetails – An object that includes administrator user name & password.
• oldUserAuthenticationDetails – An object that includes the user to whom the username and/or mobile device need to be changed.
• newUserAuthenticationDetails – A user object which contains a username and/or mobile device to be changed. Rest of the fields may be empty (=nil).
Always <userPIN xsi:nil=”true” />

Example
<?xml version=”1.0″ encoding=”UTF-8″?>
<soapenv:Envelope xmlns:soapenv=”http://schemas.xmlsoap.org/soap/envelope/” xmlns:xsd=”http://www.w3.org/2001/XMLSchema” xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance”>
<soapenv:Body>
<updateUser xmlns=”http://localhost:8080/tmtypes”>
<AuthenticationDetails_1 xmlns=””>
<userLogin> administrator </userLogin>
<userPIN xsi:nil=”true” />
<userPassword>***********</userPassword>
</AuthenticationDetails_1>
<AuthenticationDetails_2 xmlns=””>
<userLogin>972540032618</userLogin>
<userPIN xsi:nil=”true” />
<userPassword>***********</userPassword>
</AuthenticationDetails_2>
<User_3 xmlns=””>
<businessPhone xsi:nil=”true” />
<country xsi:nil=”true” />
<email xsi:nil=”true” />
<fax xsi:nil=”true” />
<firstName xsi:nil=”true” />
<homePhone xsi:nil=”true” />
<identificationNumber xsi:nil=”true” />
<language xsi:nil=”true” />
<lastName xsi:nil=”true” />
<middleName xsi:nil=”true” />
<mobilePhone xsi:nil=”true” />
<password>3</password>
<timeZone xsi:nil=”true” />
<type>0</type>
<uniqueCustomerCode xsi:nil=”true” />
<userName>972540032619</userName>
</User_3>
</updateUser>
</soapenv:Body>
</soapenv:Envelope>

4. changeUserStatus

tmResponse changeUserStatus(adminAuthenticationDetails, userLogin, status)

• adminAuthenticationDetails – An object that includes administrator user name & password.
• userLogin – The user name for user we want to change his status.
• status. – requested new status

    i. suspended – short value “2”
    ii. activated – short value “1”
    iii. lock – short value “8”
    iv. deleted – short value “4”

Always <userPIN xsi:nil=”true” />

Example
<soapenv:Envelope xmlns:soapenv=”http://schemas.xmlsoap.org/soap/envelope/” xmlns:tmt=”http://localhost:8080/tmtypes”>
<soapenv:Header/>
<soapenv:Body>
<tmt:changeUserStatus>
<AuthenticationDetails_1>
<userLogin> administrator </userLogin>
<userPIN xsi:nil=”true” />
<userPassword>***********</userPassword>
</AuthenticationDetails_1>
<String_2>38970300000</String_2>
<short_3>4</short_3>
</tmt:changeUserStatus>
</soapenv:Body>
</soapenv:Envelope>

————————————————————–
<short_3>4</short_3> – to delete user
<short_3>2</short_3> – to suspend user
<short_3>8</short_3> – to lock user
<short_3>1</short_3> – to activate (after suspend or lock) user
————————————————————–

5. getReportNames

ReportNamesResponse getReportNames(authenticationDetails)

• authenticationDetails – An object that includes administrator user name & password.

Example – Request
<?xml version=”1.0″ encoding=”UTF-8″?>
<soapenv:Envelope xmlns:soapenv=”http://schemas.xmlsoap.org/soap/envelope/” xmlns:xsd=”http://www.w3.org/2001/XMLSchema” xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance”>
<soapenv:Body>
<getReportNames xmlns=”http://localhost:8080/tmtypes”>
<AuthenticationDetails_1 xmlns=””>
<userLogin> administrator </userLogin>
<userPIN xsi:nil=”true”/>
<userPassword>xxxxx</userPassword>
</AuthenticationDetails_1>
<int_2 xmlns=””>0</int_2>
</getReportNames>
</soapenv:Body>
</soapenv:Envelope>

Example – Response
<?xml version=”1.0″ encoding=”UTF-8″?>
<env:Envelope xmlns:env=”http://schemas.xmlsoap.org/soap/envelope/” xmlns:xsd=”http://www.w3.org/2001/XMLSchema” xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance” xmlns:enc=”http://schemas.xmlsoap.org/soap/encoding/” xmlns:ns0=”http://localhost:8080/tmtypes”>
<env:Body>
<ns0:getReportNamesResponse>
<result>
<statusCode>0</statusCode>
<statusDetail>Report sent successfully</statusDetail>
<names>usage_report_by_originating_npa</names> <names>repeat_usage_report</names>
<names>new_users_by_activity</names>
<names>usage_report_by_country</names>
<names>usage_report_by_status</names>
<names>new_users_report</names>
<names>messages_by_destination</names>
<names>usage_report_by_npa_and_date</names>
<names>users_data_per_user_type</names>
<names>message_count_by_shortcode</names>
</result>
</ns0:getReportNamesResponse>
</env:Body>
</env:Envelope>

6. getReportParameters

ReportParametersResponse getReportParameters(authenticationDetails, reportName) – ReportParametersResponse includes array of array of ReportField class

• authenticationDetails – An object that includes administrator user name & password.
• reportName – report name you want to execute (to get report name, see previous section getReportNames)

Example – Request
<?xml version=”1.0″ encoding=”UTF-8″?>
<soapenv:Envelope xmlns:soapenv=”http://schemas.xmlsoap.org/soap/envelope/” xmlns:xsd=”http://www.w3.org/2001/XMLSchema” xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance”>
<soapenv:Body>
<getReportParameters xmlns=”http://localhost:8080/tmtypes”>
<AuthenticationDetails_1 xmlns=””>
<userLogin>administrator </userLogin>
<userPIN xsi:nil=”true”/>
<userPassword>xxxxx</userPassword>
</AuthenticationDetails_1>
<int_2 xmlns=””>0</int_2>
<String_3 xmlns=””>usage_report_by_originating_npa</String_3>
</getReportParameters>
</soapenv:Body>
</soapenv:Envelope>

Example – Response
<?xml version=”1.0″ encoding=”UTF-8″?>
<env:Envelope xmlns:env=”http://schemas.xmlsoap.org/soap/envelope/” xmlns:xsd=”http://www.w3.org/2001/XMLSchema” xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance” xmlns:enc=”http://schemas.xmlsoap.org/soap/encoding/” xmlns:ns0=”http://localhost:8080/tmtypes”>
<env:Body>
<ns0:getReportParametersResponse>
<result>
<statusCode>0</statusCode>
<statusDetail>Report parameters fetched successfully</statusDetail>
<fields><mandatory>false</mandatory><name>report_Service_Level</name><type>USERTYPE</type><value xsi:nil=”1″/></fields>
<fields><mandatory>true</mandatory><name>report_From_Date</name><type>DATE</type><value xsi:nil=”1″/></fields>
<fields><mandatory>true</mandatory><name>report_To_Date</name><type>DATE</type><value xsi:nil=”1″/></fields>
<fields><mandatory>false</mandatory><name>Time_Zone</name><type>TIMEZONE</type><value xsi:nil=”1″/></fields>
<fields><mandatory>false</mandatory><name>report_Unit_Seconds</name><type>NUMBER</type><value xsi:nil=”1″/></fields>
<reportName>usage_report_by_originating_npa</reportName>
</result>
</ns0:getReportParametersResponse>
</env:Body>
</env:Envelope>

7. getReport

ReportResponse getReport(authenticationDetails, reportName, outputType, parameters)

• authenticationDetails – An object that includes administrator user name & password.
• reportName – report name you want to execute (to get report name, see previous section getReportNames)
• outputType – type of output:

    i. ” EXCEL” – excel file
    ii. ” TAB_SEPARATED” – tab separated separated file

• Parameters – list of parameters required and optional for executing report (array of ReportField class)

Example – Request
<?xml version=”1.0″ encoding=”UTF-8″?>
<soapenv:Envelope xmlns:soapenv=”http://schemas.xmlsoap.org/soap/envelope/” xmlns:xsd=”http://www.w3.org/2001/XMLSchema” xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance”>
<soapenv:Body>
<getReport xmlns=”http://localhost:8080/tmtypes”>
<AuthenticationDetails_1 xmlns=””>
<userLogin>administrator</userLogin>
<userPIN xsi:nil=”true”/>
<userPassword>xxxx</userPassword>
</AuthenticationDetails_1>
<int_2 xmlns=””>0</int_2>
<String_3 xmlns=””>new_users_report</String_3>
<String_4 xmlns=””>EXCEL</String_4>
<arrayOfReportField_5 xmlns=””><mandatory>false</mandatory><name>report_Service_Level</name><type>USERTYPE</type><value>191</value></arrayOfReportField_5>
<arrayOfReportField_5 xmlns=””><mandatory>true</mandatory><name>report_From_Date</name><type>DATE</type><value>05/01/2008</value></arrayOfReportField_5>
<arrayOfReportField_5 xmlns=””><mandatory>true</mandatory><name>report_To_Date</name><type>DATE</type><value>07/31/2008</value></arrayOfReportField_5>
<arrayOfReportField_5 xmlns=””><mandatory>false</mandatory><name>Time_Zone</name><type>TIMEZONE</type><value></value></arrayOfReportField_5>
</getReport>
</soapenv:Body>
</soapenv:Envelope>

Example – Response
<?xml version=”1.0″ encoding=”UTF-8″?>
<env:Envelope xmlns:env=”http://schemas.xmlsoap.org/soap/envelope/” xmlns:xsd=”http://www.w3.org/2001/XMLSchema” xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance” xmlns:enc=”http://schemas.xmlsoap.org/soap/encoding/” xmlns:ns0=”http://localhost:8080/tmtypes”>
<env:Body>
<ns0:getReportResponse>
<result>
<statusCode>0</statusCode>
<statusDetail>Report sent successfully</statusDetail>
<bytes>…..here will be bytes…..</bytes>
</result>
</ns0:getReportResponse>
</env:Body>
</env:Envelope>