Foundry API

<back to all web services

GetOrganisationNotificationSettingsRequest

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

public class dtos
{

    public static class GetOrganisationNotificationSettingsRequest extends GetOperationUnTenanted<GetOrganisationNotificationSettingsResponse>
    {
        public String id = null;
        
        public String getId() { return id; }
        public GetOrganisationNotificationSettingsRequest setId(String value) { this.id = value; return this; }
    }

    public static class GetOperationUnTenanted<TResponse> implements IHasGetOptions, IGet
    {
        public String embed = null;
        
        public String getEmbed() { return embed; }
        public GetOperationUnTenanted<TResponse> setEmbed(String value) { this.embed = value; return this; }
    }

    public static class GetOrganisationNotificationSettingsResponse
    {
        public ResponseStatus responseStatus = null;
        public OrganisationNotificationSettings notificationSettings = null;
        
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public GetOrganisationNotificationSettingsResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
        public OrganisationNotificationSettings getNotificationSettings() { return notificationSettings; }
        public GetOrganisationNotificationSettingsResponse 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 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
	}
}