Page tree
Skip to end of metadata
Go to start of metadata

When an XML document is submitted to CME STP BaCE, the root element must always be the CHML element. This is the standard header element.

CHML Element

The CHML element has the following attribute:

Attribute Name

Type

Length

Required

Description

SchemaVersion

string


required

Version number of the CME STP BaCE schema used to create the submitted file.

The CHML element contains one of the following child elements:

Element

Description

Deals

A trade-record submission to CME STP BaCE.

CHResponses

 A response from CME STP BaCE to one of the following requests:

  • trade-record submission
  • trade-record update

CHReport

A response from CME STP BaCE to a query for reference-data tables in the database.

CHRequest

One of the following requests to CME STP BaCE:

  • a query for specific trades
  • one of the following updates to a trade record:
    •  accept the trade
    • reject the trade
    • update the trade with a reference number 

CHRequest Element

The CHRequest element contains information for querying CME STP BaCE about trades and reference data. This is the standard request element, which follows the standard CHML header element.

Element

Description

RefDataQuery

Criteria for querying the reference-data tables.

UpdateRequest

Used to accept trades, reject trades and update trades with reference numbers.

After this request is submitted, CME STP BaCE returns the requested data in the CHReport element.


CHResponses Element

Each CHResponse element is a response from CME STP BaCE after to one of the following requests:

  • Initial request
  • A broker submitted a trade file through the API, using the Deals element.
  • A trading company updated trade records in CME STP BaCE, using the UpdateRequest element.


The CHResponses element can contain one or more CHEvent child elements. The CHEvent element represents an event that occurred and to which the user subscribes.

Attribute Name

Type

Length

Valid Values

Required

Description

Code

int


1=The request was successful.

A negative number = error code, indicating that the request was unsuccessful.

required

Code indicating whether the original request was successful:

Details

string



optional

If the query failed, this is an error message.