CME GC Allocator API - Message Specification - Get Notifications

Request a notification by Notification GUID. Results will be limited to top-day notifications.

URL

/notifications/{notificationGuid}

HTTP Method

GET

Version

1.0.30

Content







Request

Parameters

Parameter

Name

Location

Type

Multi-ple

Values

Usage

Description

Parameter

Name

Location

Type

Multi-ple

Values

Usage

Description

CME-Application-Name

Application Name

Header

String

No



REQUIRED

Name of the customer system that generated the message. Must match the system name as certified in AutoCert+ exactly.

CME-Application-Vendor

Application Vendor

Header

String

No



REQUIRED

Name of the vendor who provided the customer system. For a proprietary system, use the firm name.

CME-Application-Version

Application Version

Header

String

No



REQUIRED

Version identifier for the customer system.

CME-Request-ID

Request ID

Header

String

No



REQUIRED

Identifier for the customer message.

CME-Transact-Time

Transaction Time

Header

DateTime

No

Format:  yyyy-mm-ddThh:mm:ss.dZ

OPTIONAL

Timestamp of when the message was sent from customer system.

notificationGuid

Notification GUID

Path

String

No



REQUIRED



Response - 200

Body

Collateral Notification Response Message - CollateralNotificationResponseMessage

Field

Name

Type

Values

Usage

Description

Field

Name

Type

Values

Usage

Description

payload[]

Payload

CollateralNotification







Collateral Notification - CollateralNotificationResponseMessage.payload[]

Field

Name

Type

Values

Usage

Description

Field

Name

Type

Values

Usage

Description

acknowledgementStatus

Acknowledgement Status

TransactionAcknowledgementStatus

  • ACKNOWLEDGED

  • CANCELED

  • COMPLETED

  • NOTIFIED

ALWAYS



notificationGuid

Notification GUID

String



ALWAYS



notificationQty

Notification Quantity

Integer



ALWAYS



notificationQtyRemaining

Notification Remaining Quantity

Integer



ALWAYS



notificationSequenceNbr

Notification Sequence Number

String



ALWAYS



transactionTime

Transaction Time

DateTime

Format:  yyyy-mm-ddThh:mm:ss.dZ

ALWAYS



collateral

Collateral

Collateral







trade

Trade

Trade



Collateral - CollateralNotificationResponseMessage.payload[].collateral

Field

Name

Type

Values

Usage

Description

Field

Name

Type

Values

Usage

Description

collateralGuid

CollateralGuid

String



ALWAYS



The collateralGuid associated with the notification record at the time of the query. May change over time.



Trade - CollateralNotificationResponseMessage.payload[].trade

Field

Name

Type

Values

Usage

Description

Field

Name

Type

Values

Usage

Description

instrument

Instrument

Instrument







sides[]

Sides

TradeSide







Instrument - CollateralNotificationResponseMessage.payload[].trade.instrument



Field

Name

Type

Values

Usage

Description

Field

Name

Type

Values

Usage

Description

exchangeId

Exchange ID

String



ALWAYS



Trade Side - CollateralNotificationResponseMessage.payload[].trade.sides[]

Field

Name

Type

Values

Usage

Description

Field

Name

Type

Values

Usage

Description

sideGuid

Side GUID

String



ALWAYS



Response - 400

Body

Error Response Message - ErrorResponseMessage

Field

Name

Type

Values

Usage

Description

Field

Name

Type

Values

Usage

Description

errors[]

Errors

Error







Error - ErrorResponseMessage.errors[]

Field

Name

Type

Values

Usage

Description

Field

Name

Type

Values

Usage

Description

code

Code

String



ALWAYS



instance

Instance

String



OPTIONAL



message

Message

String



ALWAYS



referenceIndex

Reference Index

Integer



ALWAYS



Response - 401

Response - 404




How was your Client Systems Wiki Experience? Submit Feedback

Copyright © 2024 CME Group Inc. All rights reserved.