Platform API

InsertNotification

Inserts a new notification

The following routes are available for this service:
POST	/api/notification/insert

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 NotificationRole() = 
        member val RoleId:Guid = new Guid() with get,set
        member val RoleName:String = null with get,set

    [<AllowNullLiteral>]
    type Notification() = 
        member val NotificationId:Guid = new Guid() with get,set
        member val NotificationGroupId:Guid = new Guid() with get,set
        member val NotificationGroupName:String = null with get,set
        member val SuiteId:Guid = new Guid() with get,set
        member val SuiteName:String = null with get,set
        member val NotificationValueId:Guid = new Guid() with get,set
        member val Roles:ResizeArray<NotificationRole> = null with get,set
        member val RolesToDisplay:String = null 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 IsAudit:Boolean = new Boolean() with get,set
        member val IsVisibleToRecipients:Boolean = new Boolean() with get,set
        member val IsSingleUse:Boolean = new Boolean() with get,set
        member val Email:Boolean = new Boolean() with get,set
        member val EmailDefault:Boolean = new Boolean() with get,set
        member val EmailTemplateId:Guid = new Guid() with get,set
        member val EmailTemplateBody:String = null with get,set
        member val EmailSubject:String = null with get,set
        member val SMS:Boolean = new Boolean() with get,set
        member val SMSDefault:Boolean = new Boolean() with get,set
        member val SMSTemplateId:Guid = new Guid() with get,set
        member val SMSTemplateBody:String = null with get,set
        member val UpdateNotification:Boolean = new Boolean() with get,set
        member val UpdateNotificationDefault:Boolean = new Boolean() with get,set
        member val UpdateTemplateId:Guid = new Guid() with get,set
        member val UpdateTemplateBody:String = null with get,set
        member val UpdateSubject:String = null with get,set
        member val Push:Boolean = new Boolean() with get,set
        member val PushDefault:Boolean = new Boolean() with get,set
        member val Phone:Boolean = new Boolean() with get,set
        member val PhoneDefault:Boolean = new Boolean() with get,set
        member val ContactIdOwner:Guid = new Guid() with get,set
        member val RecordStatus:String = null with get,set
        member val EmailTemplateDefinitionId:Guid = new Guid() with get,set
        member val SMSTemplateDefinitionId:Guid = new Guid() with get,set
        member val UpdateTemplateDefinitionId:Guid = new Guid() with get,set
        member val Index:Int32 = new Int32() with get,set

    ///<summary>
    ///Inserts a new notification
    ///</summary>
    [<Api(Description="Inserts a new notification")>]
    [<AllowNullLiteral>]
    type InsertNotification() = 
        member val Notification:Notification = null with get,set

F# InsertNotification DTOs

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

HTTP + OTHER

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

POST /api/notification/insert HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"Notification":{"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}}

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

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