Foundry API

NotificationRolesRequest

The following routes are available for this service:
PUT	/organisations/{Id}/notification/roles/{ActionType}

import java.math.*
import java.util.*
import net.servicestack.client.*


open class NotificationRolesRequest : PutOperationUnTenanted<NotificationRolesResponse>()
{
    var id:String? = null
    var actionType:String? = null
    var roles:ArrayList<String> = ArrayList<String>()
}

open class PutOperationUnTenanted<TResponse> : IPut
{
}

open class NotificationRolesResponse
{
    var responseStatus:ResponseStatus? = null
    var notificationSettings:OrganisationNotificationSettings? = null
}

open class OrganisationNotificationSettings : IIdentifiableResource
{
    var warningNotificationRoles:ArrayList<String> = ArrayList<String>()
    var jobFinishedNotificationRoles:ArrayList<String> = ArrayList<String>()
    var userIdBlockList:ArrayList<String> = ArrayList<String>()
    var id:String? = null
}

Kotlin 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
	}
}