Foundry API

<back to all web services

NotificationRolesRequest

Requires Authentication
The following routes are available for this service:
PUT/organisations/{Id}/notification/roles/{ActionType}
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Infrastructure.Api.Interfaces.ServiceOperations.Organisations;
using Infrastructure.Api.Interfaces.ServiceOperations;
using Application.Interfaces.Resources;

namespace Application.Interfaces.Resources
{
    public partial class OrganisationNotificationSettings
        : IIdentifiableResource
    {
        public OrganisationNotificationSettings()
        {
            WarningNotificationRoles = new List<string>{};
            JobFinishedNotificationRoles = new List<string>{};
            UserIdBlockList = new List<string>{};
        }

        public virtual List<string> WarningNotificationRoles { get; set; }
        public virtual List<string> JobFinishedNotificationRoles { get; set; }
        public virtual List<string> UserIdBlockList { get; set; }
        public virtual string Id { get; set; }
    }

}

namespace Infrastructure.Api.Interfaces.ServiceOperations
{
    public partial class PutOperationUnTenanted<TResponse>
        : IPut
    {
    }

}

namespace Infrastructure.Api.Interfaces.ServiceOperations.Organisations
{
    public partial class NotificationRolesRequest
        : PutOperationUnTenanted<NotificationRolesResponse>
    {
        public NotificationRolesRequest()
        {
            Roles = new List<string>{};
        }

        public virtual string Id { get; set; }
        public virtual string ActionType { get; set; }
        public virtual List<string> Roles { get; set; }
    }

    public partial class NotificationRolesResponse
    {
        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual OrganisationNotificationSettings NotificationSettings { get; set; }
    }

}

C# NotificationRolesRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
Content-Type: application/json
Content-Length: length

{"id":"String","actionType":"String","roles":["String"]}
HTTP/1.1 200 OK
Content-Type: application/json
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"}}