Platform API

GetContactNotifications

Get notifications for the specified contact

The following routes are available for this service:
All Verbs	/api/contact/{ContactId}/notifications

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 InputSwitch() = 
        member val Id:String = null with get,set
        member val Name:String = null with get,set
        member val IsDisabled:Boolean = new Boolean() with get,set
        member val IsChecked:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type NotificationDetails() = 
        member val NotificationId:Guid = new Guid() with get,set
        member val NotificationGroupName:String = null with get,set
        member val NotificationValueId:Guid = new Guid() with get,set
        member val Name:String = null with get,set
        member val Description:String = null with get,set
        member val IsMandatory:Boolean = new Boolean() with get,set
        member val IsCardinality:Boolean = new Boolean() with get,set
        member val IsSystem:Boolean = new Boolean() with get,set
        member val IsVisibleToRecipients:Boolean = new Boolean() with get,set
        member val Index:Int32 = new Int32() with get,set
        member val Email:InputSwitch = null with get,set
        member val SMS:InputSwitch = null with get,set
        member val UpdateNotification:InputSwitch = null with get,set
        member val Push:InputSwitch = null with get,set
        member val Phone:InputSwitch = null with get,set

    [<AllowNullLiteral>]
    type NotificationGroup() = 
        member val GroupName:String = null with get,set
        member val Notifications:ResizeArray<NotificationDetails> = null with get,set

    [<ApiResponse(Description="List of contact notifications")>]
    [<AllowNullLiteral>]
    type GetContactNotificationsResponse() = 
        member val Notifications:ResizeArray<NotificationGroup> = null with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

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

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

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

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