API to fetch a list of email notifications that can be assigned to an Event.

Availability

Adobe Connect 9.5.4

Description

The API returns a list of the email notifications that can be assigned to an Event.

Request URL

http://example.com/api/xml?action=notification-list
&sco-id=integer
&target-acl-id=integer
&sort1-email-subject=string

Parameters

Name

Type

Required

Description

sco-id

Integer

Yes

The unique ID of the Event SCO.

target-acl-id

Integer

Yes

The ID of the Event SCO for which the user wants the field information.

Filters

You can filter or sort the response on any element or attribute it contains.

Name

Type

Required

Description

sort1-email-subject

String

desc/asc

Sort results by the specified field, in either ascending or descending order.

Response values

Element

Attribute

Type

Description

results

 

Container

All results the action returns.

status

 

Empty, with attributes

The status of the response.

 

code

Allowed value

A code indicating the response status (see status).

notification-list

 

Container

List of email notification.

notification

 

Container

Information about the email notification .

 

action-id

Integer

The ID specifying the email notification.

 

target-acl-id

Integer

The ID of the Event Sco for which you want field information.

 

action-type-id

Integer

Action type

 

status

String

Status of an action. Most common values are completed, aborted, in-progress, retry, new, and error

 

template-id

Integer

Email Template ID of a notification

 

zone-id

String

Different service regions correspond to different server zones

 

date-scheduled

Datetime

Date on which action to be executed

 

notification-sent

Boolean

A flag indication notification is sent or not

 

cq-template-name

String

CQ template name used to send email

 

cq-template-path

String

URI of the cq template

 

email-subject

String

Subject used in email

 

seq-number

String

Sequence number of custom email trigger

 

cq-email-template

Integer

ID of CQ template

Response structure

<results>
<status code="ok"/>
<notification-list>
    <notification target-acl-id="integer" action-id="integer" action-type-id="string" status="action-status" template-id="string" zone-id="string">
        <date-scheduled>datetime</date-scheduled>
        <notification-sent>boolean</notification-sent>
        <cq-template-name>string</cq-template-name>
        <cq-template-path>string</cq-template-path>
        <email-subject>string</email-subject>
        <seq-number>integer</seq-number>
        <cq-email-template>integer</cq-email-template>
    </notification>
    ...
</notification-list>
</results>

Sample request

http://example.com/api/xml?action=notification-list&sco-id=13902&target-acl-id=13902&sort1-email-subject=desc

Sample response

<results>
<status code="ok"/>
<notification-list>
    <notification target-acl-id="13902" action-id="14013" action-type-id="notification" status="aborted" template-id="event-custom" zone-id="usa-prod">
        <date-scheduled>2015-10-22T21:48:48.850-07:00</date-scheduled>
        <notification-sent>false</notification-sent>
        <cq-template-name>Event Update</cq-template-name>
        <cq-template-path>en/events/email/shared/update</cq-template-path>
        <email-subject>Update on {event-name}</email-subject>
        <seq-number>1</seq-number>
        <cq-email-template>11037</cq-email-template>
    </notification>
    ...
</notification-list>
</results>

This work is licensed under a Creative Commons Attribution-Noncommercial-Share Alike 3.0 Unported License  Twitter™ and Facebook posts are not covered under the terms of Creative Commons.

Legal Notices   |   Online Privacy Policy