Platform API

<back to all web services

GetRolesForAutomationNotifications

Get eligible roles for automation notifications

using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Eros.Subtle.Canvara.WebAPIModel.ServiceModel;
using Eros.Saguna.Common.WebAPIModel.Models;

namespace Eros.Saguna.Common.WebAPIModel.Models
{
    public partial class GroupedListItemModel
    {
        public virtual Guid ListItemId { get; set; }
        public virtual string Name { get; set; }
        public virtual Guid GroupId { get; set; }
        public virtual string GroupName { get; set; }
    }

}

namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel
{
    ///<summary>
    ///Get eligible roles for automation notifications
    ///</summary>
    [Api(Description="Get eligible roles for automation notifications")]
    [ApiResponse(Description="A list of roles that are eligible to be assigned to a notification.")]
    public partial class GetRolesForAutomationNotifications
        : GetRolesForAutomationNotificationsResponse
    {
        ///<summary>
        ///Object the notification will be for. Used to exclude any currently assigned roles.
        ///</summary>
        [ApiMember(Description="Object the notification will be for. Used to exclude any currently assigned roles.", ParameterType="path")]
        public virtual Guid ObjectId { get; set; }
    }

    [ApiResponse(Description="A list of roles that are eligible to be assigned to a notification.")]
    public partial class GetRolesForAutomationNotificationsResponse
    {
        ///<summary>
        ///List of all roles (grouped by suite) that can be assigned to a notification.
        ///</summary>
        [ApiMember(Description="List of all roles (grouped by suite) that can be assigned to a notification.")]
        public virtual List<GroupedListItemModel> AllRoles { get; set; }

        ///<summary>
        ///List of roles that are already assigned to an email notification for the object, these should be excluded from being selected again.
        ///</summary>
        [ApiMember(Description="List of roles that are already assigned to an email notification for the object, these should be excluded from being selected again.")]
        public virtual List<Guid> RolesUsedEmail { get; set; }

        ///<summary>
        ///List of roles that are already assigned to an sms notification for the object, these should be excluded from being selected again.
        ///</summary>
        [ApiMember(Description="List of roles that are already assigned to an sms notification for the object, these should be excluded from being selected again.")]
        public virtual List<Guid> RolesUsedSMS { get; set; }

        public virtual ResponseStatus ResponseStatus { get; set; }
    }

}

C# GetRolesForAutomationNotifications DTOs

GET /api/automation/notification/{ObjectId}/roles HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	AllRoles: 
	[
		{
			Name: String,
			GroupName: String
		}
	],
	RolesUsedEmail: 
	[
		00000000-0000-0000-0000-000000000000
	],
	RolesUsedSMS: 
	[
		00000000-0000-0000-0000-000000000000
	],
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}