Foundry API

<back to all web services

NotificationRolesRequest

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

Namespace Global

    Namespace Application.Interfaces.Resources

        Public Partial Class OrganisationNotificationSettings
            Implements IIdentifiableResource
            Public Sub New()
                WarningNotificationRoles = New List(Of String)
                JobFinishedNotificationRoles = New List(Of String)
                UserIdBlockList = New List(Of String)
            End Sub

            Public Overridable Property WarningNotificationRoles As List(Of String)
            Public Overridable Property JobFinishedNotificationRoles As List(Of String)
            Public Overridable Property UserIdBlockList As List(Of String)
            Public Overridable Property Id As String
        End Class
    End Namespace

    Namespace Infrastructure.Api.Interfaces.ServiceOperations

        Public Partial Class PutOperationUnTenanted(Of TResponse)
            Implements IPut
        End Class
    End Namespace

    Namespace Infrastructure.Api.Interfaces.ServiceOperations.Organisations

        Public Partial Class NotificationRolesRequest
            Inherits PutOperationUnTenanted(Of NotificationRolesResponse)
            Public Sub New()
                Roles = New List(Of String)
            End Sub

            Public Overridable Property Id As String
            Public Overridable Property ActionType As String
            Public Overridable Property Roles As List(Of String)
        End Class

        Public Partial Class NotificationRolesResponse
            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property NotificationSettings As OrganisationNotificationSettings
        End Class
    End Namespace
End Namespace

VB.NET 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"}}