CME GC Allocation 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 |
|