<p><b>Copyright (c)2008-2012, Cable Television Laboratories, Inc.</b><b>XML Schema, Release Version 3.0.0</b><b>SaFI Campaign Information Package Interface.</b><b>This schema is a normative component of CableLabs® Subscription and Fulfillment
Interfaces, Campaign Information Package Specification,
OC-SP-SaFI-CIPv3.0-xxxxxx</b></p>
Properties
attribute form default:
unqualified
element form default:
qualified
Element cip:CampInfoPkg
Namespace
urn:cablelabs:safi:xsd:cip:3.0
Annotations
<p>The Campaign Info Package is the root element of all new or updated campaign
descriptions. It contains the following data units:</p><ul><li>Exactly one Version element, which is a schema version-control element</li><li>At least one MsoOrder element</li><li>Zero or more Ext elements, which are optional extension elements</li></ul>
<xs:element name="CampInfoPkg"><xs:annotation><xs:documentation><p>The Campaign Info Package is the root element of all new or updated campaign
descriptions. It contains the following data units:</p><ul><li>Exactly one Version element, which is a schema version-control element</li><li>At least one MsoOrder element</li><li>Zero or more Ext elements, which are optional extension elements</li></ul></xs:documentation></xs:annotation><xs:complexType><xs:sequence><xs:element name="Version" type="common:VersionType"/><xs:element name="MsoOrder" type="cip:MsoOrderType" maxOccurs="unbounded"/><xs:element name="Ext" type="common:ExtType" minOccurs="0" maxOccurs="unbounded"/></xs:sequence></xs:complexType></xs:element>
<xs:element name="SysOrder" type="cip:OrderType" minOccurs="0" maxOccurs="unbounded"><xs:annotation><xs:documentation>One or more collections of bundles for an MSO, per MSO
SysCode.</xs:documentation></xs:annotation></xs:element>
<p>Effective duration of time from the start time. If duration is supplied and
startTime is omitted, duration MUST be ignored. Note that duration can
extend into the next day. If an end date/time is specified, it MUST be
observed when calculating the actual end time based on startTime and
duration, and supersedes the duration attribute.</p>
<p>Effective days of the week. Each day of the week is represented by an
independent Boolean value. By default, all days are active; set a day to
false to make the entry inactive for that day.</p>
<p>If present, the date/time this reference is active. startDateTime and
endDateTime are optional values; however, if they are present, the
startDateTime and endDateTime MUST be evaluated prior to evaluating any
other attribute in this section. This attribute group can take several
forms:</p><ul><li>Omitting this attribute group indicates that the reference is active for
the lifetime of the entry.</li><li>Start-only entries become active when the start date/time is
reached.</li><li>End-only entries are active until the end date/time is reached.</li><li>Start/end entries are active from the start date/time, and are active
until the end date/time is reached.</li></ul>
<p>Start time of day for being active. For example, 09:00:00 represents 9:00am
local time; 09:00:00Z represents 9:00 am UTC; and 09:00:00-06:00 applies an
offset. If startTime is omitted, the entry is effective for the entire days
listed based on local time. If you wish to use UTC time to represent the
entire day, specify a start time of 00:00:00Z with a duration of
23:59:59.</p>
<p>Effective duration of time from the start time. If duration is supplied and
startTime is omitted, duration MUST be ignored. Note that duration can
extend into the next day. If an end date/time is specified, it MUST be
observed when calculating the actual end time based on startTime and
duration, and supersedes the duration attribute.</p>
<p>Effective days of the week. Each day of the week is represented by an
independent Boolean value. By default, all days are active; set a day to
false to make the entry inactive for that day.</p>
<p>If present, the date/time this reference is active. startDateTime and
endDateTime are optional values; however, if they are present, the
startDateTime and endDateTime MUST be evaluated prior to evaluating any
other attribute in this section. This attribute group can take several
forms:</p><ul><li>Omitting this attribute group indicates that the reference is active for
the lifetime of the entry.</li><li>Start-only entries become active when the start date/time is
reached.</li><li>End-only entries are active until the end date/time is reached.</li><li>Start/end entries are active from the start date/time, and are active
until the end date/time is reached.</li></ul>
<p>Start time of day for being active. For example, 09:00:00 represents 9:00am
local time; 09:00:00Z represents 9:00 am UTC; and 09:00:00-06:00 applies an
offset. If startTime is omitted, the entry is effective for the entire days
listed based on local time. If you wish to use UTC time to represent the
entire day, specify a start time of 00:00:00Z with a duration of
23:59:59.</p>
<p>Effective duration of time from the start time. If duration is supplied and
startTime is omitted, duration MUST be ignored. Note that duration can
extend into the next day. If an end date/time is specified, it MUST be
observed when calculating the actual end time based on startTime and
duration, and supersedes the duration attribute.</p>
<p>Effective days of the week. Each day of the week is represented by an
independent Boolean value. By default, all days are active; set a day to
false to make the entry inactive for that day.</p>
<p>If present, the date/time this reference is active. startDateTime and
endDateTime are optional values; however, if they are present, the
startDateTime and endDateTime MUST be evaluated prior to evaluating any
other attribute in this section. This attribute group can take several
forms:</p><ul><li>Omitting this attribute group indicates that the reference is active for
the lifetime of the entry.</li><li>Start-only entries become active when the start date/time is
reached.</li><li>End-only entries are active until the end date/time is reached.</li><li>Start/end entries are active from the start date/time, and are active
until the end date/time is reached.</li></ul>
<p>Start time of day for being active. For example, 09:00:00 represents 9:00am
local time; 09:00:00Z represents 9:00 am UTC; and 09:00:00-06:00 applies an
offset. If startTime is omitted, the entry is effective for the entire days
listed based on local time. If you wish to use UTC time to represent the
entire day, specify a start time of 00:00:00Z with a duration of
23:59:59.</p>
<p>Effective duration of time from the start time. If duration is supplied and
startTime is omitted, duration MUST be ignored. Note that duration can
extend into the next day. If an end date/time is specified, it MUST be
observed when calculating the actual end time based on startTime and
duration, and supersedes the duration attribute.</p>
<p>Effective days of the week. Each day of the week is represented by an
independent Boolean value. By default, all days are active; set a day to
false to make the entry inactive for that day.</p>
<p>If present, the date/time this reference is active. startDateTime and
endDateTime are optional values; however, if they are present, the
startDateTime and endDateTime MUST be evaluated prior to evaluating any
other attribute in this section. This attribute group can take several
forms:</p><ul><li>Omitting this attribute group indicates that the reference is active for
the lifetime of the entry.</li><li>Start-only entries become active when the start date/time is
reached.</li><li>End-only entries are active until the end date/time is reached.</li><li>Start/end entries are active from the start date/time, and are active
until the end date/time is reached.</li></ul>
<p>Start time of day for being active. For example, 09:00:00 represents 9:00am
local time; 09:00:00Z represents 9:00 am UTC; and 09:00:00-06:00 applies an
offset. If startTime is omitted, the entry is effective for the entire days
listed based on local time. If you wish to use UTC time to represent the
entire day, specify a start time of 00:00:00Z with a duration of
23:59:59.</p>
<xs:element name="Orders" type="cip:OrderType" minOccurs="0"><xs:annotation><xs:documentation>One collection of bundles that apply globally to
all syscodes an MSO.</xs:documentation></xs:annotation></xs:element>
<xs:element name="FeedbackNotice"><xs:complexType><xs:annotation><xs:documentation><p>Posts a CIP document containing CIP state feedback elements from the CIP
subscriber to the CIP publisher. FeedbackNotice contains zero or more
CampInfoPkg elements, and zero or more Ext extension elements. The isRetry
attribute signals that an exact duplicate of a prior message is being
posted.</p></xs:documentation></xs:annotation><xs:sequence><xs:element ref="cip:CampInfoPkg" minOccurs="0" maxOccurs="unbounded"/><xs:element name="Ext" type="common:ExtType" minOccurs="0" maxOccurs="unbounded"/></xs:sequence><xs:attribute name="isRetry" type="xs:boolean" default="false"/></xs:complexType></xs:element>
<xs:element name="FeedbackResponse"><xs:complexType><xs:annotation><xs:documentation><p>FeedbackResponse is a reply to a FeedbackNotice message. FeedbackResponse
elements include a MsgResultAttributeGroup attribute group.</p><p>The optional Notes element can provide supplemental detail.</p></xs:documentation></xs:annotation><xs:sequence><xs:element name="Notes" type="xs:string" minOccurs="0"/><xs:element name="Ext" type="common:ExtType" minOccurs="0" maxOccurs="unbounded"/></xs:sequence><xs:attributeGroup ref="cip:MsgResultAttributeGroup"/></xs:complexType></xs:element>
<xs:element name="InvalidRequest"><xs:complexType><xs:annotation><xs:documentation><p>An InvaldRequest is sent in response to an errored Read Request.</p><p>An InvalidRequest element MUST contain a Reason element, containing one of the
following fault indicators:</p><ul><li><tt>From-ToNotPaired</tt>indicates that the sender and recipient are
not paired.</li><li><tt>IdOwnerNotPaired</tt>indicates that the ID and owner are not
paired.</li><li><tt>NoSelection</tt>indicates that a selection is required.</li><li><tt>NoneFound</tt>indicates that no search results were returned.</li><li><tt>private:.+</tt>contains a private fault code, behavior
undefined.</li></ul><p>The Values (of type BundleSelectorGroup) attribute group repeats the received
request.</p><p>The optional Notes element can provide supplemental detail.</p><p>contextId is an optional value that MUST be present<em>if and only if</em>it was supplied in the readRequest message to which this InvalidRequest
message is the response.</p></xs:documentation></xs:annotation><xs:sequence><xs:element name="Reason"><xs:simpleType><xs:restriction base="xs:NMTOKEN"><xs:pattern value="From-ToNotPaired|IdOwnerNotPaired|NoSelection|NoneFound|private:.+"/></xs:restriction></xs:simpleType></xs:element><xs:element name="Values"><xs:complexType><xs:sequence/><xs:attributeGroup ref="cip:BundleSelectorGroup"/></xs:complexType></xs:element><xs:element name="Notes" type="xs:string" minOccurs="0"/><xs:element name="Ext" type="common:ExtType" minOccurs="0" maxOccurs="unbounded"/></xs:sequence><xs:attribute name="contextId" type="cip:ContextIdType" use="optional"/></xs:complexType></xs:element>
<xs:element name="ReadRequest"><xs:complexType><xs:annotation><xs:documentation><p>A ReadRequest message provides a client the ability to request CIP data. The
BundleSelectorGroup identifies the top-level bundles to be returned.</p><p>The contextId attribute is optional, but if it is present, it MUST be
returned in the ReadResponse that satisifes this readRequest.</p></xs:documentation></xs:annotation><xs:sequence><xs:element name="Ext" type="common:ExtType" minOccurs="0" maxOccurs="unbounded"/></xs:sequence><xs:attribute name="contextId" type="cip:ContextIdType" use="optional"/><xs:attributeGroup ref="cip:BundleSelectorGroup"/></xs:complexType></xs:element>
<xs:element name="ReadResponse"><xs:complexType><xs:annotation><xs:documentation><p>A ReadResponse message is sent in reponse to a successful ReadRequest. ReadResponse will
contain a CampInfoPkg with zero or more Bundle elements that satisfy the
criteria identified by a ReadRequest.</p><p>The optional Notes element can provide supplemental detail.</p><p>contextId is an optional value that MUST be present<em>if and only if</em>it was supplied in the readRequest message to which this ReadResponse
message is the response.</p></xs:documentation></xs:annotation><xs:sequence><xs:element ref="cip:CampInfoPkg"/><!-- was 0 – unbounded, now required once --><xs:element name="Notes" type="xs:string" minOccurs="0"/><xs:element name="Ext" type="common:ExtType" minOccurs="0" maxOccurs="unbounded"/></xs:sequence><xs:attribute name="contextId" type="cip:ContextIdType" use="optional"/><xs:attributeGroup ref="cip:MsgResultAttributeGroup"/></xs:complexType></xs:element>
<xs:element name="GetRegistrationRequest"><xs:complexType><xs:annotation><xs:documentation><p>A GetRegistration message enables the consumer site identified by the
Subscriber URI to issue this message to a publisher site to query the
current list of active syscodes for the given consumer site.</p></xs:documentation></xs:annotation><xs:sequence><xs:element name="Subscriber" type="xs:anyURI"/><xs:element name="Ext" type="common:ExtType" minOccurs="0" maxOccurs="unbounded"/></xs:sequence></xs:complexType></xs:element>
<xs:element name="GetRegistrationResponse"><xs:complexType><xs:annotation><xs:documentation><p>Response for GetRegistration message. Identifies the target URI and a list of
currently-enabled syscodes for that URI.</p><p>The optional Notes element can provide supplemental detail.</p></xs:documentation></xs:annotation><xs:sequence><xs:element name="Subscriber" type="xs:anyURI"/><xs:element name="Syscodes" type="common:SyscodeType" minOccurs="0" maxOccurs="unbounded"/><xs:element name="Notes" type="xs:string" minOccurs="0"/><xs:element name="Ext" type="common:ExtType" minOccurs="0" maxOccurs="unbounded"/>
