CME GC Allocation API - Message Specification - Submit Notifications
Submit notification of intent to substitute an existing collateral allocation or substitution.
URL | /notifications |
|---|---|
HTTP Method | POST |
Version | 1.0.30 |
Content |
|---|
Request
Parameters
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 | REQUIRED | Timestamp of when the message was sent from customer system. |
Body
Collateral Notification Request Message - CollateralNotificationRequestMessage
Field | Name | Type | Values | Usage | Description |
|---|---|---|---|---|---|
payload[] | Payload | CollateralNotification |
|
|
|
Collateral Notification - CollateralNotificationRequestMessage.payload[]
Field | Name | Type | Values | Usage | Description |
|---|---|---|---|---|---|
notificationQty | Notification Quantity | Integer |
| REQUIRED |
|
collateral | Collateral | Collateral |
|
|
|
Collateral - CollateralNotificationRequestMessage.payload[].collateral
Field | Name | Type | Values | Usage | Description |
|---|---|---|---|---|---|
collateralGuid | Collateral GUID | String |
| REQUIRED |
|
Response - 200
Body
Collateral Notification Response Message - CollateralNotificationResponseMessage
Field | Name | Type | Values | Usage | Description |
|---|---|---|---|---|---|
Payload | CollateralNotification |
| |||
Collateral Notification - CollateralNotificationResponseMessage.payload[]
Field | Name | Type | Values | Usage | Description |
|---|---|---|---|---|---|
acknowledgementStatus | Acknowledgement Status |
| ALWAYS |
| |
notificationGuid | Notification GUID | String |
| ALWAYS |
|
notificationQty | Notification Quantity | Integer |
| ALWAYS |
|
notificationSequenceNbr | Notification Sequence Number | String |
| ALWAYS |
|
transactionTime | Transaction Time | DateTime | Format: yyyy-mm-ddThh:mm:ss.dZ | ALWAYS |
|
Response - 400
Body
Error Response Message - ErrorResponseMessage
Field | Name | Type | Values | Usage | Description |
|---|---|---|---|---|---|
Errors | Error |
|
|
|
Error - ErrorResponseMessage.errors[]
Field | Name | Type | Values | Usage | Description |
|---|---|---|---|---|---|
code | Code | String |
| ALWAYS |
|
instance | Instance | String |
| OPTIONAL |
|
message | Message | String |
| ALWAYS |
|
referenceIndex | Reference Index | Integer |
| ALWAYS |
|