Skip to content

Latest commit

 

History

History
536 lines (360 loc) · 15.9 KB

UserApi.md

File metadata and controls

536 lines (360 loc) · 15.9 KB
Raw

ultracart\v2\UserApi

All URIs are relative to https://secure.ultracart.com/rest/v2

Method HTTP request Description
deleteGroup DELETE /user/groups/{group_oid} Delete a group
deleteUser DELETE /user/users/{user_id} Delete a user
getGroup GET /user/groups/{group_oid} Retrieve a group
getGroups GET /user/groups Get groups
getUser GET /user/users/{user_id} Retrieve a user
getUserLogins GET /user/users/{user_id}/logins Retrieve a user's login history
getUsers GET /user/users Get users
insertGroup POST /user/groups Insert a group
insertUser POST /user/users Insert a user
updateGroup PUT /user/groups/{group_oid} Update a group
updateUser PUT /user/users/{user_id} Update a user

deleteGroup

deleteGroup($group_oid)

Delete a group

Delete a group on the UltraCart account.

Example

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

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\UserApi::usingApiKey($simple_key);

$group_oid = 56; // int | The group_oid to delete.

try {
    $apiInstance->deleteGroup($group_oid);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->deleteGroup: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
group_oid int The group_oid to delete.

Return type

void (empty response body)

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

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

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

deleteUser

deleteUser($user_id)

Delete a user

Delete a user on the UltraCart account.

Example

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

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\UserApi::usingApiKey($simple_key);

$user_id = 56; // int | The user_id to delete.

try {
    $apiInstance->deleteUser($user_id);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->deleteUser: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
user_id int The user_id to delete.

Return type

void (empty response body)

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

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

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

getGroup

getGroup($group_oid)

Retrieve a group

Retrieves a single group using the specified group id.

Example

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

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\UserApi::usingApiKey($simple_key);

$group_oid = 56; // int | The group id to retrieve.

try {
    $apiInstance->getGroup($group_oid);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->getGroup: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
group_oid int The group id to retrieve.

Return type

void (empty response body)

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

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

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

getGroups

\ultracart\v2\models\GroupsResponse getGroups()

Get groups

Example

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

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\UserApi::usingApiKey($simple_key);


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

Parameters

This endpoint does not need any parameter.

Return type

\ultracart\v2\models\GroupsResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

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

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

getUser

\ultracart\v2\models\UserResponse getUser($user_id)

Retrieve a user

Retrieves a single user using the specified user id.

Example

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

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\UserApi::usingApiKey($simple_key);

$user_id = 56; // int | The user id to retrieve.

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

Parameters

Name Type Description Notes
user_id int The user id to retrieve.

Return type

\ultracart\v2\models\UserResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

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

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

getUserLogins

\ultracart\v2\models\UserLoginsResponse getUserLogins($user_id)

Retrieve a user's login history

Retrieves logins for a single user using the specified user id.

Example

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

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\UserApi::usingApiKey($simple_key);

$user_id = 56; // int | The user id to retrieve.

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

Parameters

Name Type Description Notes
user_id int The user id to retrieve.

Return type

\ultracart\v2\models\UserLoginsResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

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

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

getUsers

\ultracart\v2\models\UsersResponse getUsers()

Get users

Example

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

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\UserApi::usingApiKey($simple_key);


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

Parameters

This endpoint does not need any parameter.

Return type

\ultracart\v2\models\UsersResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

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

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

insertGroup

\ultracart\v2\models\GroupResponse insertGroup($group)

Insert a group

Insert a group on the UltraCart account.

Example

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

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\UserApi::usingApiKey($simple_key);

$group = new \ultracart\v2\models\Group(); // \ultracart\v2\models\Group | Group to insert

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

Parameters

Name Type Description Notes
group \ultracart\v2\models\Group Group to insert

Return type

\ultracart\v2\models\GroupResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

  • Content-Type: application/json; charset=UTF-8
  • Accept: application/json

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

insertUser

\ultracart\v2\models\UserResponse insertUser($user)

Insert a user

Insert a user on the UltraCart account.

Example

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

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\UserApi::usingApiKey($simple_key);

$user = new \ultracart\v2\models\User(); // \ultracart\v2\models\User | User to insert

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

Parameters

Name Type Description Notes
user \ultracart\v2\models\User User to insert

Return type

\ultracart\v2\models\UserResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

  • Content-Type: application/json; charset=UTF-8
  • Accept: application/json

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

updateGroup

\ultracart\v2\models\GroupResponse updateGroup($group, $group_oid)

Update a group

Update a group on the UltraCart account.

Example

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

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\UserApi::usingApiKey($simple_key);

$group = new \ultracart\v2\models\Group(); // \ultracart\v2\models\Group | Group to update
$group_oid = 56; // int | The group_oid to update.

try {
    $result = $apiInstance->updateGroup($group, $group_oid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->updateGroup: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
group \ultracart\v2\models\Group Group to update
group_oid int The group_oid to update.

Return type

\ultracart\v2\models\GroupResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

  • Content-Type: application/json; charset=UTF-8
  • Accept: application/json

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

updateUser

\ultracart\v2\models\UserResponse updateUser($user, $user_id)

Update a user

Update a user on the UltraCart account.

Example

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

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\UserApi::usingApiKey($simple_key);

$user = new \ultracart\v2\models\User(); // \ultracart\v2\models\User | User to update
$user_id = 56; // int | The user_id to update.

try {
    $result = $apiInstance->updateUser($user, $user_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->updateUser: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
user \ultracart\v2\models\User User to update
user_id int The user_id to update.

Return type

\ultracart\v2\models\UserResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

  • Content-Type: application/json; charset=UTF-8
  • Accept: application/json

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