Platform API

<back to all web services

UpdateContactNotifications

Updates contact notifications

Requires Authentication
The following routes are available for this service:
PUT/api/contact/{ContactId}/updatenotifications
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 NotificationItem
    {
        public virtual Guid Id { get; set; }
        public virtual string Name { get; set; }
    }

}

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

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

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

        ///<summary>
        ///List of notification to update
        ///</summary>
        [ApiMember(Description="List of notification to update", IsRequired=true, Name="Notifications")]
        public virtual List<NotificationItem> Notifications { get; set; } = [];
    }

}

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

PUT /api/contact/{ContactId}/updatenotifications HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"ContactId":"00000000-0000-0000-0000-000000000000","LicenseeId":"00000000-0000-0000-0000-000000000000","SuiteId":"00000000-0000-0000-0000-000000000000","Notifications":[{"Id":"00000000-0000-0000-0000-000000000000","Name":"String"}]}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}