XML Description Documents
Revised: July 2010, OL-23043-01
This appendix provides examples of the XML description documents.
Subscriber Noun and Add Verb
The following sample XML description document provides an example of the subscriber noun and add verb.
=================================================
<ManagedObject Verb="add" id="subscriber"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="ManagedObject.xsd">
<Required>false</Required>
<Default>[null]</Default>
<HelpText>Enter at least 1, but not more than 14 characters from the following set:
{0123456789-}.</HelpText>
<Parser id="GenericDNParser">
<JavaScript>TBD</JavaScript>
<Required>false</Required>
<Default>[null]</Default>
<HelpText>Enter at least 1 character, but not more than 32 characters.</HelpText>
<JavaScript>TBD</JavaScript>
<MOAttribute id="policy_id">
<Required>false</Required>
<Default>[null]</Default>
<HelpText>Enter at least 1 character, but not more than 16 characters.</HelpText>
<JavaScript>TBD</JavaScript>
<MOAttribute id="category">
<Required>false</Required>
<Default>[INDIVIDUAL]</Default>
<HelpText>Enter one of the following values: [INDIVIDUAL, MLHG, MLHG_INDIVIDUAL,
MLHG_PREF_INDIV, CTXG, CTXG_INDIVIDUAL, PBX, CTXG_TG, CTXG_MLHG, RACF, IVR]</HelpText>
<Permitted>[INDIVIDUAL, MLHG, MLHG_INDIVIDUAL, MLHG_PREF_INDIV, CTXG, CTXG_INDIVIDUAL,
PBX, CTXG_TG, CTXG_MLHG, RACF, IVR]</Permitted>
<MOAttribute id="ss_number">
<Required>false</Required>
<Default>[null]</Default>
<HelpText>Enter a Social Security Number in the form ###-##-#### where # is digit from
0-9.</HelpText>
<Parser id="SocSecParser">
<JavaScript>TBD</JavaScript>
<MOAttribute id="ctxg_id">
<Required>false</Required>
<Default>[null]</Default>
<HelpText>Enter at least 1 character, but not more than 16 characters.</HelpText>
<JavaScript>TBD</JavaScript>
<Required>false</Required>
<Default>[null]</Default>
<HelpText>Enter at least 1 character, but not more than 32 characters.</HelpText>
<JavaScript>TBD</JavaScript>
<MOAttribute id="mlhg_pref_list_id">
<Required>false</Required>
<Default>[null]</Default>
<HelpText>Enter at least 1 character, but not more than 16 characters.</HelpText>
<Label>Mlhg Pref List Id</Label>
<JavaScript>TBD</JavaScript>
<MOAttribute id="address2">
<Required>false</Required>
<Default>[null]</Default>
<HelpText>Enter at least 1 character, but not more than 32 characters.</HelpText>
<JavaScript>TBD</JavaScript>
<MOAttribute id="address1">
<Required>false</Required>
<Default>[null]</Default>
<HelpText>Enter at least 1 character, but not more than 32 characters.</HelpText>
<JavaScript>TBD</JavaScript>
<Required>false</Required>
<Default>[null]</Default>
<HelpText>Enter at least 1 character, but not more than 16 characters.</HelpText>
<JavaScript>TBD</JavaScript>
<MOAttribute id="terminating_immediate_rel">
<Required>false</Required>
<HelpText>Enter a boolean value of Y for yes or N for no.</HelpText>
<Label>Terminating Immediate Release</Label>
<Parser id="BooleanParser">
<JavaScript>TBD</JavaScript>
<MOAttribute id="billing_dn">
<Required>false</Required>
<Default>[null]</Default>
<HelpText>Enter at least 1, but not more than 32 characters from the following set:
{0123456789-}.</HelpText>
<Label>Billing Dn</Label>
<Parser id="GenericDNParser">
<JavaScript>TBD</JavaScript>
<MOAttribute id="language">
<Required>false</Required>
<Default>[null]</Default>
<HelpText>Enter at least 1 character, but not more than 16 characters.</HelpText>
<JavaScript>TBD</JavaScript>
<Required>false</Required>
<Default>[null]</Default>
<HelpText>Enter an email address in the form text@text where text is a set of
characters with no spaces.</HelpText>
<Parser id="EmailParser">
<JavaScript>TBD</JavaScript>
<MOAttribute id="mlhg_id">
<Required>false</Required>
<Default>[null]</Default>
<HelpText>Enter at least 1 character, but not more than 16 characters.</HelpText>
<JavaScript>TBD</JavaScript>
<MOAttribute id="tgn_id">
<Required>false</Required>
<Default>[null]</Default>
<HelpText>Enter a number from 0 to 99999999.</HelpText>
<Label>Trunk Group Number ID</Label>
<Parser id="DecimalParser">
<JavaScript>TBD</JavaScript>
<MOAttribute id="mgw_id">
<Required>false</Required>
<Default>[null]</Default>
<HelpText>Enter at least 0 characters, but not more than 32 characters.</HelpText>
<Label>Media Gateway ID</Label>
<JavaScript>TBD</JavaScript>
<MOAttribute id="status">
<Required>false</Required>
<Default>[ACTIVE]</Default>
<HelpText>Enter one of the following values: [ACTIVE, TEMP_OOS, TEMP_DISCONNECTED,
TEMP_UNAVAILABLE]</HelpText>
<Permitted>[ACTIVE, TEMP_OOS, TEMP_DISCONNECTED, TEMP_UNAVAILABLE]</Permitted>
<MOAttribute id="term_id">
<Required>false</Required>
<Default>[null]</Default>
<HelpText>Enter at least 1 character, but not more than 32 characters.</HelpText>
<Label>Termination ID</Label>
<JavaScript>TBD</JavaScript>
<MOAttribute id="usage_sens">
<Required>false</Required>
<HelpText>Enter a boolean value of Y for yes or N for no.</HelpText>
<Label>Usage Sens</Label>
<Parser id="BooleanParser">
<JavaScript>TBD</JavaScript>
<Required>true</Required>
<Default>[null]</Default>
<HelpText>Enter at least 1 character, but not more than 30 characters.</HelpText>
<JavaScript>TBD</JavaScript>
<Required>false</Required>
<HelpText>Enter a boolean value of Y for yes or N for no.</HelpText>
<Parser id="BooleanParser">
<JavaScript>TBD</JavaScript>
<MOAttribute id="sub_profile_id">
<Required>true</Required>
<Default>[null]</Default>
<HelpText>Enter at least 1 character, but not more than 16 characters.</HelpText>
<Label>Sub Profile Id</Label>
<JavaScript>TBD</JavaScript>
<MOAttribute id="country">
<Required>false</Required>
<HelpText>Enter at least 1 character, but not more than 16 characters.</HelpText>
<JavaScript>TBD</JavaScript>
<MOAttribute id="cos_restrict_id">
<Required>false</Required>
<Default>[null]</Default>
<HelpText>Enter at least 1 character, but not more than 16 characters.</HelpText>
<Label>COS Restrict ID</Label>
<JavaScript>TBD</JavaScript>
<MOAttribute id="qos_id">
<Required>false</Required>
<Default>[null]</Default>
<HelpText>Enter at least 1 character, but not more than 16 characters.</HelpText>
<JavaScript>TBD</JavaScript>
<MOAttribute id="term_type">
<Required>false</Required>
<Default>[TERM]</Default>
<HelpText>Enter one of the following values: [TERM, TG, ROUTE, RG]</HelpText>
<Permitted>[TERM, TG, ROUTE, RG]</Permitted>
<MOAttribute id="ring_type_dn1">
<Required>false</Required>
<HelpText>Enter a number from 1 to 3.</HelpText>
<Label>Ring Type Dn1</Label>
<Parser id="DecimalParser">
<JavaScript>TBD</JavaScript>
<MOAttribute id="immediate_release">
<Required>false</Required>
<HelpText>Enter a boolean value of Y for yes or N for no.</HelpText>
<Label>Immediate Release</Label>
<Parser id="BooleanParser">
<JavaScript>TBD</JavaScript>
<MOAttribute id="sip_url">
<Required>false</Required>
<Default>[null]</Default>
<HelpText>Enter at least 1 character, but not more than 32 characters.</HelpText>
<JavaScript>TBD</JavaScript>
<MOAttribute id="zipcode">
<Required>false</Required>
<Default>[null]</Default>
<HelpText>Enter at least 1 character, but not more than 10 characters.</HelpText>
<JavaScript>TBD</JavaScript>
<Required>false</Required>
<Default>[null]</Default>
<HelpText>Enter a PIC value as four numeric characters, NPIC, or NONE.</HelpText>
<JavaScript>TBD</JavaScript>
<Required>false</Required>
<Default>[null]</Default>
<HelpText>Enter a PIC value as four numeric characters, NPIC, or NONE.</HelpText>
<JavaScript>TBD</JavaScript>
<MOAttribute id="privacy">
<Required>false</Required>
<Default>[NONE]</Default>
<HelpText>Enter one of the following values: [FULL, NAME, NONE]</HelpText>
<Permitted>[FULL, NAME, NONE]</Permitted>
<Required>false</Required>
<Default>[null]</Default>
<HelpText>Enter a PIC value as four numeric characters, NPIC, or NONE.</HelpText>
<JavaScript>TBD</JavaScript>
<Required>false</Required>
<Default>[null]</Default>
<HelpText>Enter at least 1 character, but not more than 16 characters.</HelpText>
<JavaScript>TBD</JavaScript>
Foreign Key Relationships
The following sample XML extended format description document contains the foreign key relationships for a given command.
=================================================
<ManagedObject Verb="add" id="subscriber"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="ManagedObject.xsd">
<Required>false</Required>
<Default>[null]</Default>
<HelpText>Enter at least 1, but not more than 14 characters from the following set:
{0123456789-}.</HelpText>
<Parser id="GenericDNParser">
<JavaScript>TBD</JavaScript>
<Required>false</Required>
<Default>[null]</Default>
<HelpText>Enter at least 1 character, but not more than 32 characters.</HelpText>
<JavaScript>TBD</JavaScript>
<MOAttribute id="policy_id">
<Required>false</Required>
<Default>[null]</Default>
<HelpText>Enter at least 1 character, but not more than 16 characters.</HelpText>
<JavaScript>TBD</JavaScript>
<MOAttribute id="category">
<Required>false</Required>
<Default>[INDIVIDUAL]</Default>
<HelpText>Enter one of the following values: [INDIVIDUAL, MLHG, MLHG_INDIVIDUAL,
MLHG_PREF_INDIV, CTXG, CTXG_INDIVIDUAL, PBX, CTXG_TG, CTXG_MLHG, RACF, IVR]</HelpText>
<Permitted>[INDIVIDUAL, MLHG, MLHG_INDIVIDUAL, MLHG_PREF_INDIV, CTXG, CTXG_INDIVIDUAL,
PBX, CTXG_TG, CTXG_MLHG, RACF, IVR]</Permitted>
<MOAttribute id="ss_number">
<Required>false</Required>
<Default>[null]</Default>
<HelpText>Enter a Social Security Number in the form ###-##-#### where # is digit from
0-9.</HelpText>
<Parser id="SocSecParser">
<JavaScript>TBD</JavaScript>
<MOAttribute id="ctxg_id">
<Required>false</Required>
<Default>[null]</Default>
<HelpText>Enter at least 1 character, but not more than 16 characters.</HelpText>
<JavaScript>TBD</JavaScript>
<Required>false</Required>
<Default>[null]</Default>
<HelpText>Enter at least 1 character, but not more than 32 characters.</HelpText>
<JavaScript>TBD</JavaScript>
<MOAttribute id="mlhg_pref_list_id">
<Required>false</Required>
<Default>[null]</Default>
<HelpText>Enter at least 1 character, but not more than 16 characters.</HelpText>
<Label>Mlhg Pref List Id</Label>
<JavaScript>TBD</JavaScript>
<Fk id="MLH_PREF_LIST_PK">
<Noun>mlhg_pref_list</Noun>
<MOAttribute id="address2">
<Required>false</Required>
<Default>[null]</Default>
<HelpText>Enter at least 1 character, but not more than 32 characters.</HelpText>
<JavaScript>TBD</JavaScript>
<MOAttribute id="address1">
<Required>false</Required>
<Default>[null]</Default>
<HelpText>Enter at least 1 character, but not more than 32 characters.</HelpText>
<JavaScript>TBD</JavaScript>
<Required>false</Required>
<Default>[null]</Default>
<HelpText>Enter at least 1 character, but not more than 16 characters.</HelpText>
<JavaScript>TBD</JavaScript>
<MOAttribute id="terminating_immediate_rel">
<Required>false</Required>
<HelpText>Enter a boolean value of Y for yes or N for no.</HelpText>
<Label>Terminating Immediate Release</Label>
<Parser id="BooleanParser">
<JavaScript>TBD</JavaScript>
<MOAttribute id="billing_dn">
<Required>false</Required>
<Default>[null]</Default>
<HelpText>Enter at least 1, but not more than 32 characters from the following set:
{0123456789-}.</HelpText>
<Label>Billing Dn</Label>
<Parser id="GenericDNParser">
<JavaScript>TBD</JavaScript>
<MOAttribute id="language">
<Required>false</Required>
<Default>[null]</Default>
<HelpText>Enter at least 1 character, but not more than 16 characters.</HelpText>
<JavaScript>TBD</JavaScript>
<Required>false</Required>
<Default>[null]</Default>
<HelpText>Enter an email address in the form text@text where text is a set of
characters with no spaces.</HelpText>
<Parser id="EmailParser">
<JavaScript>TBD</JavaScript>
<MOAttribute id="mlhg_id">
<Required>false</Required>
<Default>[null]</Default>
<HelpText>Enter at least 1 character, but not more than 16 characters.</HelpText>
<JavaScript>TBD</JavaScript>
<Fk id="MLH_PREF_LIST_PK">
<Noun>mlhg_pref_list</Noun>
<MOAttribute id="tgn_id">
<Required>false</Required>
<Default>[null]</Default>
<HelpText>Enter a number from 0 to 99999999.</HelpText>
<Label>Trunk Group Number ID</Label>
<Parser id="DecimalParser">
<JavaScript>TBD</JavaScript>
<MOAttribute id="mgw_id">
<Required>false</Required>
<Default>[null]</Default>
<HelpText>Enter at least 0 characters, but not more than 32 characters.</HelpText>
<Label>Media Gateway ID</Label>
<JavaScript>TBD</JavaScript>
<MOAttribute id="status">
<Required>false</Required>
<Default>[ACTIVE]</Default>
<HelpText>Enter one of the following values: [ACTIVE, TEMP_OOS, TEMP_DISCONNECTED,
TEMP_UNAVAILABLE]</HelpText>
<Permitted>[ACTIVE, TEMP_OOS, TEMP_DISCONNECTED, TEMP_UNAVAILABLE]</Permitted>
<MOAttribute id="term_id">
<Required>false</Required>
<Default>[null]</Default>
<HelpText>Enter at least 1 character, but not more than 32 characters.</HelpText>
<Label>Termination ID</Label>
<JavaScript>TBD</JavaScript>
<MOAttribute id="usage_sens">
<Required>false</Required>
<HelpText>Enter a boolean value of Y for yes or N for no.</HelpText>
<Label>Usage Sens</Label>
<Parser id="BooleanParser">
<JavaScript>TBD</JavaScript>
<Required>true</Required>
<Default>[null]</Default>
<HelpText>Enter at least 1 character, but not more than 30 characters.</HelpText>
<JavaScript>TBD</JavaScript>
<Required>false</Required>
<HelpText>Enter a boolean value of Y for yes or N for no.</HelpText>
<Parser id="BooleanParser">
<JavaScript>TBD</JavaScript>
<MOAttribute id="sub_profile_id">
<Required>true</Required>
<Default>[null]</Default>
<HelpText>Enter at least 1 character, but not more than 16 characters.</HelpText>
<Label>Sub Profile Id</Label>
<JavaScript>TBD</JavaScript>
<Fk id="SUBSCRIBER_PROFILE_PK">
<Noun>subscriber_profile</Noun>
<MOAttribute id="country">
<Required>false</Required>
<HelpText>Enter at least 1 character, but not more than 16 characters.</HelpText>
<JavaScript>TBD</JavaScript>
<MOAttribute id="cos_restrict_id">
<Required>false</Required>
<Default>[null]</Default>
<HelpText>Enter at least 1 character, but not more than 16 characters.</HelpText>
<Label>COS Restrict ID</Label>
<JavaScript>TBD</JavaScript>
<Fk id="COST_RESTRICT_PK">
<Noun>cos_restrict</Noun>
<MOAttribute id="qos_id">
<Required>false</Required>
<Default>[null]</Default>
<HelpText>Enter at least 1 character, but not more than 16 characters.</HelpText>
<JavaScript>TBD</JavaScript>
<MOAttribute id="term_type">
<Required>false</Required>
<Default>[TERM]</Default>
<HelpText>Enter one of the following values: [TERM, TG, ROUTE, RG]</HelpText>
<Permitted>[TERM, TG, ROUTE, RG]</Permitted>
<MOAttribute id="ring_type_dn1">
<Required>false</Required>
<HelpText>Enter a number from 1 to 3.</HelpText>
<Label>Ring Type Dn1</Label>
<Parser id="DecimalParser">
<JavaScript>TBD</JavaScript>
<MOAttribute id="immediate_release">
<Required>false</Required>
<HelpText>Enter a boolean value of Y for yes or N for no.</HelpText>
<Label>Immediate Release</Label>
<Parser id="BooleanParser">
<JavaScript>TBD</JavaScript>
<MOAttribute id="sip_url">
<Required>false</Required>
<Default>[null]</Default>
<HelpText>Enter at least 1 character, but not more than 32 characters.</HelpText>
<JavaScript>TBD</JavaScript>
<MOAttribute id="zipcode">
<Required>false</Required>
<Default>[null]</Default>
<HelpText>Enter at least 1 character, but not more than 10 characters.</HelpText>
<JavaScript>TBD</JavaScript>
<Required>false</Required>
<Default>[null]</Default>
<HelpText>Enter a PIC value as four numeric characters, NPIC, or NONE.</HelpText>
<JavaScript>TBD</JavaScript>
<Required>false</Required>
<Default>[null]</Default>
<HelpText>Enter a PIC value as four numeric characters, NPIC, or NONE.</HelpText>
<JavaScript>TBD</JavaScript>
<MOAttribute id="privacy">
<Required>false</Required>
<Default>[NONE]</Default>
<HelpText>Enter one of the following values: [FULL, NAME, NONE]</HelpText>
<Permitted>[FULL, NAME, NONE]</Permitted>
<Required>false</Required>
<Default>[null]</Default>
<HelpText>Enter a PIC value as four numeric characters, NPIC, or NONE.</HelpText>
<JavaScript>TBD</JavaScript>
<Required>false</Required>
<Default>[null]</Default>
<HelpText>Enter at least 1 character, but not more than 16 characters.</HelpText>
<JavaScript>TBD</JavaScript>