| GET | /api/automation/notification/{ObjectId}/list | ||
|---|---|---|---|
| GET | /api/automation/notification/{ObjectId}/list/standard | ||
| GET | /api/automation/notification/{ObjectId}/list/templated |
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 AutomationModel() =
///<summary>
///The unique automation Id
///</summary>
[<ApiMember(Description="The unique automation Id", ParameterType="query")>]
member val AutomationId:Guid = new Guid() with get,set
///<summary>
///The automation type Id
///</summary>
[<ApiMember(Description="The automation type Id", ParameterType="query")>]
member val AutomationTypeId:Guid = new Guid() with get,set
///<summary>
///The automation type
///</summary>
[<ApiMember(Description="The automation type", ParameterType="query")>]
member val AutomationType:String = null with get,set
///<summary>
///The object this automation applies to
///</summary>
[<ApiMember(Description="The object this automation applies to", ParameterType="query")>]
member val ObjectId:Guid = new Guid() with get,set
///<summary>
///The object name this automation applies to
///</summary>
[<ApiMember(Description="The object name this automation applies to", ParameterType="query")>]
member val ObjectName:String = null with get,set
///<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")>]
member val RmsTableCtxIdObject:Guid = new Guid() with get,set
///<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")>]
member val RmsTableCtxName:String = null with get,set
///<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")>]
member val ActionList:ResizeArray<Guid> = null with get,set
///<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")>]
member val Actions:String = null with get,set
///<summary>
///Name of the automation.
///</summary>
[<ApiMember(Description="Name of the automation.", ParameterType="query")>]
member val Name:String = null with get,set
///<summary>
///Description of the automation
///</summary>
[<ApiMember(Description="Description of the automation", ParameterType="query")>]
member val Description:String = null with get,set
///<summary>
///Owner Contact Id
///</summary>
[<ApiMember(Description="Owner Contact Id", ParameterType="query")>]
member val OwnerContactId:Guid = new Guid() with get,set
///<summary>
///Record Status of the automation.
///</summary>
[<ApiMember(Description="Record Status of the automation.", ParameterType="query")>]
member val RecordStatus:String = null with get,set
[<AllowNullLiteral>]
type AutoNotificationModel() =
inherit 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")>]
member val ContactIdLicensee:Guid = new Guid() with get,set
///<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")>]
member val ContactRoleGroupId:Guid = new Guid() with get,set
///<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")>]
member val ContactRoleId:Guid = new Guid() with get,set
///<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")>]
member val ContactRoleName:String = null with get,set
///<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")>]
member val ContactId:Guid = new Guid() with get,set
///<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")>]
member val ObjectContactConnectionRequired:Boolean = new Boolean() with get,set
///<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")>]
member val AllowDirectAccess:Boolean = new Boolean() with get,set
///<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")>]
member val SendImmediately:Boolean = new Boolean() with get,set
///<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")>]
member val Batched:Boolean = new Boolean() with get,set
///<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")>]
member val DraftStatus:Boolean = new Boolean() with get,set
///<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")>]
member val FinalStatus:Boolean = new Boolean() with get,set
///<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")>]
member val IncludeReport:Boolean = new Boolean() with get,set
///<summary>
///True if this notification is based on a template.
///</summary>
[<ApiMember(Description="True if this notification is based on a template.", ParameterType="query")>]
member val IsTemplateNotification:Boolean = new Boolean() with get,set
///<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")>]
member val Roles:ResizeArray<Guid> = null with get,set
///<summary>
///Communication Type Id.
///</summary>
[<ApiMember(Description="Communication Type Id.", ParameterType="query")>]
member val CommunicationTypeId:Guid = new Guid() with get,set
///<summary>
///Communication Type.
///</summary>
[<ApiMember(Description="Communication Type.", ParameterType="query")>]
member val CommunicationType:String = null with get,set
///<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")>]
member val Subject:String = null with get,set
///<summary>
///This is the notification details to be sent.
///</summary>
[<ApiMember(Description="This is the notification details to be sent.", ParameterType="query")>]
member val Body:String = null with get,set
///<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")>]
member val IncludeURL:Boolean = new Boolean() with get,set
///<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")>]
member val NotificationId:Guid = new Guid() with get,set
///<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")>]
member val NotificationName:String = null with get,set
///<summary>
///The suite id the notification is setup for
///</summary>
[<ApiMember(Description="The suite id the notification is setup for", ParameterType="query")>]
member val SuiteId:Guid = new Guid() with get,set
///<summary>
///The suite name the notification is setup for
///</summary>
[<ApiMember(Description="The suite name the notification is setup for", ParameterType="query")>]
member val SuiteName:String = null with get,set
[<ApiResponse(Description="List of (automation) notifications that are setup for an object.")>]
[<AllowNullLiteral>]
type GetAutomationNotificationsForObjectResponse() =
///<summary>
///List of (automation) notifications.
///</summary>
[<ApiMember(Description="List of (automation) notifications.")>]
member val Notifications:ResizeArray<AutoNotificationModel> = null with get,set
member val ResponseStatus:ResponseStatus = null with get,set
///<summary>
///Get (automation) notifications that are setup for an object
///</summary>
[<Api(Description="Get (automation) notifications that are setup for an object")>]
[<AllowNullLiteral>]
type GetAutomationNotificationsForObject() =
///<summary>
///Object to retrieve (automation) notifications for.
///</summary>
[<ApiMember(Description="Object to retrieve (automation) notifications for.", ParameterType="path")>]
member val ObjectId:Guid = new Guid() with get,set
F# GetAutomationNotificationsForObject 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.
GET /api/automation/notification/{ObjectId}/list HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: application/xml
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>