Skip to content

Latest commit

 

History

History
392 lines (270 loc) · 11.8 KB

UserServiceApi.md

File metadata and controls

392 lines (270 loc) · 11.8 KB

Alfaview\UserServiceApi

All URIs are relative to https://localhost

Method HTTP request Description
userAcceptInvitation POST /acceptInvitation
userCreate POST /create Deprecated: use businessLogicService.InviteUsers RPC instead.
userDestroy POST /destroy
userGetLocale POST /getLocale
userInvite POST /invite Deprecated: use businessLogicService.InviteUsers RPC instead.
userList POST /list
userProfileUpdate POST /updateProfile
userUpdate POST /update

userAcceptInvitation

\Alfaview\Model\UserUserAcceptInvitationReply userAcceptInvitation($body)

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Alfaview\Api\UserServiceApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$body = new \Alfaview\Model\UserUserAcceptInvitationRequest(); // \Alfaview\Model\UserUserAcceptInvitationRequest | 

try {
    $result = $apiInstance->userAcceptInvitation($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserServiceApi->userAcceptInvitation: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
body \Alfaview\Model\UserUserAcceptInvitationRequest

Return type

\Alfaview\Model\UserUserAcceptInvitationReply

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

userCreate

\Alfaview\Model\UserUserCreateReply userCreate($body)

Deprecated: use businessLogicService.InviteUsers RPC instead.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Alfaview\Api\UserServiceApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$body = new \Alfaview\Model\UserUserCreateRequest(); // \Alfaview\Model\UserUserCreateRequest | Deprecated: use businessLogicService.InviteUsers RPC instead.

try {
    $result = $apiInstance->userCreate($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserServiceApi->userCreate: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
body \Alfaview\Model\UserUserCreateRequest Deprecated: use businessLogicService.InviteUsers RPC instead.

Return type

\Alfaview\Model\UserUserCreateReply

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

userDestroy

\Alfaview\Model\CommonReplyInfo userDestroy($body)

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Alfaview\Api\UserServiceApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$body = new \Alfaview\Model\UserUserDestroyRequest(); // \Alfaview\Model\UserUserDestroyRequest | 

try {
    $result = $apiInstance->userDestroy($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserServiceApi->userDestroy: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
body \Alfaview\Model\UserUserDestroyRequest

Return type

\Alfaview\Model\CommonReplyInfo

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

userGetLocale

\Alfaview\Model\UserUserGetLocaleReply userGetLocale($body)

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Alfaview\Api\UserServiceApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$body = new \Alfaview\Model\UserUserGetLocaleRequest(); // \Alfaview\Model\UserUserGetLocaleRequest | 

try {
    $result = $apiInstance->userGetLocale($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserServiceApi->userGetLocale: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
body \Alfaview\Model\UserUserGetLocaleRequest

Return type

\Alfaview\Model\UserUserGetLocaleReply

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

userInvite

\Alfaview\Model\UserUserInviteReply userInvite($body)

Deprecated: use businessLogicService.InviteUsers RPC instead.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Alfaview\Api\UserServiceApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$body = new \Alfaview\Model\UserUserInviteRequest(); // \Alfaview\Model\UserUserInviteRequest | Deprecated: use businessLogicService.InviteUsers RPC instead.

try {
    $result = $apiInstance->userInvite($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserServiceApi->userInvite: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
body \Alfaview\Model\UserUserInviteRequest Deprecated: use businessLogicService.InviteUsers RPC instead.

Return type

\Alfaview\Model\UserUserInviteReply

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

userList

\Alfaview\Model\UserUserListReply userList($body)

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Alfaview\Api\UserServiceApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$body = new \Alfaview\Model\UserUserListRequest(); // \Alfaview\Model\UserUserListRequest | 

try {
    $result = $apiInstance->userList($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserServiceApi->userList: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
body \Alfaview\Model\UserUserListRequest

Return type

\Alfaview\Model\UserUserListReply

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

userProfileUpdate

\Alfaview\Model\CommonReplyInfo userProfileUpdate($body)

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Alfaview\Api\UserServiceApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$body = new \Alfaview\Model\UserUserProfileUpdateRequest(); // \Alfaview\Model\UserUserProfileUpdateRequest | 

try {
    $result = $apiInstance->userProfileUpdate($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserServiceApi->userProfileUpdate: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
body \Alfaview\Model\UserUserProfileUpdateRequest

Return type

\Alfaview\Model\CommonReplyInfo

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

userUpdate

\Alfaview\Model\CommonReplyInfo userUpdate($body)

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Alfaview\Api\UserServiceApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$body = new \Alfaview\Model\UserUserUpdateRequest(); // \Alfaview\Model\UserUserUpdateRequest | 

try {
    $result = $apiInstance->userUpdate($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserServiceApi->userUpdate: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
body \Alfaview\Model\UserUserUpdateRequest

Return type

\Alfaview\Model\CommonReplyInfo

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]