| PUT | /api/automation/notification/{AutomationId} | ||
|---|---|---|---|
| POST | /api/automation/notification |
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.Saguna.Common.WebAPIModel.Models
Namespace Global
Namespace Eros.Saguna.Common.WebAPIModel.Models
Public Partial Class AutomationModel
'''<Summary>
'''The unique automation Id
'''</Summary>
<ApiMember(Description:="The unique automation Id", ParameterType:="query")>
Public Overridable Property AutomationId As Guid
'''<Summary>
'''The automation type Id
'''</Summary>
<ApiMember(Description:="The automation type Id", ParameterType:="query")>
Public Overridable Property AutomationTypeId As Guid
'''<Summary>
'''The automation type
'''</Summary>
<ApiMember(Description:="The automation type", ParameterType:="query")>
Public Overridable Property AutomationType As String
'''<Summary>
'''The object this automation applies to
'''</Summary>
<ApiMember(Description:="The object this automation applies to", ParameterType:="query")>
Public Overridable Property ObjectId As Guid
'''<Summary>
'''The object name this automation applies to
'''</Summary>
<ApiMember(Description:="The object name this automation applies to", ParameterType:="query")>
Public Overridable Property ObjectName As String
'''<Summary>
'''The Id of the object type that this automation applies to.
'''</Summary>
<ApiMember(Description:="The Id of the object type that this automation applies to. ", ParameterType:="query")>
Public Overridable Property RmsTableCtxIdObject As Guid
'''<Summary>
'''The name of the object type that this automation applies to.
'''</Summary>
<ApiMember(Description:="The name of the object type that this automation applies to.", ParameterType:="query")>
Public Overridable Property RmsTableCtxName As String
'''<Summary>
'''A guid list containing the selected system action Id's that trigger this automation.
'''</Summary>
<ApiMember(Description:="A guid list containing the selected system action Id's that trigger this automation.", ParameterType:="query")>
Public Overridable Property ActionList As List(Of Guid)
'''<Summary>
'''A comma separated string of the selected system action names that trigger this automation.
'''</Summary>
<ApiMember(Description:="A comma separated string of the selected system action names that trigger this automation.", ParameterType:="query")>
Public Overridable Property Actions As String
'''<Summary>
'''Name of the automation.
'''</Summary>
<ApiMember(Description:="Name of the automation.", ParameterType:="query")>
Public Overridable Property Name As String
'''<Summary>
'''Description of the automation
'''</Summary>
<ApiMember(Description:="Description of the automation", ParameterType:="query")>
Public Overridable Property Description As String
'''<Summary>
'''Owner Contact Id
'''</Summary>
<ApiMember(Description:="Owner Contact Id", ParameterType:="query")>
Public Overridable Property OwnerContactId As Guid
'''<Summary>
'''Record Status of the automation.
'''</Summary>
<ApiMember(Description:="Record Status of the automation.", ParameterType:="query")>
Public Overridable Property RecordStatus As String
End Class
Public Partial Class AutoNotificationModel
Inherits AutomationModel
'''<Summary>
'''Contact Id of the licensee this notification has been created for.
'''</Summary>
<ApiMember(Description:="Contact Id of the licensee this notification has been created for.", ParameterType:="query")>
Public Overridable Property ContactIdLicensee As Guid
'''<Summary>
'''Contact Role Group Id. If the notification is setup for people in a specified contact role group.
'''</Summary>
<ApiMember(Description:="Contact Role Group Id. If the notification is setup for people in a specified contact role group.", ParameterType:="query")>
Public Overridable Property ContactRoleGroupId As Guid
'''<Summary>
'''Contact Role Id. If the notification is setup for people in a specified role.
'''</Summary>
<ApiMember(Description:="Contact Role Id. If the notification is setup for people in a specified role.", ParameterType:="query")>
Public Overridable Property ContactRoleId As Guid
'''<Summary>
'''Contact Role Name. If the notification is setup for people in a specified role.
'''</Summary>
<ApiMember(Description:="Contact Role Name. If the notification is setup for people in a specified role.", ParameterType:="query")>
Public Overridable Property ContactRoleName As String
'''<Summary>
'''Contact Id. If the notification is setup for a specific person.
'''</Summary>
<ApiMember(Description:="Contact Id. If the notification is setup for a specific person.", ParameterType:="query")>
Public Overridable Property ContactId As Guid
'''<Summary>
'''If true, then only contacts who are connected to the relevant object are notified.
'''</Summary>
<ApiMember(Description:="If true, then only contacts who are connected to the relevant object are notified.", ParameterType:="query")>
Public Overridable Property ObjectContactConnectionRequired As Boolean
'''<Summary>
'''Document Notification: If true, then the notification will include a link to download the document.
'''</Summary>
<ApiMember(Description:="Document Notification: If true, then the notification will include a link to download the document.", ParameterType:="query")>
Public Overridable Property AllowDirectAccess As Boolean
'''<Summary>
'''If true, the notification is sent as soon as it can be processed
'''</Summary>
<ApiMember(Description:="If true, the notification is sent as soon as it can be processed", ParameterType:="query")>
Public Overridable Property SendImmediately As Boolean
'''<Summary>
'''If true, the notification is flagged and sent out when subscription/batch emails are next sent.
'''</Summary>
<ApiMember(Description:="If true, the notification is flagged and sent out when subscription/batch emails are next sent.", ParameterType:="query")>
Public Overridable Property Batched As Boolean
'''<Summary>
'''Document Notification: If true, the notification is sent when a document has a status of draft.
'''</Summary>
<ApiMember(Description:="Document Notification: If true, the notification is sent when a document has a status of draft.", ParameterType:="query")>
Public Overridable Property DraftStatus As Boolean
'''<Summary>
'''Document Notification: If true, the notification is sent when a document has a status of final.
'''</Summary>
<ApiMember(Description:="Document Notification: If true, the notification is sent when a document has a status of final.", ParameterType:="query")>
Public Overridable Property FinalStatus As Boolean
'''<Summary>
'''True if we want to include a report on an email notification.
'''</Summary>
<ApiMember(Description:="True if we want to include a report on an email notification. ", ParameterType:="query")>
Public Overridable Property IncludeReport As Boolean
'''<Summary>
'''True if this notification is based on a template.
'''</Summary>
<ApiMember(Description:="True if this notification is based on a template.", ParameterType:="query")>
Public Overridable Property IsTemplateNotification As Boolean
'''<Summary>
'''When Inserting a new notification we can have 1+ roles. They should be passed to this field when inserting.
'''</Summary>
<ApiMember(Description:="When Inserting a new notification we can have 1+ roles. They should be passed to this field when inserting.", ParameterType:="query")>
Public Overridable Property Roles As List(Of Guid)
'''<Summary>
'''Communication Type Id.
'''</Summary>
<ApiMember(Description:="Communication Type Id.", ParameterType:="query")>
Public Overridable Property CommunicationTypeId As Guid
'''<Summary>
'''Communication Type.
'''</Summary>
<ApiMember(Description:="Communication Type.", ParameterType:="query")>
Public Overridable Property CommunicationType As String
'''<Summary>
'''If communication type is email, this is the subject of the email to be sent.
'''</Summary>
<ApiMember(Description:="If communication type is email, this is the subject of the email to be sent.", ParameterType:="query")>
Public Overridable Property Subject As String
'''<Summary>
'''This is the notification details to be sent.
'''</Summary>
<ApiMember(Description:="This is the notification details to be sent.", ParameterType:="query")>
Public Overridable Property Body As String
'''<Summary>
'''If true, we will include the relevant project URL in the notification.
'''</Summary>
<ApiMember(Description:="If true, we will include the relevant project URL in the notification.", ParameterType:="query")>
Public Overridable Property IncludeURL As Boolean
'''<Summary>
'''The notification Id of a notification setup in Workflow Notification Management to use for the notification.
'''</Summary>
<ApiMember(Description:="The notification Id of a notification setup in Workflow Notification Management to use for the notification.", ParameterType:="query")>
Public Overridable Property NotificationId As Guid
'''<Summary>
'''The notification nameof a notification setup in Workflow Notification Management to use for the notification.
'''</Summary>
<ApiMember(Description:="The notification nameof a notification setup in Workflow Notification Management to use for the notification.", ParameterType:="query")>
Public Overridable Property NotificationName As String
'''<Summary>
'''The suite id the notification is setup for
'''</Summary>
<ApiMember(Description:="The suite id the notification is setup for", ParameterType:="query")>
Public Overridable Property SuiteId As Guid
'''<Summary>
'''The suite name the notification is setup for
'''</Summary>
<ApiMember(Description:="The suite name the notification is setup for", ParameterType:="query")>
Public Overridable Property SuiteName As String
End Class
End Namespace
Namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel
<ApiResponse(Description:="List of (automation) notifications that are setup for an object.")>
Public Partial Class GetAutomationNotificationsForObjectResponse
'''<Summary>
'''List of (automation) notifications.
'''</Summary>
<ApiMember(Description:="List of (automation) notifications.")>
Public Overridable Property Notifications As List(Of AutoNotificationModel)
Public Overridable Property ResponseStatus As ResponseStatus
End Class
'''<Summary>
'''Add or update an (automation) notification for an object
'''</Summary>
<Api(Description:="Add or update an (automation) notification for an object")>
Public Partial Class SaveAutoNotification
'''<Summary>
'''Details of the (automation) notification to be added or updated.
'''</Summary>
<ApiMember(Description:="Details of the (automation) notification to be added or updated.", ParameterType:="query")>
Public Overridable Property Notification As AutoNotificationModel
'''<Summary>
'''Id of the automation.
'''</Summary>
<ApiMember(Description:="Id of the automation.", ParameterType:="path")>
Public Overridable Property AutomationId As Guid
End Class
End Namespace
End Namespace
VB.NET SaveAutoNotification DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/automation/notification HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<SaveAutoNotification xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
<AutomationId>00000000-0000-0000-0000-000000000000</AutomationId>
<Notification xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPIModel.Models">
<d2p1:ActionList xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:guid>00000000-0000-0000-0000-000000000000</d3p1:guid>
</d2p1:ActionList>
<d2p1:Actions>String</d2p1:Actions>
<d2p1:AutomationId>00000000-0000-0000-0000-000000000000</d2p1:AutomationId>
<d2p1:AutomationType>String</d2p1:AutomationType>
<d2p1:AutomationTypeId>00000000-0000-0000-0000-000000000000</d2p1:AutomationTypeId>
<d2p1:Description>String</d2p1:Description>
<d2p1:Name>String</d2p1:Name>
<d2p1:ObjectId>00000000-0000-0000-0000-000000000000</d2p1:ObjectId>
<d2p1:ObjectName>String</d2p1:ObjectName>
<d2p1:OwnerContactId>00000000-0000-0000-0000-000000000000</d2p1:OwnerContactId>
<d2p1:RecordStatus>String</d2p1:RecordStatus>
<d2p1:RmsTableCtxIdObject>00000000-0000-0000-0000-000000000000</d2p1:RmsTableCtxIdObject>
<d2p1:RmsTableCtxName>String</d2p1:RmsTableCtxName>
<d2p1:AllowDirectAccess>false</d2p1:AllowDirectAccess>
<d2p1:Batched>false</d2p1:Batched>
<d2p1:Body>String</d2p1:Body>
<d2p1:CommunicationType>String</d2p1:CommunicationType>
<d2p1:CommunicationTypeId>00000000-0000-0000-0000-000000000000</d2p1:CommunicationTypeId>
<d2p1:ContactId>00000000-0000-0000-0000-000000000000</d2p1:ContactId>
<d2p1:ContactIdLicensee>00000000-0000-0000-0000-000000000000</d2p1:ContactIdLicensee>
<d2p1:ContactRoleGroupId>00000000-0000-0000-0000-000000000000</d2p1:ContactRoleGroupId>
<d2p1:ContactRoleId>00000000-0000-0000-0000-000000000000</d2p1:ContactRoleId>
<d2p1:ContactRoleName>String</d2p1:ContactRoleName>
<d2p1:DraftStatus>false</d2p1:DraftStatus>
<d2p1:FinalStatus>false</d2p1:FinalStatus>
<d2p1:IncludeReport>false</d2p1:IncludeReport>
<d2p1:IncludeURL>false</d2p1:IncludeURL>
<d2p1:IsTemplateNotification>false</d2p1:IsTemplateNotification>
<d2p1:NotificationId>00000000-0000-0000-0000-000000000000</d2p1:NotificationId>
<d2p1:NotificationName>String</d2p1:NotificationName>
<d2p1:ObjectContactConnectionRequired>false</d2p1:ObjectContactConnectionRequired>
<d2p1:Roles xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:guid>00000000-0000-0000-0000-000000000000</d3p1:guid>
</d2p1:Roles>
<d2p1:SendImmediately>false</d2p1:SendImmediately>
<d2p1:Subject>String</d2p1:Subject>
<d2p1:SuiteId>00000000-0000-0000-0000-000000000000</d2p1:SuiteId>
<d2p1:SuiteName>String</d2p1:SuiteName>
</Notification>
</SaveAutoNotification>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<GetAutomationNotificationsForObjectResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
<Notifications xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPIModel.Models">
<d2p1:AutoNotificationModel>
<d2p1:ActionList xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:guid>00000000-0000-0000-0000-000000000000</d4p1:guid>
</d2p1:ActionList>
<d2p1:Actions>String</d2p1:Actions>
<d2p1:AutomationId>00000000-0000-0000-0000-000000000000</d2p1:AutomationId>
<d2p1:AutomationType>String</d2p1:AutomationType>
<d2p1:AutomationTypeId>00000000-0000-0000-0000-000000000000</d2p1:AutomationTypeId>
<d2p1:Description>String</d2p1:Description>
<d2p1:Name>String</d2p1:Name>
<d2p1:ObjectId>00000000-0000-0000-0000-000000000000</d2p1:ObjectId>
<d2p1:ObjectName>String</d2p1:ObjectName>
<d2p1:OwnerContactId>00000000-0000-0000-0000-000000000000</d2p1:OwnerContactId>
<d2p1:RecordStatus>String</d2p1:RecordStatus>
<d2p1:RmsTableCtxIdObject>00000000-0000-0000-0000-000000000000</d2p1:RmsTableCtxIdObject>
<d2p1:RmsTableCtxName>String</d2p1:RmsTableCtxName>
<d2p1:AllowDirectAccess>false</d2p1:AllowDirectAccess>
<d2p1:Batched>false</d2p1:Batched>
<d2p1:Body>String</d2p1:Body>
<d2p1:CommunicationType>String</d2p1:CommunicationType>
<d2p1:CommunicationTypeId>00000000-0000-0000-0000-000000000000</d2p1:CommunicationTypeId>
<d2p1:ContactId>00000000-0000-0000-0000-000000000000</d2p1:ContactId>
<d2p1:ContactIdLicensee>00000000-0000-0000-0000-000000000000</d2p1:ContactIdLicensee>
<d2p1:ContactRoleGroupId>00000000-0000-0000-0000-000000000000</d2p1:ContactRoleGroupId>
<d2p1:ContactRoleId>00000000-0000-0000-0000-000000000000</d2p1:ContactRoleId>
<d2p1:ContactRoleName>String</d2p1:ContactRoleName>
<d2p1:DraftStatus>false</d2p1:DraftStatus>
<d2p1:FinalStatus>false</d2p1:FinalStatus>
<d2p1:IncludeReport>false</d2p1:IncludeReport>
<d2p1:IncludeURL>false</d2p1:IncludeURL>
<d2p1:IsTemplateNotification>false</d2p1:IsTemplateNotification>
<d2p1:NotificationId>00000000-0000-0000-0000-000000000000</d2p1:NotificationId>
<d2p1:NotificationName>String</d2p1:NotificationName>
<d2p1:ObjectContactConnectionRequired>false</d2p1:ObjectContactConnectionRequired>
<d2p1:Roles xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:guid>00000000-0000-0000-0000-000000000000</d4p1:guid>
</d2p1:Roles>
<d2p1:SendImmediately>false</d2p1:SendImmediately>
<d2p1:Subject>String</d2p1:Subject>
<d2p1:SuiteId>00000000-0000-0000-0000-000000000000</d2p1:SuiteId>
<d2p1:SuiteName>String</d2p1:SuiteName>
</d2p1:AutoNotificationModel>
</Notifications>
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d2p1:Meta>
</ResponseStatus>
</GetAutomationNotificationsForObjectResponse>