Foundry API

NotificationRolesRequest

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

**NotificationRolesRequest** Parameters:
Name	Parameter	Data Type	Required
Id	path	string	No
ActionType	path	string	No
Roles	body	List<string>	No

**NotificationRolesResponse** Parameters:
Name	Parameter	Data Type	Required	Description
ResponseStatus	form	ResponseStatus	No
NotificationSettings	form	OrganisationNotificationSettings	No

**OrganisationNotificationSettings** Parameters:
Name	Parameter	Data Type	Required
WarningNotificationRoles	form	List<string>	No
JobFinishedNotificationRoles	form	List<string>	No
UserIdBlockList	form	List<string>	No
Id	form	string	No

**NotificationRolesResponse** Parameters:
Name	Parameter	Data Type	Required	Description
ResponseStatus	form	ResponseStatus	No
NotificationSettings	form	OrganisationNotificationSettings	No

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