Foundry API

<back to all web services

GetOrganisationNotificationSettingsRequest

Requires Authentication
The following routes are available for this service:
GET/organisations/{Id}/notification-settings
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Infrastructure.Api.Interfaces.ServiceOperations.Organisations;
using Infrastructure.Api.Interfaces.ServiceOperations;
using Application.Interfaces.Resources;

namespace Application.Interfaces.Resources
{
    public partial class OrganisationNotificationSettings
        : IIdentifiableResource
    {
        public OrganisationNotificationSettings()
        {
            WarningNotificationRoles = new List<string>{};
            JobFinishedNotificationRoles = new List<string>{};
            UserIdBlockList = new List<string>{};
        }

        public virtual List<string> WarningNotificationRoles { get; set; }
        public virtual List<string> JobFinishedNotificationRoles { get; set; }
        public virtual List<string> UserIdBlockList { get; set; }
        public virtual string Id { get; set; }
    }

}

namespace Infrastructure.Api.Interfaces.ServiceOperations
{
    public partial class GetOperationUnTenanted<TResponse>
        : IHasGetOptions, IGet
    {
        public virtual string Embed { get; set; }
    }

}

namespace Infrastructure.Api.Interfaces.ServiceOperations.Organisations
{
    public partial class GetOrganisationNotificationSettingsRequest
        : GetOperationUnTenanted<GetOrganisationNotificationSettingsResponse>
    {
        public virtual string Id { get; set; }
    }

    public partial class GetOrganisationNotificationSettingsResponse
    {
        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual OrganisationNotificationSettings NotificationSettings { get; set; }
    }

}

C# GetOrganisationNotificationSettingsRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /organisations/{Id}/notification-settings HTTP/1.1 
Host: foundrystage-api-app.azurewebsites.net 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	},
	notificationSettings: 
	{
		warningNotificationRoles: 
		[
			String
		],
		jobFinishedNotificationRoles: 
		[
			String
		],
		userIdBlockList: 
		[
			String
		],
		id: String
	}
}