Foundry API

NotificationRolesRequest

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

import Foundation
import ServiceStack

public class NotificationRolesRequest : PutOperationUnTenanted<NotificationRolesResponse>
{
    public var id:String?
    public var actionType:String?
    public var roles:[String] = []

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case id
        case actionType
        case roles
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        id = try container.decodeIfPresent(String.self, forKey: .id)
        actionType = try container.decodeIfPresent(String.self, forKey: .actionType)
        roles = try container.decodeIfPresent([String].self, forKey: .roles) ?? []
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if id != nil { try container.encode(id, forKey: .id) }
        if actionType != nil { try container.encode(actionType, forKey: .actionType) }
        if roles.count > 0 { try container.encode(roles, forKey: .roles) }
    }
}

public class PutOperationUnTenanted<TResponse : Codable> : IPut, Codable
{
    required public init(){}
}

public class NotificationRolesResponse : Codable
{
    public var responseStatus:ResponseStatus?
    public var notificationSettings:OrganisationNotificationSettings?

    required public init(){}
}

public class OrganisationNotificationSettings : IIdentifiableResource, Codable
{
    public var warningNotificationRoles:[String] = []
    public var jobFinishedNotificationRoles:[String] = []
    public var userIdBlockList:[String] = []
    public var id:String?

    required public init(){}
}

Swift 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: foundrystage-api-app.azurewebsites.net 
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
	}
}