Platform API

<back to all web services

GetContactNotifications

Get notifications for the specified contact

Requires Authentication
The following routes are available for this service:
All Verbs/api/contact/{ContactId}/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.Causal.Common.Entity;

namespace Eros.Causal.Common.Entity
{
    public partial class InputSwitch
    {
        public virtual string Id { get; set; }
        public virtual string Name { get; set; }
        public virtual bool IsDisabled { get; set; }
        public virtual bool IsChecked { get; set; }
    }

    public partial class NotificationDetails
    {
        public virtual Guid NotificationId { get; set; }
        public virtual string NotificationGroupName { get; set; }
        public virtual Guid NotificationValueId { 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 IsVisibleToRecipients { get; set; }
        public virtual int Index { get; set; }
        public virtual InputSwitch Email { get; set; }
        public virtual InputSwitch SMS { get; set; }
        public virtual InputSwitch UpdateNotification { get; set; }
        public virtual InputSwitch Push { get; set; }
        public virtual InputSwitch Phone { get; set; }
    }

    public partial class NotificationGroup
    {
        public virtual string GroupName { get; set; }
        public virtual List<NotificationDetails> Notifications { get; set; }
    }

}

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

        ///<summary>
        ///Id of licensee to get notifications for
        ///</summary>
        [ApiMember(Description="Id of licensee to get notifications for", IsRequired=true, Name="LicenseeId")]
        public virtual Guid LicenseeId { get; set; }

        ///<summary>
        ///Id of suite to get notifications for
        ///</summary>
        [ApiMember(Description="Id of suite to get notifications for", IsRequired=true, Name="Suite")]
        public virtual Guid SuiteId { get; set; }
    }

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

}

C# GetContactNotifications DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/contact/{ContactId}/notifications HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"ContactId":"00000000-0000-0000-0000-000000000000","LicenseeId":"00000000-0000-0000-0000-000000000000","SuiteId":"00000000-0000-0000-0000-000000000000"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Notifications":[{"GroupName":"String","Notifications":[{"NotificationId":"00000000-0000-0000-0000-000000000000","NotificationGroupName":"String","NotificationValueId":"00000000-0000-0000-0000-000000000000","Name":"String","Description":"String","IsMandatory":false,"IsCardinality":false,"IsSystem":false,"IsVisibleToRecipients":false,"Index":0,"Email":{"Id":"String","Name":"String","IsDisabled":false,"IsChecked":false},"SMS":{"Id":"String","Name":"String","IsDisabled":false,"IsChecked":false},"UpdateNotification":{"Id":"String","Name":"String","IsDisabled":false,"IsChecked":false},"Push":{"Id":"String","Name":"String","IsDisabled":false,"IsChecked":false},"Phone":{"Id":"String","Name":"String","IsDisabled":false,"IsChecked":false}}]}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}