Cisco Systems OL-20949-01 guide

A P P E N D I X B

Cisco Unified IP Phone Services

XML Schema File

These sections provide details about the XML schema supported on Cisco Unified IP Phones:

•Updated XML Parser and Schema Enforcement

•CiscoIPPhone.xsd

Updated XML Parser and Schema Enforcement

In order to provide a stable and consistent platform upon which to build enhancements to IP phones services, Cisco released an updated XML parser beginning with firmware release 8.3(2). As a result, many Cisco Unified IP Phones now contain this updated XML parser which provides a more rigid enforcement of the XML schema. This updated parser provides more error logging information when it encounters XML schema violations, and it enables developers to debug their applications more efficiently.

Cisco recommends that developers verify that their existing applications conform to the XML schema to avoid incompatibilities with any XML enhancements, particularly if you want to incorporate new URIs.

The following Cisco Unified IP Phones implement this new XML parser: 7906G, 7911G, 7921G, 7925G, 7931G, 7941G/7941G-GE 7942G, 7945G, 7961G/7961G-GE, 7962G, 7965G, 7970G/ 7971G-GE, 7975G, 6921, 6941, 6961

Cisco Unified IP Phone Services Application Development Notes

	OL-20949-01	B-1

Image 99

Cisco Systems OL-20949-01 manual Cisco Unified IP Phone Services XML Schema File, Updated XML Parser and Schema Enforcement

Contents

Text Part Number OL-20949-01 Americas Headquarters Copyright 2004-2009 Cisco Systems, Inc. All rights reserved Iii N T E N T S Display Init Benefits Audience PrefaceOverview Revision History Organization Chapter DescriptionViii Cisco Unified Communications Manager Business Edition Cisco Unified Communications Manager AdministrationRelated Documentation Cisco Unified IP Phone 7900 Series Cisco Product Security Overview Document ConventionsConvention Indication Page Xii 1shows a sample text menu Overview Graphic Menu on a Cisco Unified IP Phone Sample Page OL-20949-01 New Information for Cisco Unified Communications Manager New and Changed Information OL-20949-01 Understanding Object Behavior CiscoIPPhone XML Objects 1shows the supported XML objects for this release CiscoIPPhoneMenu XML Object Definitions Definition CiscoIPPhoneText Sample User Input Display CiscoIPPhoneInput InputFlag Description CiscoIPPhoneDirectory Custom Directories CiscoIPPhoneImage Packed Pixel Translation Example Model Resolution1CiscoIPPhoneImageFile Example Cisco Unified IP Phone 7970G Image File Display Monochrome CiscoIPPhoneGraphicFileMenu CiscoIPPhoneGraphicMenu 5shows the display of the CiscoIPPhoneGraphicFileMenu CiscoIPPhoneIconMenu 6shows an IconMenu on a Cisco Unified IP Phone CiscoIPPhoneStatus CiscoIPPhoneIconFileMenu CiscoIPPhoneStatus Dynamic Sizing of the Application Status Window 7962G, 7965G 7970G/7971G-GE, 7975G, IP Communicator Phone Models Area Width Area Height 7940G, 7960G 7962G, 7965G Phone Models WxH No Timer WxH 7940G, 7960GCiscoIPPhoneStatusFile Text Area Size Behavior Description CiscoIPPhoneExecute CiscoIPPhoneError Custom SoftkeysCiscoIPPhoneResponse SoftKeyItem NameDisplayed sofkey label/Name XML Considerations Mandatory Escape Sequences XML EncodingCharacter Name Escape Sequence Application Event Handlers Supported UnsupportedAttributes Attribute Description Event Handler Schema Component APIs Application Management APIRTP Streaming API Interaction Rules with Legacy RTP URI Streams RTP Streaming Schema XscomplexType Xsall Error Schema Stop Media Errors and ResponsesExamples Start Media Applicable Condition Methods Http Result Code Type Data 7905G 7911G 7921G 7940G 7971G-GE 6941 Internal URI FeaturesSupported URIs by Phone Model 7942G, 7962G 7906G 7945G, 7965G 7970G 6921 Device Control URIs KeyURI Format KeyDirectories Description and Alternatives Phone Unsupported Models URI Display SoftKey XML Displayable Object URIs QueryStringParam Select Exit Update Submit Search Cancel Next Dial Internal URI Features XML Displayable Object URIs Multimedia URIs RTP StreamingInteraction with Call Streaming URI Formats RTPRx RTPTx Play VibrateInteraction with Incoming Calls Dial Telephony URIs SendDigits EditDial Condition Status Data Error and Response Application Management URIs InitNotify Called from SoftKey, with credentials, with data Called from SoftKey, no credentials, no data Application AppactionpriorityidleTimerapplicationId Error and Response Http Requests and Header Settings Http Client Requests Http GETHttp Server Requests Http Post See the Http Refresh Setting section on page 6-3section Http Header Settings Refresh Display Sample Http Refresh Setting Mime Type and Other Http Headers Content Expiration Header Setting Set-Cookie Header Setting Accept-Language Http Encoding Header Setting Identifying the Capabilities of IP Phone Clients CiscoIPPhoneModelNameCiscoIPPhoneDisplay CiscoIPPhoneSDKVersion Accept Header Html URL XML URL Accessing IP Phone Information OL-20949-01 Troubleshooting Cisco Unified IP Phone Service Applications Troubleshooting TipsXML Parsing Errors Error Messages SDK Components Cisco IP Phone Services Software Development Kit SDK OL-20949-01 \CiscoIpServices\Tools Sample Services Requirements OL-20949-01 Accessing Phone Service Administration IP Phone Service Administration Subscription Field Description Adding a Phone Service Field Description Service Parameter Information Defining IP Phone Service Parameters User Service Subscription 10-1 DeviceListX Report Performance and Scalability BenefitsRestrictions Integration Considerations and Interoperability Prerequisites Related Features and TechnologiesSecurity Supported Platforms 10-4 Troubleshooting DeviceListX ReportsError Codes Field Name Description Determining Problems With the Interface Procedure10-5 10-6 Object Definition CiscoIPPhone XML Object Quick Reference Appendix a CiscoIPPhone XML Object Quick Reference IndexA unique index from 0 to 9/Index OL-20949-01 Updated XML Parser and Schema Enforcement Cisco Unified IP Phone Services XML Schema File CiscoIPPhone.xsd Xsdelement name=Name minOccurs=0 xsdsimpleType Xsdrestriction XsdsimpleType XsdsimpleType xsdrestriction base=xsdstring XsdcomplexType name=CiscoIPPhoneSoftKeyType xsdsequence Xsdelement name=Title minOccurs=0 xsdsimpleType Xsdrestriction XsdsimpleType Xsdattribute XsdcomplexType Xsdelement name=CiscoIPPhoneDirectory xsdcomplexType Xsdelement name=CiscoIPPhoneImageFile xsdcomplexType Xsdelement name=CiscoIPPhoneIconMenu xsdcomplexType Xsdelement name=CiscoIPPhoneGraphicFileMenu xsdcomplexType Xsdsequence Xsdelement name=Text minOccurs=0 xsdsimpleType Xsdsequence XsdcomplexType Xsdelement IN-1 Numerics IN-2 Html URL IN-3 IN-4 XML URL