Platform API

GetSuiteNotifications

Get notifications for the specified suite

The following routes are available for this service:
All Verbs	/api/suitenotifications

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.Causal.Common.Entity;

namespace Eros.Causal.Common.Entity
{
    public partial class Notification
    {
        public virtual Guid NotificationId { get; set; }
        public virtual Guid NotificationGroupId { get; set; }
        public virtual string NotificationGroupName { get; set; }
        public virtual Guid SuiteId { get; set; }
        public virtual string SuiteName { get; set; }
        public virtual Guid NotificationValueId { get; set; }
        public virtual List<NotificationRole> Roles { get; set; }
        public virtual string RolesToDisplay { get; set; }
        public virtual string Name { get; set; }
        public virtual string Description { get; set; }
        public virtual bool IsMandatory { get; set; }
        public virtual bool IsCardinality { get; set; }
        public virtual bool IsSystem { get; set; }
        public virtual bool IsAudit { get; set; }
        public virtual bool IsVisibleToRecipients { get; set; }
        public virtual bool IsSingleUse { get; set; }
        public virtual bool Email { get; set; }
        public virtual bool EmailDefault { get; set; }
        public virtual Guid EmailTemplateId { get; set; }
        public virtual string EmailTemplateBody { get; set; }
        public virtual string EmailSubject { get; set; }
        public virtual bool SMS { get; set; }
        public virtual bool SMSDefault { get; set; }
        public virtual Guid SMSTemplateId { get; set; }
        public virtual string SMSTemplateBody { get; set; }
        public virtual bool UpdateNotification { get; set; }
        public virtual bool UpdateNotificationDefault { get; set; }
        public virtual Guid UpdateTemplateId { get; set; }
        public virtual string UpdateTemplateBody { get; set; }
        public virtual string UpdateSubject { get; set; }
        public virtual bool Push { get; set; }
        public virtual bool PushDefault { get; set; }
        public virtual bool Phone { get; set; }
        public virtual bool PhoneDefault { get; set; }
        public virtual Guid ContactIdOwner { get; set; }
        public virtual string RecordStatus { get; set; }
        public virtual Guid EmailTemplateDefinitionId { get; set; }
        public virtual Guid SMSTemplateDefinitionId { get; set; }
        public virtual Guid UpdateTemplateDefinitionId { get; set; }
        public virtual int Index { get; set; }
    }

    public partial class NotificationRole
    {
        public virtual Guid RoleId { get; set; }
        public virtual string RoleName { get; set; }
    }

}

namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel
{
    ///<summary>
    ///Get notifications for the specified suite
    ///</summary>
    [Api(Description="Get notifications for the specified suite")]
    public partial class GetSuiteNotifications
    {
        ///<summary>
        ///Id of suite to get notifications for
        ///</summary>
        [ApiMember(Description="Id of suite to get notifications for", IsRequired=true, Name="SuiteId")]
        public virtual Guid SuiteId { get; set; }
    }

    [ApiResponse(Description="List of suite notifications")]
    public partial class GetSuiteNotificationsResponse
    {
        public virtual List<Notification> Notifications { get; set; }
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

}

C# GetSuiteNotifications 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.

POST /api/suitenotifications HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"SuiteId":"00000000-0000-0000-0000-000000000000"}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Notifications":[{"NotificationId":"00000000-0000-0000-0000-000000000000","NotificationGroupId":"00000000-0000-0000-0000-000000000000","NotificationGroupName":"String","SuiteId":"00000000-0000-0000-0000-000000000000","SuiteName":"String","NotificationValueId":"00000000-0000-0000-0000-000000000000","Roles":[{"RoleId":"00000000-0000-0000-0000-000000000000","RoleName":"String"}],"RolesToDisplay":"String","Name":"String","Description":"String","IsMandatory":false,"IsCardinality":false,"IsSystem":false,"IsAudit":false,"IsVisibleToRecipients":false,"IsSingleUse":false,"Email":false,"EmailDefault":false,"EmailTemplateId":"00000000-0000-0000-0000-000000000000","EmailTemplateBody":"String","EmailSubject":"String","SMS":false,"SMSDefault":false,"SMSTemplateId":"00000000-0000-0000-0000-000000000000","SMSTemplateBody":"String","UpdateNotification":false,"UpdateNotificationDefault":false,"UpdateTemplateId":"00000000-0000-0000-0000-000000000000","UpdateTemplateBody":"String","UpdateSubject":"String","Push":false,"PushDefault":false,"Phone":false,"PhoneDefault":false,"ContactIdOwner":"00000000-0000-0000-0000-000000000000","RecordStatus":"String","EmailTemplateDefinitionId":"00000000-0000-0000-0000-000000000000","SMSTemplateDefinitionId":"00000000-0000-0000-0000-000000000000","UpdateTemplateDefinitionId":"00000000-0000-0000-0000-000000000000","Index":0}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}