| All Verbs | /api/suitenotifications |
|---|
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Eros.Subtle.Canvara.WebAPIModel.ServiceModel
Imports Eros.Causal.Common.Entity
Namespace Global
Namespace Eros.Causal.Common.Entity
Public Partial Class Notification
Public Overridable Property NotificationId As Guid
Public Overridable Property NotificationGroupId As Guid
Public Overridable Property NotificationGroupName As String
Public Overridable Property SuiteId As Guid
Public Overridable Property SuiteName As String
Public Overridable Property NotificationValueId As Guid
Public Overridable Property Roles As List(Of NotificationRole)
Public Overridable Property RolesToDisplay As String
Public Overridable Property Name As String
Public Overridable Property Description As String
Public Overridable Property IsMandatory As Boolean
Public Overridable Property IsCardinality As Boolean
Public Overridable Property IsSystem As Boolean
Public Overridable Property IsAudit As Boolean
Public Overridable Property IsVisibleToRecipients As Boolean
Public Overridable Property IsSingleUse As Boolean
Public Overridable Property Email As Boolean
Public Overridable Property EmailDefault As Boolean
Public Overridable Property EmailTemplateId As Guid
Public Overridable Property EmailTemplateBody As String
Public Overridable Property EmailSubject As String
Public Overridable Property SMS As Boolean
Public Overridable Property SMSDefault As Boolean
Public Overridable Property SMSTemplateId As Guid
Public Overridable Property SMSTemplateBody As String
Public Overridable Property UpdateNotification As Boolean
Public Overridable Property UpdateNotificationDefault As Boolean
Public Overridable Property UpdateTemplateId As Guid
Public Overridable Property UpdateTemplateBody As String
Public Overridable Property UpdateSubject As String
Public Overridable Property Push As Boolean
Public Overridable Property PushDefault As Boolean
Public Overridable Property Phone As Boolean
Public Overridable Property PhoneDefault As Boolean
Public Overridable Property ContactIdOwner As Guid
Public Overridable Property RecordStatus As String
Public Overridable Property EmailTemplateDefinitionId As Guid
Public Overridable Property SMSTemplateDefinitionId As Guid
Public Overridable Property UpdateTemplateDefinitionId As Guid
Public Overridable Property Index As Integer
End Class
Public Partial Class NotificationRole
Public Overridable Property RoleId As Guid
Public Overridable Property RoleName As String
End Class
End Namespace
Namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel
'''<Summary>
'''Get notifications for the specified suite
'''</Summary>
<Api(Description:="Get notifications for the specified suite")>
Public Partial Class GetSuiteNotifications
'''<Summary>
'''Id of suite to get notifications for
'''</Summary>
<ApiMember(Description:="Id of suite to get notifications for", IsRequired:=true, Name:="SuiteId")>
Public Overridable Property SuiteId As Guid
End Class
<ApiResponse(Description:="List of suite notifications")>
Public Partial Class GetSuiteNotificationsResponse
Public Overridable Property Notifications As List(Of Notification)
Public Overridable Property ResponseStatus As ResponseStatus
End Class
End Namespace
End Namespace
VB.NET GetSuiteNotifications DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/suitenotifications HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"SuiteId":"00000000-0000-0000-0000-000000000000"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"Notifications":[{"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}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}