PCSP Programmer Guide
Chapter 06 - Extensions for PCSP Objects – XML (PUT) Examples
Download this chapter
Chapter 06 - Extensions for PCSP Objects – XML (PUT) ExamplesChapter 06 - Extensions for PCSP Objects – XML (PUT) Examples
Download the complete book
PCSP Programmer Guide - Book Length PDFPCSP Programmer Guide - Book Length PDF (PDF - 1 MB)
give_us_feedback

Table Of Contents

PCSP Objects - XML Example (PUT)

WSUS

PcspCms

PcspMta

PcspService

PcspEndpoint

PcspCiscoBtsCli

Request Message, Example 1

Response Message, Example 1

Request Message, Example 2

Response Message, Example 2


PCSP Objects - XML Example (PUT)

Revised: April 9, 2008, OL-15381-05

WSUS

User level security or Web Services User Security (WSUS) is a separate service offering that enables BTS 10200 user security within the confines of PacketCable provisioning.

PcspCms

This section provides an example of PcspCms Extensible Markup Language (XML). 

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

<!--

		Copyright (c) 2005-2007 by Cisco Systems, Inc.

-->

	<PcspObj>

		<!--PcspCms is the only service supported by BTS10200-->

		<EntityName>PcspCms</EntityName>

		<!--Subscriber Id-->

		<Key>brandontsapaddr</Key>

		<!--Create new object-->

		<CmdStatus>1</CmdStatus>

		<!--XMLEncoding as per PCSP Data Model Schema or 0 (null)-->

		<XmlEncoding>


		<![CDATA[

			<PcspCms>

					<CmsFqdn>brandontsapaddr</CmsFqdn>

					<Extension xmlns:ext="http://www.cisco.com/CmsExtension">

							<ext:id>CA147</ext:id>

							<ext:clli>12345678900</ext:clli>

							<ext:mgw_monitoring_enabled>true</ext:mgw_monitoring_enabled>

					</Extension>

			</PcspCms>

		]]>

		</XmlEncoding>

	</PcspObj>

PcspMta

This section provides an example of PcspMta XML. 

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

<!--

		Copyright (c) 2005-2007 by Cisco Systems, Inc.

-->

	<PcspObj>

		<!--PcspMta is the only service supported by BTS10200-->

		<EntityName>PcspMta</EntityName> 

		<!--Subscriber Id-->

		<Key>brandont1</Key>

		<!--Create new object-->

		<CmdStatus>1</CmdStatus>

		<!--XMLEncoding as per PCSP Data Model Schema or 0 (null)-->

		<XmlEncoding>


		<![CDATA[

			<PcspMta>

				<MtaFqdn>brandont1</MtaFqdn>

				<ListenPort>2427</ListenPort>

				<CmtsFqdn>sim-SYS14CA146.ipclab.cisco.com:9146</CmtsFqdn>

				<MtaProfile>c5350-59-140</MtaProfile>

				<Timezone>-0500</Timezone>

				<Protocol>MCGP 1.0 NCS 1.0</Protocol>

				<Codec>1</Codec>

				<IPSecControl>true</IPSecControl>

				<Extension xmlns:ext="http://www.cisco.com/MtaExtension">

					<ext:id>bdmta</ext:id>

					<ext:aggr_id>c7246-227-77</ext:aggr_id>

					<ext:node>test</ext:node>

					<ext:type>RGW</ext:type>

				</Extension>

			</PcspMta>

		]]>


		</XmlEncoding>

	</PcspObj>

PcspService

This section provides an example of PcspService XML. 

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

<!--

		Copyright (c) 2005-2007 by Cisco Systems, Inc.

-->

	<PcspObj>

		<!--PcspService is the only service supported by BTS10200-->

		<EntityName>PcspService</EntityName>

		<!--Subscriber Id-->

		<Key>2146255555</Key>

		<!--Create new object-->

		<CmdStatus>1</CmdStatus>

		<!--XMLEncoding as per PCSP Data Model Schema or 0 (null)-->

		<XmlEncoding>


		<![CDATA[

			<PcspService xmlns="http://www.cablelabs.com/Pcsp/I01/schema" 

			xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 

			xmlns:pcsp="http://www.cablelabs.com/Pcsp/I01/schema">

					<ServiceId format="NSN">2146255555</ServiceId>

					<AdminStatus>1</AdminStatus>

					<BillingId>2146255555</BillingId>

					<ExternalId>brandontest</ExternalId>

					<IsPrimary>true</IsPrimary>

					<PrimaryRing>R1</PrimaryRing>

					<DisplayName>John Q Public</DisplayName>

					<DisplayNumber>2146255555</DisplayNumber>

					<Password>45hjg3j6gkg6h54j6gkj3g6</Password>

					<Announcements>

							<Language>EN</Language>

							<Timezone>+0500</Timezone>

					</Announcements>

					<InterExchange>

							<PIC>0123</PIC>

							<LPIC>0123</LPIC>

							<IPIC>0123</IPIC>

					</InterExchange>

					<LNP>

							<PortingStatus>0</PortingStatus>

							<LNPT>0</LNPT>

					</LNP>

					<ListOfCallFeatures>

							<CfAC>

									<Subscribed>true</Subscribed>

									<AdminStatus>1</AdminStatus>

							</CfAC>

							<CfCFBL>

									<Subscribed>true</Subscribed>

									<AdminStatus>1</AdminStatus>

									<UserParams>

											<Active>true</Active>

											<Always>0</Always>

											<ForwardTo>9785551212</ForwardTo>

									</UserParams>

							</CfCFBL>

					</ListOfCallFeatures>


					<Extension xmlns:ext="http://www.cisco.com/ServiceExtension">

							<ext:account_id>test</ext:account_id>

							<ext:address1>test</ext:address1>

							<ext:address2>test</ext:address2>

							<ext:city>test</ext:city>

							<ext:country>test</ext:country>

							<ext:esrn>2345</ext:esrn>

							<ext:forced>true</ext:forced>

							<ext:grp>true</ext:grp>

							<ext:immediate_release>true</ext:immediate_release>

							<ext:sdt_mwi>true</ext:sdt_mwi>

							<ext:send_bdn_as_cpn>true</ext:send_bdn_as_cpn>

							<ext:send_bdn_for_emg>true</ext:send_bdn_for_emg>

							<ext:state>test</ext:state>

							<ext:sub_profile_id>tb14-cable</ext:sub_profile_id>

							<ext:terminating_immediate_rel>test</ext:terminating_ 
							immediate_rel>

							<ext:usage_sens>true</ext:usage_sens>

							<ext:vmwi>true</ext:vmwi>

							<ext:zipcode>75082</ext:zipcode>

							<ext:billing_type>FR1</ext:billing_type>

							<ext:category>INDIVIDUAL</ext:category>

							<ext:cwt_type>WT1</ext:cwt_type>

							<ext:offhook_trigger_type>NONE</ext:offhook_trigger_type>

							<ext:ohd_timer>0</ext:ohd_timer>

							<ext:privacy>FULL</ext:privacy>

							<ext:term_type>NONE</ext:term_type>

							<ext:ListOfServicePkg>

									<ext:pkgid>bus-gold</ext:pkgid>

									<ext:pkgid>ivr</ext:pkgid>

							</ext:ListOfServicePkg>

					</Extension>


				</PcspService>

		]]>

		</XmlEncoding>

	</PcspObj>

PcspEndpoint

This section provides an example of PcspEndpoint XML. 

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

<!--

		Copyright (c) 2005-2007 by Cisco Systems, Inc.

-->

	<PcspObj>

		<!--PcspEndpoint is the only service supported by BTS10200-->

		<EntityName>PcspEndpoint</EntityName>

		<!--Subscriber Id-->

		<Key>DS/S-0/DS1-24/12@c8880-227-01.ipclab.cisco.com</Key>

		<!--Create new object-->

		<CmdStatus>1</CmdStatus>

		<!--XMLEncoding as per PCSP Data Model Schema or 0 (null)-->

		<XmlEncoding>


		<![CDATA[

			<PcspEndpoint>

				<EndpointId>DS/S-0/DS1-24/12@c8880-227-01.ipclab.cisco.com</EndpointId>

				<AdminStatus>2</AdminStatus>

				<Protocol>MtaDefault</Protocol>

				<Codec>2</Codec>

				<IPSecControl>true</IPSecControl>

				<Extension xmlns:ext="http://www.cisco.com/EndpointExtension">

					<sub_id>215-224-2234</sub_id>

				</Extension>

			</PcspEndpoint>

		]]>


		</XmlEncoding>

	</PcspObj>

PcspCiscoBtsCli

This section provides two examples of PcspCiscoBtsCli XML.

Request Message, Example 1

This section provides the request message example 1. 

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

<!--

		Copyright (c) 2005-2007 by Cisco Systems, Inc.

-->

	<PcspObj>

		<!--PcspCiscoBtsCli service supported by BTS10200-->

		<EntityName>PcspCiscoBtsCli</EntityName>

		<!--Subscriber Id-->

		<Key>dn2subscriber</Key>

		<!--CmdStatus is IGNORED-->

		<CmdStatus>1</CmdStatus>

		<!--XMLEncoding as per PCSP Data Model Schema or 0 (null)-->

		<XmlEncoding>


		<![CDATA[

			<Request Verb='show' Noun='dn2subscriber'>

				<Entry Key='limit' Value='2'></Entry>

			</Request>

		]]>

		</XmlEncoding>

	</PcspObj>

Response Message, Example 1

This section provides the response message example 1. 

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

<!--

		Copyright (c) 2005-2007 by Cisco Systems, Inc.

-->

<PcspObj>

	<EntityName>PcspCiscoBtsCli</EntityName>

	<Key>dn2subscriber</Key>

	<CmdStatus>1</CmdStatus>

	<XmlEncoding>

		<Reply id='Reply'>

			<Status>true</Status>

			<Reason>Success: at 2007-11-08 07:20:01 by btsapp Entries 1-2 of 169 

			returned.</Reason>

			<Size>2</Size>

			<AbsoluteSize>169</AbsoluteSize>

			<StartRow>1</StartRow>

			<DataTable>

				<Row id='0'>

					<Column id='office_code_index'>2</Column>

					<Column id='dn'>0101</Column>

					<Column id='status'>ASSIGNED</Column>

					<Column id='ring_type'>R1</Column>

					<Column id='lnp_trigger'>N</Column>

					<Column id='np_reserved'>N</Column>

					<Column id='annc_id'></Column>

					<Column id='sub_id'>201-222-0101</Column>

					<Column id='virtual_dn'>N</Column>

					<Column id='cwt_type'>WT1</Column>

					<Column id='admin_dn'>N</Column>

					<Column id='ported_in'>N</Column>

					<Column id='LAST_CHANGED'>2007-10-26 08:27:58</Column>

				</Row>

				<Row id='1'>

					<Column id='office_code_index'>2</Column>

					<Column id='dn'>0102</Column>

					<Column id='status'>ASSIGNED</Column>

					<Column id='ring_type'>R1</Column>

					<Column id='lnp_trigger'>N</Column>

					<Column id='np_reserved'>N</Column>

					<Column id='annc_id'></Column>

					<Column id='sub_id'>201-222-0102</Column>

					<Column id='virtual_dn'>N</Column>

					<Column id='cwt_type'>WT1</Column>

					<Column id='admin_dn'>N</Column>

					<Column id='ported_in'>N</Column>

					<Column id='LAST_CHANGED'>2007-10-26 08:27:58</Column>

				</Row>

			</DataTable>

		</Reply>

	</XmlEncoding>

</PcspObj>

Request Message, Example 2

This section provides the request message example 2. 

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

<!--

		Copyright (c) 2005-2007 by Cisco Systems, Inc.

-->

	<PcspObj>

		<!--PcspCiscoBtsCli service supported by BTS10200-->

		<EntityName>PcspCiscoBtsCli</EntityName>

		<!--Subscriber Id-->

		<Key>trunk_termination</Key>

		<!--CmdStatus is IGNORED-->

		<CmdStatus>1</CmdStatus>

		<!--XMLEncoding as per PCSP Data Model Schema or 0 (null)-->

		<XmlEncoding>


		<![CDATA[

			<Request Verb='status' Noun='trunk_termination'>

				<Entry Key='cic' Value='8'></Entry>

				<Entry Key='tgn_id' Value='30076'></Entry>

			</Request>

		]]>

		</XmlEncoding>

	</PcspObj>

Response Message, Example 2

This section provides the response message example 2. 

<PcspObj>

	<EntityName>PcspCiscoBtsCli</EntityName>

	<Key>dn2subscriber</Key>

	<CmdStatus>1</CmdStatus>

	<XmlEncoding>

		<Reply id='Reply'>

			<Status>true</Status>

				<Reason>Success: at 2007-11-08 07:26:11 by btsapp Entry 1 of 1 

				returned.</Reason>

			<Size>1</Size>

			<AbsoluteSize>1</AbsoluteSize>

			<StartRow>1</StartRow>

			<DataTable>

				<Row id='0'>

					<Column id='tgn_id'>30076</Column>

					<Column id='cic'>8</Column>

					<Column id='RESULT'>ADM configure result in success</Column>

					<Column id='REASON'>ADM executed successfully</Column>

					<Column id='TERM_ADMIN_STATE'>ADMIN_INS</Column>

					<Column id='TERM_OPER_STATE'>Term is available for new calls</Column>

					<Column id='TERM_REASON'>No fault reason available</Column>

					<Column id='TRUNK_STATIC_STATE'>ACTV</Column>

					<Column id='TRUNK_DYNAMIC_STATE'>IDLE</Column>

					<Column id='TRUNK_REASON'>NON_FAULTY</Column>

				</Row>

			</DataTable>

		</Reply>

	</XmlEncoding>

</PcspObj>