MessagingApi.md

BlueRain.ID4i.Api.MessagingApi

All URIs are relative to https://backend.id4i.de

Method	HTTP request	Description
EnqueueCustomMessage	POST /api/v1/organizations/{organizationId}/messaging/enqueueCustomMessage	Enqueue a custom message
GetDefaultQueue	GET /api/v1/organizations/{organizationId}/messaging
PatchDefaultQueue	PATCH /api/v1/organizations/{organizationId}/messaging

EnqueueCustomMessage

void EnqueueCustomMessage (string organizationId, SendCustomMessage request)

Enqueue a custom message

Enqueue a custom organisation message with custom data.

Example

using System;
using System.Diagnostics;
using BlueRain.ID4i.Api;
using BlueRain.ID4i.Client;
using BlueRain.ID4i.Model;

namespace Example
{
    public class EnqueueCustomMessageExample
    {
        public void main()
        {
            // Configure API key authorization: Authorization
            Configuration.Default.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MessagingApi();
            var organizationId = organizationId_example;  // string | The organisation namespace
            var request = new SendCustomMessage(); // SendCustomMessage | request

            try
            {
                // Enqueue a custom message
                apiInstance.EnqueueCustomMessage(organizationId, request);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MessagingApi.EnqueueCustomMessage: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
organizationId	string	The organisation namespace
request	SendCustomMessage	request

Return type

void (empty response body)

Authorization

Authorization

HTTP request headers

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

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

GetDefaultQueue

QueuePresentation GetDefaultQueue (string organizationId)

Example

using System;
using System.Diagnostics;
using BlueRain.ID4i.Api;
using BlueRain.ID4i.Client;
using BlueRain.ID4i.Model;

namespace Example
{
    public class GetDefaultQueueExample
    {
        public void main()
        {
            // Configure API key authorization: Authorization
            Configuration.Default.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MessagingApi();
            var organizationId = organizationId_example;  // string | organizationId

            try
            {
                QueuePresentation result = apiInstance.GetDefaultQueue(organizationId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MessagingApi.GetDefaultQueue: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
organizationId	string	organizationId

Return type

QueuePresentation

Authorization

Authorization

HTTP request headers

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

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

PatchDefaultQueue

void PatchDefaultQueue (string organizationId, QueueUpdateRequest request)

Example

using System;
using System.Diagnostics;
using BlueRain.ID4i.Api;
using BlueRain.ID4i.Client;
using BlueRain.ID4i.Model;

namespace Example
{
    public class PatchDefaultQueueExample
    {
        public void main()
        {
            // Configure API key authorization: Authorization
            Configuration.Default.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MessagingApi();
            var organizationId = organizationId_example;  // string | organizationId
            var request = new QueueUpdateRequest(); // QueueUpdateRequest | request

            try
            {
                apiInstance.PatchDefaultQueue(organizationId, request);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MessagingApi.PatchDefaultQueue: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
organizationId	string	organizationId
request	QueueUpdateRequest	request

Return type

void (empty response body)

Authorization

Authorization

HTTP request headers

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

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