Foundry API

<back to all web services

NotificationRolesRequest

Requires Authentication
The following routes are available for this service:
PUT/organisations/{Id}/notification/roles/{ActionType}
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class NotificationRolesRequest extends PutOperationUnTenanted<NotificationRolesResponse>
    {
        public String id = null;
        public String actionType = null;
        public ArrayList<String> roles = null;
        
        public String getId() { return id; }
        public NotificationRolesRequest setId(String value) { this.id = value; return this; }
        public String getActionType() { return actionType; }
        public NotificationRolesRequest setActionType(String value) { this.actionType = value; return this; }
        public ArrayList<String> getRoles() { return roles; }
        public NotificationRolesRequest setRoles(ArrayList<String> value) { this.roles = value; return this; }
    }

    public static class PutOperationUnTenanted<TResponse> implements IPut
    {
        
    }

    public static class NotificationRolesResponse
    {
        public ResponseStatus responseStatus = null;
        public OrganisationNotificationSettings notificationSettings = null;
        
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public NotificationRolesResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
        public OrganisationNotificationSettings getNotificationSettings() { return notificationSettings; }
        public NotificationRolesResponse setNotificationSettings(OrganisationNotificationSettings value) { this.notificationSettings = value; return this; }
    }

    public static class OrganisationNotificationSettings implements IIdentifiableResource
    {
        public ArrayList<String> warningNotificationRoles = null;
        public ArrayList<String> jobFinishedNotificationRoles = null;
        public ArrayList<String> userIdBlockList = null;
        public String id = null;
        
        public ArrayList<String> getWarningNotificationRoles() { return warningNotificationRoles; }
        public OrganisationNotificationSettings setWarningNotificationRoles(ArrayList<String> value) { this.warningNotificationRoles = value; return this; }
        public ArrayList<String> getJobFinishedNotificationRoles() { return jobFinishedNotificationRoles; }
        public OrganisationNotificationSettings setJobFinishedNotificationRoles(ArrayList<String> value) { this.jobFinishedNotificationRoles = value; return this; }
        public ArrayList<String> getUserIdBlockList() { return userIdBlockList; }
        public OrganisationNotificationSettings setUserIdBlockList(ArrayList<String> value) { this.userIdBlockList = value; return this; }
        public String getId() { return id; }
        public OrganisationNotificationSettings setId(String value) { this.id = value; return this; }
    }

}

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