Skip to content

Latest commit

 

History

History
558 lines (404 loc) · 15.8 KB

UserApi.md

File metadata and controls

558 lines (404 loc) · 15.8 KB
Raw

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(groupOid)

Delete a group

Delete a group on the UltraCart account.

Example

// Import classes:
//import com.ultracart.admin.v2.swagger.ApiClient;
//import com.ultracart.admin.v2.swagger.ApiException;
//import com.ultracart.admin.v2.swagger.Configuration;
//import com.ultracart.admin.v2.swagger.auth.*;
//import com.ultracart.admin.v2.UserApi;

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
UserApi apiInstance = new UserApi(apiKey);

Integer groupOid = 56; // Integer | The group_oid to delete.
try {
    apiInstance.deleteGroup(groupOid);
} catch (ApiException e) {
    System.err.println("Exception when calling UserApi#deleteGroup");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
groupOid Integer The group_oid to delete.

Return type

null (empty response body)

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

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

deleteUser

deleteUser(userId)

Delete a user

Delete a user on the UltraCart account.

Example

// Import classes:
//import com.ultracart.admin.v2.swagger.ApiClient;
//import com.ultracart.admin.v2.swagger.ApiException;
//import com.ultracart.admin.v2.swagger.Configuration;
//import com.ultracart.admin.v2.swagger.auth.*;
//import com.ultracart.admin.v2.UserApi;

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
UserApi apiInstance = new UserApi(apiKey);

Integer userId = 56; // Integer | The user_id to delete.
try {
    apiInstance.deleteUser(userId);
} catch (ApiException e) {
    System.err.println("Exception when calling UserApi#deleteUser");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
userId Integer The user_id to delete.

Return type

null (empty response body)

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

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

getGroup

getGroup(groupOid)

Retrieve a group

Retrieves a single group using the specified group id.

Example

// Import classes:
//import com.ultracart.admin.v2.swagger.ApiClient;
//import com.ultracart.admin.v2.swagger.ApiException;
//import com.ultracart.admin.v2.swagger.Configuration;
//import com.ultracart.admin.v2.swagger.auth.*;
//import com.ultracart.admin.v2.UserApi;

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
UserApi apiInstance = new UserApi(apiKey);

Integer groupOid = 56; // Integer | The group id to retrieve.
try {
    apiInstance.getGroup(groupOid);
} catch (ApiException e) {
    System.err.println("Exception when calling UserApi#getGroup");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
groupOid Integer The group id to retrieve.

Return type

null (empty response body)

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

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

getGroups

GroupsResponse getGroups()

Get groups

Example

// Import classes:
//import com.ultracart.admin.v2.swagger.ApiClient;
//import com.ultracart.admin.v2.swagger.ApiException;
//import com.ultracart.admin.v2.swagger.Configuration;
//import com.ultracart.admin.v2.swagger.auth.*;
//import com.ultracart.admin.v2.UserApi;

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
UserApi apiInstance = new UserApi(apiKey);

try {
    GroupsResponse result = apiInstance.getGroups();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling UserApi#getGroups");
    e.printStackTrace();
}

Parameters

This endpoint does not need any parameter.

Return type

GroupsResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

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

getUser

UserResponse getUser(userId)

Retrieve a user

Retrieves a single user using the specified user id.

Example

// Import classes:
//import com.ultracart.admin.v2.swagger.ApiClient;
//import com.ultracart.admin.v2.swagger.ApiException;
//import com.ultracart.admin.v2.swagger.Configuration;
//import com.ultracart.admin.v2.swagger.auth.*;
//import com.ultracart.admin.v2.UserApi;

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
UserApi apiInstance = new UserApi(apiKey);

Integer userId = 56; // Integer | The user id to retrieve.
try {
    UserResponse result = apiInstance.getUser(userId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling UserApi#getUser");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
userId Integer The user id to retrieve.

Return type

UserResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

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

getUserLogins

UserLoginsResponse getUserLogins(userId)

Retrieve a user's login history

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

Example

// Import classes:
//import com.ultracart.admin.v2.swagger.ApiClient;
//import com.ultracart.admin.v2.swagger.ApiException;
//import com.ultracart.admin.v2.swagger.Configuration;
//import com.ultracart.admin.v2.swagger.auth.*;
//import com.ultracart.admin.v2.UserApi;

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
UserApi apiInstance = new UserApi(apiKey);

Integer userId = 56; // Integer | The user id to retrieve.
try {
    UserLoginsResponse result = apiInstance.getUserLogins(userId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling UserApi#getUserLogins");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
userId Integer The user id to retrieve.

Return type

UserLoginsResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

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

getUsers

UsersResponse getUsers()

Get users

Example

// Import classes:
//import com.ultracart.admin.v2.swagger.ApiClient;
//import com.ultracart.admin.v2.swagger.ApiException;
//import com.ultracart.admin.v2.swagger.Configuration;
//import com.ultracart.admin.v2.swagger.auth.*;
//import com.ultracart.admin.v2.UserApi;

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
UserApi apiInstance = new UserApi(apiKey);

try {
    UsersResponse result = apiInstance.getUsers();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling UserApi#getUsers");
    e.printStackTrace();
}

Parameters

This endpoint does not need any parameter.

Return type

UsersResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

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

insertGroup

GroupResponse insertGroup(group)

Insert a group

Insert a group on the UltraCart account.

Example

// Import classes:
//import com.ultracart.admin.v2.swagger.ApiClient;
//import com.ultracart.admin.v2.swagger.ApiException;
//import com.ultracart.admin.v2.swagger.Configuration;
//import com.ultracart.admin.v2.swagger.auth.*;
//import com.ultracart.admin.v2.UserApi;

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
UserApi apiInstance = new UserApi(apiKey);

Group group = new Group(); // Group | Group to insert
try {
    GroupResponse result = apiInstance.insertGroup(group);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling UserApi#insertGroup");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
group Group Group to insert

Return type

GroupResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

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

insertUser

UserResponse insertUser(user)

Insert a user

Insert a user on the UltraCart account.

Example

// Import classes:
//import com.ultracart.admin.v2.swagger.ApiClient;
//import com.ultracart.admin.v2.swagger.ApiException;
//import com.ultracart.admin.v2.swagger.Configuration;
//import com.ultracart.admin.v2.swagger.auth.*;
//import com.ultracart.admin.v2.UserApi;

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
UserApi apiInstance = new UserApi(apiKey);

User user = new User(); // User | User to insert
try {
    UserResponse result = apiInstance.insertUser(user);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling UserApi#insertUser");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
user User User to insert

Return type

UserResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

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

updateGroup

GroupResponse updateGroup(group, groupOid)

Update a group

Update a group on the UltraCart account.

Example

// Import classes:
//import com.ultracart.admin.v2.swagger.ApiClient;
//import com.ultracart.admin.v2.swagger.ApiException;
//import com.ultracart.admin.v2.swagger.Configuration;
//import com.ultracart.admin.v2.swagger.auth.*;
//import com.ultracart.admin.v2.UserApi;

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
UserApi apiInstance = new UserApi(apiKey);

Group group = new Group(); // Group | Group to update
Integer groupOid = 56; // Integer | The group_oid to update.
try {
    GroupResponse result = apiInstance.updateGroup(group, groupOid);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling UserApi#updateGroup");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
group Group Group to update
groupOid Integer The group_oid to update.

Return type

GroupResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

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

updateUser

UserResponse updateUser(user, userId)

Update a user

Update a user on the UltraCart account.

Example

// Import classes:
//import com.ultracart.admin.v2.swagger.ApiClient;
//import com.ultracart.admin.v2.swagger.ApiException;
//import com.ultracart.admin.v2.swagger.Configuration;
//import com.ultracart.admin.v2.swagger.auth.*;
//import com.ultracart.admin.v2.UserApi;

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
UserApi apiInstance = new UserApi(apiKey);

User user = new User(); // User | User to update
Integer userId = 56; // Integer | The user_id to update.
try {
    UserResponse result = apiInstance.updateUser(user, userId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling UserApi#updateUser");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
user User User to update
userId Integer The user_id to update.

Return type

UserResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

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