Foundry API

<back to all web services

GetOrganisationNotificationSettingsRequest

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

export class GetOperationUnTenanted<TResponse> implements IHasGetOptions, IGet
{
    public embed?: string;

    public constructor(init?: Partial<GetOperationUnTenanted<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 GetOrganisationNotificationSettingsResponse
{
    public responseStatus?: ResponseStatus;
    public notificationSettings?: OrganisationNotificationSettings;

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

export class GetOrganisationNotificationSettingsRequest extends GetOperationUnTenanted<GetOrganisationNotificationSettingsResponse>
{
    public id?: string;

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

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