Nortel Networks Broadcast Server warranty ManageDistributionLists

Page 76

Appendix A Push XML API

Push XML Reference

ManageDistributionLists

The following sample XML for ManageDistributionLists and its child elements illustrates creating the distribution list named “accounting” and adding several devices to that list.

<ManageDistributionLists>

<DistributionList id="2" name="accounting" action="create"> </DistributionList>

<DistributionList id="2" name="accounting" action="add"> <Member device_id="000E8349D6ED"/>

<Member device_id="0009B7F3FA1D"/> <Member device_id="000821381711"/>

</DistributionList>

</ManageDistributionLists>

The following table describes the ManageDistributionLists element and its child elements.

Element

Parent Element

Attributes

Enumeration

Description

 

 

 

 

 

ManageDistributionLists

none

none

 

Parent element of one or more

 

 

 

 

DistributionList elements.

 

 

 

 

 

DistributionList

ManageDistributionLists

 

 

Parent element of zero or more

 

 

 

 

Member elements.

 

 

 

 

 

 

 

id

 

A numeric value that uniquely

 

 

 

 

identifies the distribution list.

 

 

 

 

 

 

 

name

 

A text string that identifies the

 

 

 

 

distribution list.

 

 

 

 

 

 

 

operation

create

Creates a distribution list.

 

 

 

add

Adds the specified members to

 

 

 

 

the distribution list.

 

 

 

remove

Removes the specified

 

 

 

 

members from the distribution

 

 

 

 

list.

 

 

 

delete

Deletes the distribution list.

 

 

 

 

 

Member

DistributionList

device_id

 

The MAC address of the

 

 

 

 

device.

 

 

 

 

 

68Broadcast Server User Guide

Image 76
Contents Broadcast Server User Guide Page Contents A P T E R 6 Subscriber Management A P T E R 9 External Service Management Vi Broadcast Server User Guide Audience PrefaceOrganization Related Documentation Chapter Introduction to Broadcast ServerBroadcast Server Overview Users Subscribers and Distribution ListsAlerts Sending Alerts BCS Interaction with PhonesOpening and Using the Broadcast Server Interface Configuring Broadcast Server Initial ConfigurationBroadcast Server Maintenance Application Gateway and Broadcast Server Operation Application Gateway and Broadcast Server Operation System Management Component VersionsServer configuration Support itemsHome page tips System Management Home page tips Broadcast Server User Guide Quick FAQ System MessagesSystem Messages Quick FAQ Broadcast Server User Guide User Management User Management ListAdministrator user User PasswordUser information Shared distribution list access General user permissionsAlert access User Management The User Broadcast Server User Guide Subscriber Management Subscriber Management ListGo to the Distribution List Management page, select Subscriber Subscriber settingsSubscriber information Emergency alerts are not subject to this setting Distribution list membershipDistribution List Management Distribution ListAutomatically created distribution lists List ownershipSharing distribution lists Distribution List Management Distribution List Management Distribution List Membership Distribution List User Permissions Adding and removing distribution list membersGranting users permission to send to the list Revoking users’ permission to send to the listBroadcast Server User Guide Media Management Media ListSystem media Media ownership Media linkageUploading a media file MediaSupported graphic formats Supported audio formats WAVMedia Management The Media Broadcast Server User Guide External Service Management External Services Management ListExternal Service External Service Management Page Broadcast Alert Management Alert ListColumn Descriptions Alert Types Emergency alertsNormal alerts Background alertsBroadcast Alert Management Quick FAQ Alert TitleSend to the following Use audio alert Page Changing your password Setting the maximum list entries to displayMy Preferences Set the number of alerts perPage Troubleshooting Common problemsTroubleshooting Common problems Broadcast Server User Guide Appendix a Push XML APITo enable the Push XML API on the Application Gateway Push XML API Operation PushMessage RequestRecipient Schedule DistributionList Request MemberSubscribers Response ServerRegistration ResponsePushMessageResponse Response Character Set and Character Entities Push XML ReferenceXML Declaration ManagePushMessage Element Parent Element Attributes Enumeration DescriptionMessageid Appendix a Push XML API ManageDistributionLists DistributionListServerRegistration SubscribersPushMessageResponse Sample ASP Pages Distributionlist.aspLoad the XML into an Xmldom object Schedulemessage.asp Appendix a Push XML API Sample ASP Pages Page Configuration and Operation Broadcast Server User Guide