CME GC Allocator API - Message Specification - Get Notifications
Request a notification by Notification GUID. Results will be limited to top-day notifications.
URL |
|
---|---|
HTTP Method |
|
Version | 1.0.30 |
Content |
---|
Â
Â
Â
Request
Parameters
Parameter | Name | Location | Type | Multi-ple | Values | Usage | Description |
---|---|---|---|---|---|---|---|
| Application Name | Header |
| No | Â | REQUIRED | Name of the customer system that generated the message. Must match the system name as certified in AutoCert+ exactly. |
| Application Vendor | Header |
| No | Â | REQUIRED | Name of the vendor who provided the customer system. For a proprietary system, use the firm name. |
| Application Version | Header |
| No | Â | REQUIRED | Version identifier for the customer system. |
| Request ID | Header |
| No | Â | REQUIRED | Identifier for the customer message. |
| Transaction Time | Header |
| No | Format:Â | OPTIONAL | Timestamp of when the message was sent from customer system. |
| Notification GUID | Path |
| No | Â | REQUIRED | Â |
Response - 200
Body
Collateral Notification Response Message - CollateralNotificationResponseMessage
Field | Name | Type | Values | Usage | Description |
---|---|---|---|---|---|
Payload |
| Â | Â | Â |
Collateral Notification - CollateralNotificationResponseMessage.payload[]
Field | Name | Type | Values | Usage | Description |
---|---|---|---|---|---|
| Acknowledgement Status |
| ALWAYS | Â | |
| Notification GUID |
| Â | ALWAYS | Â |
| Notification Quantity |
| Â | ALWAYS | Â |
| Notification Remaining Quantity |
| Â | ALWAYS | Â |
| Notification Sequence Number |
| Â | ALWAYS | Â |
| Transaction Time |
| Format:Â | ALWAYS | Â |
Collateral |
| Â | Â | Â | |
Trade |
| Â |
Collateral - CollateralNotificationResponseMessage.payload[].collateral
Field | Name | Type | Values | Usage | Description |
---|---|---|---|---|---|
| CollateralGuid |
| Â | 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 |
---|---|---|---|---|---|
Instrument |
| Â | Â | Â | |
Sides |
| Â | Â | Â |
Instrument - CollateralNotificationResponseMessage.payload[].trade.instrument
Â
Field | Name | Type | Values | Usage | Description |
---|---|---|---|---|---|
| Exchange ID |
| Â | ALWAYS | Â |
Trade Side - CollateralNotificationResponseMessage.payload[].trade.sides[]
Field | Name | Type | Values | Usage | Description |
---|---|---|---|---|---|
| Side GUID |
| Â | ALWAYS | Â |
Response - 400
Body
Error Response Message - ErrorResponseMessage
Field | Name | Type | Values | Usage | Description |
---|---|---|---|---|---|
Errors |
| Â | Â | Â |
Error - ErrorResponseMessage.errors[]
Field | Name | Type | Values | Usage | Description |
---|---|---|---|---|---|
| Code |
| Â | ALWAYS | Â |
| Instance |
| Â | OPTIONAL | Â |
| Message |
| Â | ALWAYS | Â |
| Reference Index |
| Â | ALWAYS | Â |
Response - 401
Response - 404
How was your Client Systems Wiki Experience? Submit Feedback
Copyright © 2024 CME Group Inc. All rights reserved.