Foundry API

<back to all web services

GetOrganisationNotificationSettingsRequest

Requires Authentication
The following routes are available for this service:
GET/organisations/{Id}/notification-settings
namespace Application.Interfaces.Resources

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type OrganisationNotificationSettings() = 
        member val WarningNotificationRoles:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val JobFinishedNotificationRoles:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val UserIdBlockList:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val Id:String = null with get,set

    [<AllowNullLiteral>]
    type GetOrganisationNotificationSettingsResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val NotificationSettings:OrganisationNotificationSettings = null with get,set

    [<AllowNullLiteral>]
    type GetOrganisationNotificationSettingsRequest() = 
        inherit GetOperationUnTenanted<GetOrganisationNotificationSettingsResponse>()
        member val Id:String = null with get,set

    [<AllowNullLiteral>]
    type GetOperationUnTenanted<'TResponse>() = 
        interface IGet
        member val Embed:String = null with get,set

F# GetOrganisationNotificationSettingsRequest 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.

GET /organisations/{Id}/notification-settings HTTP/1.1 
Host: foundrystage-api-app.azurewebsites.net 
Accept: application/json

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