Platform API

GetAutomationNotificationsForObject

Get (automation) notifications that are setup for an object

The following routes are available for this service:
GET	/api/automation/notification/{ObjectId}/list
GET	/api/automation/notification/{ObjectId}/list/standard
GET	/api/automation/notification/{ObjectId}/list/templated

**GetAutomationNotificationsForObject** Parameters:
Name	Parameter	Data Type	Required	Description
ObjectId	path	Guid	No	Object to retrieve (automation) notifications for.

**GetAutomationNotificationsForObjectResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Notifications	form	List<AutoNotificationModel>	No	List of (automation) notifications.
ResponseStatus	form	ResponseStatus	No

**AutoNotificationModel** Parameters:
Name	Parameter	Data Type	Required	Description
ContactIdLicensee	query	Guid	No	Contact Id of the licensee this notification has been created for.
ContactRoleGroupId	query	Guid	No	Contact Role Group Id. If the notification is setup for people in a specified contact role group.
ContactRoleId	query	Guid	No	Contact Role Id. If the notification is setup for people in a specified role.
ContactRoleName	query	string	No	Contact Role Name. If the notification is setup for people in a specified role.
ContactId	query	Guid	No	Contact Id. If the notification is setup for a specific person.
ObjectContactConnectionRequired	query	bool	No	If true, then only contacts who are connected to the relevant object are notified.
AllowDirectAccess	query	bool	No	Document Notification: If true, then the notification will include a link to download the document.
SendImmediately	query	bool	No	If true, the notification is sent as soon as it can be processed
Batched	query	bool	No	If true, the notification is flagged and sent out when subscription/batch emails are next sent.
DraftStatus	query	bool	No	Document Notification: If true, the notification is sent when a document has a status of draft.
FinalStatus	query	bool	No	Document Notification: If true, the notification is sent when a document has a status of final.
IncludeReport	query	bool	No	True if we want to include a report on an email notification.
IsTemplateNotification	query	bool	No	True if this notification is based on a template.
Roles	query	List<Guid>	No	When Inserting a new notification we can have 1+ roles. They should be passed to this field when inserting.
CommunicationTypeId	query	Guid	No	Communication Type Id.
CommunicationType	query	string	No	Communication Type.
Subject	query	string	No	If communication type is email, this is the subject of the email to be sent.
Body	query	string	No	This is the notification details to be sent.
IncludeURL	query	bool	No	If true, we will include the relevant project URL in the notification.
NotificationId	query	Guid	No	The notification Id of a notification setup in Workflow Notification Management to use for the notification.
NotificationName	query	string	No	The notification nameof a notification setup in Workflow Notification Management to use for the notification.
SuiteId	query	Guid	No	The suite id the notification is setup for
SuiteName	query	string	No	The suite name the notification is setup for

**AutomationModel** Parameters:
Name	Parameter	Data Type	Required	Description
AutomationId	query	Guid	No	The unique automation Id
AutomationTypeId	query	Guid	No	The automation type Id
AutomationType	query	string	No	The automation type
ObjectId	query	Guid	No	The object this automation applies to
ObjectName	query	string	No	The object name this automation applies to
RmsTableCtxIdObject	query	Guid	No	The Id of the object type that this automation applies to.
RmsTableCtxName	query	string	No	The name of the object type that this automation applies to.
ActionList	query	List<Guid>	No	A guid list containing the selected system action Id's that trigger this automation.
Actions	query	string	No	A comma separated string of the selected system action names that trigger this automation.
Name	query	string	No	Name of the automation.
Description	query	string	No	Description of the automation
OwnerContactId	query	Guid	No	Owner Contact Id
RecordStatus	query	string	No	Record Status of the automation.

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

HTTP + 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>