Foundry API

NotificationRolesRequest

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


export class PutOperationUnTenanted<TResponse> implements IPut
{

    public constructor(init?: Partial<PutOperationUnTenanted<TResponse>>) { (Object as any).assign(this, init); }
}

export class OrganisationNotificationSettings implements IIdentifiableResource
{
    public warningNotificationRoles?: string[];
    public jobFinishedNotificationRoles?: string[];
    public userIdBlockList?: string[];
    public id?: string;

    public constructor(init?: Partial<OrganisationNotificationSettings>) { (Object as any).assign(this, init); }
}

export class NotificationRolesResponse
{
    public responseStatus?: ResponseStatus;
    public notificationSettings?: OrganisationNotificationSettings;

    public constructor(init?: Partial<NotificationRolesResponse>) { (Object as any).assign(this, init); }
}

export class NotificationRolesRequest extends PutOperationUnTenanted<NotificationRolesResponse>
{
    public id?: string;
    public actionType?: string;
    public roles?: string[];

    public constructor(init?: Partial<NotificationRolesRequest>) { super(init); (Object as any).assign(this, init); }
}

TypeScript 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: staging-api.foundrylab.com 
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
	}
}