Skip to content

Latest commit

 

History

History
734 lines (536 loc) · 19.5 KB

UserApi.md

File metadata and controls

734 lines (536 loc) · 19.5 KB
Raw

com.ultracart.admin.v2.Api.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

void DeleteGroup (int? groupOid)

Delete a group

Delete a group on the UltraCart account.

Example

using System;
using System.Diagnostics;
using com.ultracart.admin.v2.Api;
using com.ultracart.admin.v2.Client;
using com.ultracart.admin.v2.Model;

namespace Example
{
    public class DeleteGroupExample
    {
        public void main()
        {

            // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
            const string simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
            var api = new UserApi(simpleKey);

            var groupOid = 56;  // int? | The group_oid to delete.

            try
            {
                // Delete a group
                apiInstance.DeleteGroup(groupOid);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserApi.DeleteGroup: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
groupOid 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

void DeleteUser (int? userId)

Delete a user

Delete a user on the UltraCart account.

Example

using System;
using System.Diagnostics;
using com.ultracart.admin.v2.Api;
using com.ultracart.admin.v2.Client;
using com.ultracart.admin.v2.Model;

namespace Example
{
    public class DeleteUserExample
    {
        public void main()
        {

            // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
            const string simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
            var api = new UserApi(simpleKey);

            var userId = 56;  // int? | The user_id to delete.

            try
            {
                // Delete a user
                apiInstance.DeleteUser(userId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserApi.DeleteUser: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
userId 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

void GetGroup (int? groupOid)

Retrieve a group

Retrieves a single group using the specified group id.

Example

using System;
using System.Diagnostics;
using com.ultracart.admin.v2.Api;
using com.ultracart.admin.v2.Client;
using com.ultracart.admin.v2.Model;

namespace Example
{
    public class GetGroupExample
    {
        public void main()
        {

            // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
            const string simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
            var api = new UserApi(simpleKey);

            var groupOid = 56;  // int? | The group id to retrieve.

            try
            {
                // Retrieve a group
                apiInstance.GetGroup(groupOid);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserApi.GetGroup: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
groupOid 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

GroupsResponse GetGroups ()

Get groups

Example

using System;
using System.Diagnostics;
using com.ultracart.admin.v2.Api;
using com.ultracart.admin.v2.Client;
using com.ultracart.admin.v2.Model;

namespace Example
{
    public class GetGroupsExample
    {
        public void main()
        {

            // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
            const string simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
            var api = new UserApi(simpleKey);


            try
            {
                // Get groups
                GroupsResponse result = apiInstance.GetGroups();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserApi.GetGroups: " + e.Message );
            }
        }
    }
}

Parameters

This endpoint does not need any parameter.

Return type

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

UserResponse GetUser (int? userId)

Retrieve a user

Retrieves a single user using the specified user id.

Example

using System;
using System.Diagnostics;
using com.ultracart.admin.v2.Api;
using com.ultracart.admin.v2.Client;
using com.ultracart.admin.v2.Model;

namespace Example
{
    public class GetUserExample
    {
        public void main()
        {

            // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
            const string simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
            var api = new UserApi(simpleKey);

            var userId = 56;  // int? | The user id to retrieve.

            try
            {
                // Retrieve a user
                UserResponse result = apiInstance.GetUser(userId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserApi.GetUser: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
userId int? The user id to retrieve.

Return type

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

UserLoginsResponse GetUserLogins (int? userId)

Retrieve a user's login history

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

Example

using System;
using System.Diagnostics;
using com.ultracart.admin.v2.Api;
using com.ultracart.admin.v2.Client;
using com.ultracart.admin.v2.Model;

namespace Example
{
    public class GetUserLoginsExample
    {
        public void main()
        {

            // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
            const string simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
            var api = new UserApi(simpleKey);

            var userId = 56;  // int? | The user id to retrieve.

            try
            {
                // Retrieve a user's login history
                UserLoginsResponse result = apiInstance.GetUserLogins(userId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserApi.GetUserLogins: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
userId int? The user id to retrieve.

Return type

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

UsersResponse GetUsers ()

Get users

Example

using System;
using System.Diagnostics;
using com.ultracart.admin.v2.Api;
using com.ultracart.admin.v2.Client;
using com.ultracart.admin.v2.Model;

namespace Example
{
    public class GetUsersExample
    {
        public void main()
        {

            // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
            const string simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
            var api = new UserApi(simpleKey);


            try
            {
                // Get users
                UsersResponse result = apiInstance.GetUsers();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserApi.GetUsers: " + e.Message );
            }
        }
    }
}

Parameters

This endpoint does not need any parameter.

Return type

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

GroupResponse InsertGroup (Group group)

Insert a group

Insert a group on the UltraCart account.

Example

using System;
using System.Diagnostics;
using com.ultracart.admin.v2.Api;
using com.ultracart.admin.v2.Client;
using com.ultracart.admin.v2.Model;

namespace Example
{
    public class InsertGroupExample
    {
        public void main()
        {

            // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
            const string simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
            var api = new UserApi(simpleKey);

            var group = new Group(); // Group | Group to insert

            try
            {
                // Insert a group
                GroupResponse result = apiInstance.InsertGroup(group);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserApi.InsertGroup: " + e.Message );
            }
        }
    }
}

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

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

InsertUser

UserResponse InsertUser (User user)

Insert a user

Insert a user on the UltraCart account.

Example

using System;
using System.Diagnostics;
using com.ultracart.admin.v2.Api;
using com.ultracart.admin.v2.Client;
using com.ultracart.admin.v2.Model;

namespace Example
{
    public class InsertUserExample
    {
        public void main()
        {

            // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
            const string simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
            var api = new UserApi(simpleKey);

            var user = new User(); // User | User to insert

            try
            {
                // Insert a user
                UserResponse result = apiInstance.InsertUser(user);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserApi.InsertUser: " + e.Message );
            }
        }
    }
}

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

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

UpdateGroup

GroupResponse UpdateGroup (Group group, int? groupOid)

Update a group

Update a group on the UltraCart account.

Example

using System;
using System.Diagnostics;
using com.ultracart.admin.v2.Api;
using com.ultracart.admin.v2.Client;
using com.ultracart.admin.v2.Model;

namespace Example
{
    public class UpdateGroupExample
    {
        public void main()
        {

            // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
            const string simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
            var api = new UserApi(simpleKey);

            var group = new Group(); // Group | Group to update
            var groupOid = 56;  // int? | The group_oid to update.

            try
            {
                // Update a group
                GroupResponse result = apiInstance.UpdateGroup(group, groupOid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserApi.UpdateGroup: " + e.Message );
            }
        }
    }
}

Parameters

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

Return type

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

UserResponse UpdateUser (User user, int? userId)

Update a user

Update a user on the UltraCart account.

Example

using System;
using System.Diagnostics;
using com.ultracart.admin.v2.Api;
using com.ultracart.admin.v2.Client;
using com.ultracart.admin.v2.Model;

namespace Example
{
    public class UpdateUserExample
    {
        public void main()
        {

            // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
            const string simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
            var api = new UserApi(simpleKey);

            var user = new User(); // User | User to update
            var userId = 56;  // int? | The user_id to update.

            try
            {
                // Update a user
                UserResponse result = apiInstance.UpdateUser(user, userId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserApi.UpdateUser: " + e.Message );
            }
        }
    }
}

Parameters

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

Return type

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]