Account Calls
Info! This is Beta version, if you have any problem in using API, please mail us at support@sarv.com
/account/viewUserDetail
view User Details
<?php
try {
require_once 'SarvMTA_PHP/Sarv.php';
$sarv = new Sarv('owner_id', 'token', 'SarvTES_APP_DOMAIN');
$result = $sarv->accounts->viewUserDetail();
print_r($result);
/*
Array
(
[status] => "success"
[user_data] => array(
[name] => "john yu"
[email] => "john@sarv.com"
[mobile] => 9999999999
[create_date] => 67457775764
[allowed_speed] => 300
[reputation] => "50%"
)
)
*/
} catch(Sarv_Error $e) {
// Sarv errors are thrown as exceptions
echo "A sarv error occurred: " . get_class($e) . " - " . $e->getMessage();
}
?>
Array
(
[status] => "success"
[user_data] => array(
[name] => "john yu"
[email] => "john@sarv.com"
[mobile] => 9999999999
[create_date] => 67457775764
[allowed_speed] => 300
[reputation] => "50%"
)
)
Array
(
[status]=> "error"
[code]=> -1
[name]=> "AuthenticationError"
[message]=> "Token MissMatch"
)
Parameters |
owner_id* string |
a valid Sarv User Id |
token* string |
a valid token |
SarvTES_APP_DOMAIN* string |
a valid SarvTES APP DOMAIN |
* compulsory field
Return Value: Success |
struct |
the results of User Details
status string |
always success |
user_data[]struct |
information of user details
name string |
user's name |
email string |
user's email |
mobile string |
user's mobile no. |
allowed_speed integer |
user's allowed speed |
reputation string |
user's reputation in % |
create_date integer |
create date in seconds |
|
|
|
|
Return Value: Error |
struct |
the error results when attempt to get User Details
status string |
error |
message string |
human readable message |
type string |
one of the error type as bellow table |
|
|
Error types |
ValidationError |
The parameters passed to the API call are invalid or not provided when required. |
GeneralError |
An unexpected errors occurred processing the request. Sarv Developers will be notified. |
AuthenticationError |
Provided owner_id and token was not matched. |