Foundry API

<back to all web services

NotificationRolesRequest

Requires Authentication
The following routes are available for this service:
PUT/organisations/{Id}/notification/roles/{ActionType}
namespace Application.Interfaces.Resources

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type OrganisationNotificationSettings() = 
        member val WarningNotificationRoles:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val JobFinishedNotificationRoles:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val UserIdBlockList:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val Id:String = null with get,set

    [<AllowNullLiteral>]
    type NotificationRolesResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val NotificationSettings:OrganisationNotificationSettings = null with get,set

    [<AllowNullLiteral>]
    type NotificationRolesRequest() = 
        inherit PutOperationUnTenanted<NotificationRolesResponse>()
        member val Id:String = null with get,set
        member val ActionType:String = null with get,set
        member val Roles:ResizeArray<String> = new ResizeArray<String>() with get,set

    [<AllowNullLiteral>]
    type PutOperationUnTenanted<'TResponse>() = 
        interface IPut

F# NotificationRolesRequest 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.

PUT /organisations/{Id}/notification/roles/{ActionType} HTTP/1.1 
Host: foundrystage-api-app.azurewebsites.net 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	id: String,
	actionType: String,
	roles: 
	[
		String
	]
}
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
	}
}