Skip to content

Latest commit

 

History

History
200 lines (158 loc) · 7.51 KB

ObjectDiscussionmembershipApi.md

File metadata and controls

200 lines (158 loc) · 7.51 KB
Raw

eZmaxApi.Api.ObjectDiscussionmembershipApi

All URIs are relative to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest

Method HTTP request Description
DiscussionmembershipCreateObjectV1 POST /1/object/discussionmembership Create a new Discussionmembership
DiscussionmembershipDeleteObjectV1 DELETE /1/object/discussionmembership/{pkiDiscussionmembershipID} Delete an existing Discussionmembership

DiscussionmembershipCreateObjectV1

DiscussionmembershipCreateObjectV1Response DiscussionmembershipCreateObjectV1 (DiscussionmembershipCreateObjectV1Request discussionmembershipCreateObjectV1Request)

Create a new Discussionmembership

The endpoint allows to create one or many elements at once.

Example

using System.Collections.Generic;
using System.Diagnostics;
using eZmaxApi.Api;
using eZmaxApi.Client;
using eZmaxApi.Model;

namespace Example
{
    public class DiscussionmembershipCreateObjectV1Example
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest";
            // Configure API key authorization: Authorization
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new ObjectDiscussionmembershipApi(config);
            var discussionmembershipCreateObjectV1Request = new DiscussionmembershipCreateObjectV1Request(); // DiscussionmembershipCreateObjectV1Request | 

            try
            {
                // Create a new Discussionmembership
                DiscussionmembershipCreateObjectV1Response result = apiInstance.DiscussionmembershipCreateObjectV1(discussionmembershipCreateObjectV1Request);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ObjectDiscussionmembershipApi.DiscussionmembershipCreateObjectV1: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the DiscussionmembershipCreateObjectV1WithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Create a new Discussionmembership
    ApiResponse<DiscussionmembershipCreateObjectV1Response> response = apiInstance.DiscussionmembershipCreateObjectV1WithHttpInfo(discussionmembershipCreateObjectV1Request);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling ObjectDiscussionmembershipApi.DiscussionmembershipCreateObjectV1WithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
discussionmembershipCreateObjectV1Request DiscussionmembershipCreateObjectV1Request

Return type

DiscussionmembershipCreateObjectV1Response

Authorization

Authorization

HTTP request headers

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

HTTP response details

Status code Description Response headers
201 Successful response -

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

DiscussionmembershipDeleteObjectV1

DiscussionmembershipDeleteObjectV1Response DiscussionmembershipDeleteObjectV1 (int pkiDiscussionmembershipID)

Delete an existing Discussionmembership

Example

using System.Collections.Generic;
using System.Diagnostics;
using eZmaxApi.Api;
using eZmaxApi.Client;
using eZmaxApi.Model;

namespace Example
{
    public class DiscussionmembershipDeleteObjectV1Example
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest";
            // Configure API key authorization: Authorization
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new ObjectDiscussionmembershipApi(config);
            var pkiDiscussionmembershipID = 56;  // int | The unique ID of the Discussionmembership

            try
            {
                // Delete an existing Discussionmembership
                DiscussionmembershipDeleteObjectV1Response result = apiInstance.DiscussionmembershipDeleteObjectV1(pkiDiscussionmembershipID);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ObjectDiscussionmembershipApi.DiscussionmembershipDeleteObjectV1: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the DiscussionmembershipDeleteObjectV1WithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Delete an existing Discussionmembership
    ApiResponse<DiscussionmembershipDeleteObjectV1Response> response = apiInstance.DiscussionmembershipDeleteObjectV1WithHttpInfo(pkiDiscussionmembershipID);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling ObjectDiscussionmembershipApi.DiscussionmembershipDeleteObjectV1WithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
pkiDiscussionmembershipID int The unique ID of the Discussionmembership

Return type

DiscussionmembershipDeleteObjectV1Response

Authorization

Authorization

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Successful response -
404 The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body -

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