UserVoiceSdk.Api.CategoriesApi

Method	HTTP request	Description
Create	POST /admin/categories	# Create a category
DeleteById	DELETE /admin/categories/{id}	# Delete a category
Get	GET /admin/categories	# List categories
GetById	GET /admin/categories/{id}	# Retrieve categories by id
UpdateById	PUT /admin/categories/{id}	# Update a category

Create

CategoryResponse Create (string name, long? linksForum, List includes = null)

Create a category

Example

using System;
using System.Diagnostics;
using UserVoiceSdk.Api;
using UserVoiceSdk.Client;
using UserVoiceSdk.Models;

namespace Example
{
    public class CreateExample
    {
        private string ApiKey = "some_key";
        private string ApiSecret = "some_secret";
        private string Subdomain = "sub";
        private string Domain = "uservoice.com";

		// Credentials for authenticating as a user
		private string Username = "some.user@uservoice.com";
		private string Password = "Somepassword1234!";

        public void main()
        {
            var client = new ApiClient(subdomain: Subdomain,
									   clientId: ApiKey,
									   domain: Domain,
									   clientSecret: ApiSecret);

			// Authentication takes place on request when a token is not available
			// However, you can explicitly login using the functions below
			//client.Login(ApiKey, ApiSecret);
			//client.LoginAsUser(ApiKey, Username, Password);

            var name = name_example;  // string | 
            var linksForum = 789;  // long? | 
            var includes = new List<string>(); // List<string> |  (optional) 

            try
            {
                // # Create a category
                CategoryResponse result = client.Categories.Create(name, linksForum, includes);
                Debug.WriteLine(result);
            }
            catch (RateLimitException rle)
            {
                Debug.Print(string.Format("Rate limit exceeded. Limit: {0}, Remaining: {1}, Reset: {2}", client.RateLimiting.Limit, client.RateLimiting.Remaining, client.RateLimiting.Reset));
                Debug.Print(string.Format("Reset in {0} seconds. Reset at {1} UTC", client.RateLimiting.ResetIn(), client.RateLimiting.ResetAt()));
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling CategoriesApi.Create: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Notes
name	string
linksForum	long?
includes	List	[optional]

Return type

CategoryResponse

Authorization

oauth2_password, oauth2_client_credentials

HTTP request headers

Content-Type: application/x-www-form-urlencoded
Accept: Not defined

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

DeleteById

CategoryResponse DeleteById (long? id, List includes = null)

Delete a category

Example

using System;
using System.Diagnostics;
using UserVoiceSdk.Api;
using UserVoiceSdk.Client;
using UserVoiceSdk.Models;

namespace Example
{
    public class DeleteByIdExample
    {
        private string ApiKey = "some_key";
        private string ApiSecret = "some_secret";
        private string Subdomain = "sub";
        private string Domain = "uservoice.com";

		// Credentials for authenticating as a user
		private string Username = "some.user@uservoice.com";
		private string Password = "Somepassword1234!";

        public void main()
        {
            var client = new ApiClient(subdomain: Subdomain,
									   clientId: ApiKey,
									   domain: Domain,
									   clientSecret: ApiSecret);

			// Authentication takes place on request when a token is not available
			// However, you can explicitly login using the functions below
			//client.Login(ApiKey, ApiSecret);
			//client.LoginAsUser(ApiKey, Username, Password);

            var id = 789;  // long? | 
            var includes = new List<string>(); // List<string> |  (optional) 

            try
            {
                // # Delete a category
                CategoryResponse result = client.Categories.DeleteById(id, includes);
                Debug.WriteLine(result);
            }
            catch (RateLimitException rle)
            {
                Debug.Print(string.Format("Rate limit exceeded. Limit: {0}, Remaining: {1}, Reset: {2}", client.RateLimiting.Limit, client.RateLimiting.Remaining, client.RateLimiting.Reset));
                Debug.Print(string.Format("Reset in {0} seconds. Reset at {1} UTC", client.RateLimiting.ResetIn(), client.RateLimiting.ResetAt()));
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling CategoriesApi.DeleteById: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
id	long?
includes	List		[optional]

Return type

CategoryResponse

Authorization

oauth2_password, oauth2_client_credentials

HTTP request headers

Content-Type: application/x-www-form-urlencoded
Accept: Not defined

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

Get

CategoryResponsePaginated Get (long? page = null, long? perPage = null, string sort = null, List<int?> forum = null, List includes = null)

List categories

Example

using System;
using System.Diagnostics;
using UserVoiceSdk.Api;
using UserVoiceSdk.Client;
using UserVoiceSdk.Models;

namespace Example
{
    public class GetExample
    {
        private string ApiKey = "some_key";
        private string ApiSecret = "some_secret";
        private string Subdomain = "sub";
        private string Domain = "uservoice.com";

		// Credentials for authenticating as a user
		private string Username = "some.user@uservoice.com";
		private string Password = "Somepassword1234!";

        public void main()
        {
            var client = new ApiClient(subdomain: Subdomain,
									   clientId: ApiKey,
									   domain: Domain,
									   clientSecret: ApiSecret);

			// Authentication takes place on request when a token is not available
			// However, you can explicitly login using the functions below
			//client.Login(ApiKey, ApiSecret);
			//client.LoginAsUser(ApiKey, Username, Password);

            var page = 789;  // long? |  (optional)  (default to 1)
            var perPage = 789;  // long? |  (optional)  (default to 20)
            var sort = sort_example;  // string |  (optional)  (default to -id)
            var forum = new List<int?>(); // List<int?> |  (optional) 
            var includes = new List<string>(); // List<string> |  (optional) 

            try
            {
                // # List categories
                CategoryResponsePaginated result = client.Categories.Get(page, perPage, sort, forum, includes);
                Debug.WriteLine(result);
            }
            catch (RateLimitException rle)
            {
                Debug.Print(string.Format("Rate limit exceeded. Limit: {0}, Remaining: {1}, Reset: {2}", client.RateLimiting.Limit, client.RateLimiting.Remaining, client.RateLimiting.Reset));
                Debug.Print(string.Format("Reset in {0} seconds. Reset at {1} UTC", client.RateLimiting.ResetIn(), client.RateLimiting.ResetAt()));
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling CategoriesApi.Get: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Notes
page	long?	[optional] [default to 1]
perPage	long?	[optional] [default to 20]
sort	string	[optional] [default to -id]
forum	List<int?>	[optional]
includes	List	[optional]

Return type

CategoryResponsePaginated

Authorization

oauth2_password, oauth2_client_credentials

HTTP request headers

Content-Type: application/x-www-form-urlencoded
Accept: Not defined

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

GetById

CategoryResponse GetById (List<int?> id, List includes = null)

Retrieve categories by id

Example

using System;
using System.Diagnostics;
using UserVoiceSdk.Api;
using UserVoiceSdk.Client;
using UserVoiceSdk.Models;

namespace Example
{
    public class GetByIdExample
    {
        private string ApiKey = "some_key";
        private string ApiSecret = "some_secret";
        private string Subdomain = "sub";
        private string Domain = "uservoice.com";

		// Credentials for authenticating as a user
		private string Username = "some.user@uservoice.com";
		private string Password = "Somepassword1234!";

        public void main()
        {
            var client = new ApiClient(subdomain: Subdomain,
									   clientId: ApiKey,
									   domain: Domain,
									   clientSecret: ApiSecret);

			// Authentication takes place on request when a token is not available
			// However, you can explicitly login using the functions below
			//client.Login(ApiKey, ApiSecret);
			//client.LoginAsUser(ApiKey, Username, Password);

            var id = new List<int?>(); // List<int?> | 
            var includes = new List<string>(); // List<string> |  (optional) 

            try
            {
                // # Retrieve categories by id
                CategoryResponse result = client.Categories.GetById(id, includes);
                Debug.WriteLine(result);
            }
            catch (RateLimitException rle)
            {
                Debug.Print(string.Format("Rate limit exceeded. Limit: {0}, Remaining: {1}, Reset: {2}", client.RateLimiting.Limit, client.RateLimiting.Remaining, client.RateLimiting.Reset));
                Debug.Print(string.Format("Reset in {0} seconds. Reset at {1} UTC", client.RateLimiting.ResetIn(), client.RateLimiting.ResetAt()));
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling CategoriesApi.GetById: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
id	List<int?>
includes	List		[optional]

Return type

CategoryResponse

Authorization

oauth2_password, oauth2_client_credentials

HTTP request headers

Content-Type: application/x-www-form-urlencoded
Accept: Not defined

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

UpdateById

CategoryResponse UpdateById (long? id, string name = null, long? linksForum = null, List includes = null)

Update a category

Example

using System;
using System.Diagnostics;
using UserVoiceSdk.Api;
using UserVoiceSdk.Client;
using UserVoiceSdk.Models;

namespace Example
{
    public class UpdateByIdExample
    {
        private string ApiKey = "some_key";
        private string ApiSecret = "some_secret";
        private string Subdomain = "sub";
        private string Domain = "uservoice.com";

		// Credentials for authenticating as a user
		private string Username = "some.user@uservoice.com";
		private string Password = "Somepassword1234!";

        public void main()
        {
            var client = new ApiClient(subdomain: Subdomain,
									   clientId: ApiKey,
									   domain: Domain,
									   clientSecret: ApiSecret);

			// Authentication takes place on request when a token is not available
			// However, you can explicitly login using the functions below
			//client.Login(ApiKey, ApiSecret);
			//client.LoginAsUser(ApiKey, Username, Password);

            var id = 789;  // long? | 
            var name = name_example;  // string |  (optional) 
            var linksForum = 789;  // long? |  (optional) 
            var includes = new List<string>(); // List<string> |  (optional) 

            try
            {
                // # Update a category
                CategoryResponse result = client.Categories.UpdateById(id, name, linksForum, includes);
                Debug.WriteLine(result);
            }
            catch (RateLimitException rle)
            {
                Debug.Print(string.Format("Rate limit exceeded. Limit: {0}, Remaining: {1}, Reset: {2}", client.RateLimiting.Limit, client.RateLimiting.Remaining, client.RateLimiting.Reset));
                Debug.Print(string.Format("Reset in {0} seconds. Reset at {1} UTC", client.RateLimiting.ResetIn(), client.RateLimiting.ResetAt()));
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling CategoriesApi.UpdateById: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Notes
id	long?
name	string	[optional]
linksForum	long?	[optional]
includes	List	[optional]

Return type

CategoryResponse

Authorization

oauth2_password, oauth2_client_credentials

HTTP request headers

Content-Type: application/x-www-form-urlencoded
Accept: Not defined

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

Files

CategoriesApi.md

Latest commit

History

CategoriesApi.md

File metadata and controls

UserVoiceSdk.Api.CategoriesApi

Create

Create a category

Example

Parameters

Return type

Authorization

HTTP request headers

DeleteById

Delete a category

Example

Parameters

Return type

Authorization

HTTP request headers

Get

List categories

Example

Parameters

Return type

Authorization

HTTP request headers

GetById

Retrieve categories by id

Example

Parameters

Return type

Authorization

HTTP request headers

UpdateById

Update a category

Example

Parameters

Return type

Authorization

HTTP request headers