Copyright (c)2016, Cable Television Laboratories, Inc. ESAM Common XML Schema, Release Version C01 Real-time Event Signaling and Management API This schema is a normative component of CableLabs® Real-time Event Signaling and Management API Specification, OC-SP-ESAM-API-C01-161021

Signal Acquisition System registration request message element. Use to pass callout addresses and attributes. Registration response message element. SPS accepts or denies the registration from an SAS. SPS Registration request message element sent from an SPS to an SAS. SPS can pass details on the SPS inclusive of redudant end points, etc. Registration response message element. SAS accepts or denies the registration from an SPS. SAS deregister request message element. Deregistration response message element. SPS accepts or denies the registration from an SAS. SPS deregister request message element. Deregistration response message element. SAS accepts or denies the registration from an SPS. Container for passing a Uri reference to a processing system that has descriptive data related to the specified uri A unique identity of the acquisition point. (ex. MUX5) A unique identifier for the Batch The identity of the underlying asset to process. Typically used for processing a file based asset that has associated descriptive data about points and regions of interest within an asset. Optional spsToken for the SPS. This token should appear in any messages exchanged between the SAS and SPS. Optional sasToken as recieved in an SASRegistrationRequest. The sasToken should appear in any messages exchanged betweened the SAS and SPS. In addition to the attributes defined, Uri Process Request may include additional, custom attributes as needed by the application. A unique identity of the acquisition point. (ex. MUX5) Optional identity of the underlying asset to process. The PAID or other URL of the stream or asset. Optional start date/time - return SignalProcessingNotification with all event records equal to or later than the start date/time for the acquisition point identified in acquisitionPointIdentity. Optional spsToken for the SPS. This token should appear in any messages exchanged between the SAS and SPS. Optional sasToken as recieved in an SASRegistrationRequest. The sasToken should appear in any messages exchanged betweened the SAS and SPS. Container to sending status of a processing request from the signal acquisition system to the signal processing system. Container for acknowledging a ProcessStatusNotification Container to request status of a process from the signal acquisition system and a signal processing system. Container for responding to a ProcessStatusRequest Service check request message element. Service status notification message element. Endpoint information type. Endpoint information. A unique identifier for the Batch Batch info may include additional, custom attributes as needed by the application. Specific message to be delivered via the supplied destination. Omit if all messages are to be delivered to the specified destination. All messages or per message type destination endpoint identification. Provides return status information to the caller and is returned for all errors. May optionally be included in a response payload to provide warning or informational details. A unique identity of the acquisition point. (ex. MUX5) A globally unique ID for the point referenced. A unique identifier for the Batch Optional spsToken for the SPS. This token should appear in any messages exchanged between the SAS and SPS. Optional sasToken as recieved in an SASRegistrationRequest. The sasToken should appear in any messages exchanged betweened the SAS and SPS. A process status acknowledgemetn may include additional, custom attributes as needed by the application. Provides return status information to the caller and is returned for all errors. May optionally be included in a response payload to provide warning or informational details. This element provides ability to provide notifications on multiple signals. A globally unique ID for the point referenced. SPS identifier for the signal this notification is associated with. Use core:AssetRefType when referencing a signalPointID. NOTE: not to be confused with the acquisitionSignalID generated by an acquisiton device if this signal is instantiated based on receipt of some instream signaling. A unique identity of the acquisition point. (ex. MUX5) A globally unique ID for the point referenced. SPS identifier for the signal this notification is associated with. Use core:AssetRefType when referencing a signalPointID. NOTE: not to be confused with the acquisitionSignalID generated by an acquisiton device if this signal is instantiated based on receipt of some instream signaling. A unique identifier for the Batch Optional spsToken for the SPS. This token should appear in any messages exchanged between the SAS and SPS. Optional sasToken as recieved in an SASRegistrationRequest. The sasToken should appear in any messages exchanged betweened the SAS and SPS. A process status notification may include additional, custom attributes as needed by the application. Provides return status information to the caller and is returned for all errors. May optionally be included in a response payload to provide warning or informational details. A unique identity of the acquisition point. (ex. MUX5) A globally unique ID for the point referenced. A unique identifier for the Batch Optional spsToken for the SPS. This token should appear in any messages exchanged between the SAS and SPS. Optional sasToken as recieved in an SASRegistrationRequest. The sasToken should appear in any messages exchanged betweened the SAS and SPS. A process status response may include additional, custom attributes as needed by the application. A unique identity of the acquisition point. (ex. MUX5) A globally unique ID for the point referenced. A unique identifier for the Batch Optional spsToken for the SPS. This token should appear in any messages exchanged between the SAS and SPS. Optional sasToken as recieved in an SASRegistrationRequest. The sasToken should appear in any messages exchanged betweened the SAS and SPS. A process status request may include additional, custom attributes as needed by the application. SAS Callouts - end points for SPS to call for specified functions. SAS Attributes. Name of attribute in name/value pair. A unique identity of the acquisition point. Unique token to associate with this registration request. The token may be passed on any message sent from the signal processing system to the signal acquisition system. If an SAS system is replacing another SAS system, this is the identity of the SAS system being replaced. If an SAS system is replacing another SAS system, this is the token of the SAS system being replaced. An SPS may return the callouts for the SAS to utilize. A unique identity of the signal processign system. SPS token that applies to all SPS end points defined. Optional sasToken as recieved in the SASRegistrationRequest. For each SPS end point, the set of callouts and attributes for each. A unique identity of the signal processign system. Optional spsToken for the SPS. This token should appear in any messages exchanged between the SAS and SPS. Optional sasToken as recieved in an SASRegistrationRequest. The sasToken should appear in any messages exchanged betweened the SAS and SPS. Optional spsToken for the SPS. This token should appear in any messages exchanged between the SAS and SPS. Optional sasToken as passed in the SASRegistrationRequest. Provides return status information to the caller and is returned for all errors. May optionally be included in a response payload to provide warning or informational details. A unique identity of the acquisition point. Reference to a previous SASRegistrationRequest message. A unique identity of the acquisition point. Optional sasToken as passed in the SASRegistrationRequest. Provides return status information to the caller and is returned for all errors. May optionally be included in a response payload to provide warning or informational details. A unique identity of the signal processing system. Reference to a previous SASRegistrationRequest message. Reference to a previous SPSRegistrationRequest message. A unique identity of the signal processing system. Optional spsToken for the SPS. This token should appear in any messages exchanged between the SAS and SPS. Optional sasToken as passed in the SASRegistrationRequest. An end point SHALL send a ServiceStatusNotification in response to a ServiceCheckRequest message. Contains SPS identity if the SPS is sending the message. Contains SAS identity if the SAS is sending the message. Optional spsToken for the SPS. This token should appear in any messages exchanged between the SAS and SPS. Optional sasToken as recieved in an SASRegistrationRequest. The sasToken should appear in any messages exchanged betweened the SAS and SPS. A ServiceStatusNotification SHALL be sent in response to a ServiceCheckRequest message. A ServiceStatusNotification MAY be sent asynchronously to notify an end point of a change of status. Provides return status information to the caller and is returned for all errors. May optionally be included in a response payload to provide warning or informational details. Contains SPS identity if the SPS is sending the message. Contains SAS identity if the SAS is sending the message. Optional spsToken for the SPS. This token should appear in any messages exchanged between the SAS and SPS. Optional sasToken as recieved in an SASRegistrationRequest. The sasToken should appear in any messages exchanged betweened the SAS and SPS. Processing Notification Type - message to acquisition point to direct processing Supplied with SignalProcessingNotification invoked for batch processing. A shource is required. Zero, one or more destinations can be provided. Provides return status information to the caller and is returned for all errors. May optionally be included in a response payload to provide warning or informational details. Unique identity of the signal processing system. A unique identity of the acquisition point. Optional spsToken for the SPS. This token is from the last SPS registration. Optional sasToken as recieved in an SASRegistrationRequest. In addition to the attributes defined, signal processing notification may include additional, custom attributes as needed by the application. The identity of a batch. Should be Universally Unique Identifier as defined by RFC 4122 SPS Callouts Type is used to communicate one or more SPS end points. SPS Callouts - end points for SAS to call for specfied funcstions. SPS Attributes. Name of attribute in name/value pair. Name of the SPS End Point the call outs apply to.