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
namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type NotificationItem() = 
        member val Id:Guid = new Guid() with get,set
        member val Name:String = null with get,set

    ///<summary>
    ///Updates contact notifications
    ///</summary>
    [<Api(Description="Updates contact notifications")>]
    [<AllowNullLiteral>]
    type UpdateContactNotifications() = 
        ///<summary>
        ///Id of contact to get notification for
        ///</summary>
        [<ApiMember(Description="Id of contact to get notification for", IsRequired=true, Name="ContactId")>]
        member val ContactId:Guid = new Guid() with get,set

        ///<summary>
        ///Id of licensee to get notification for
        ///</summary>
        [<ApiMember(Description="Id of licensee to get notification for", IsRequired=true, Name="LicenseeId")>]
        member val LicenseeId:Guid = new Guid() with get,set

        ///<summary>
        ///Id of suite to get notification for
        ///</summary>
        [<ApiMember(Description="Id of suite to get notification for", IsRequired=true, Name="SuiteId")>]
        member val SuiteId:Guid = new Guid() with get,set

        ///<summary>
        ///List of notification to update
        ///</summary>
        [<ApiMember(Description="List of notification to update", IsRequired=true, Name="Notifications")>]
        member val Notifications:ResizeArray<NotificationItem> = null with get,set

F# 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"}}