Nortel Networks Broadcast Server warranty Push XML Reference, Character Set and Character Entities

Page 72

Appendix A Push XML API

Push XML Reference

Push XML Reference

The following topics provide a detailed description of the Push XML:

•Character Set and Character Entities, page 64

•XML Declaration, page 64

•ManagePushMessage, page 65

•ManageDistributionLists, page 68

•ServerRegistration, page 69

•Subscribers, page 69

•PushMessageResponse, page 70

Character Set and Character Entities

The Push XML API supports the UNICODE character set. Use character entity references to escape the following special characters.

Character	Character Entity

& (ampersand)	&

‘ (apostrophe)	'

> (greater-than sign)	>

< (less-than sign)	<

" (straight double-quote)	"

For more information on character references and character entities, refer to XML reference documentation.

XML Declaration

The Push XML string should begin with the following XML declaration:

<?xml version="1.0" encoding="utf-8"?>

The XML declaration must not be preceded by comments, whitespace, or processing instructions.

64Broadcast Server User Guide

Image 72

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 Preface AudienceOrganization 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 Password UserUser 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 settings SubscriberSubscriber 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 linkageMedia Uploading a media fileSupported 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 MemberServerRegistration Response Subscribers ResponsePushMessageResponse Response Push XML Reference Character Set and Character EntitiesXML 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