Page Comparison

Excerpt

hidden	false

Submit substitutions of collateral.

Panel

borderColor	lightgray

URL	`/collateral/substitutions`
HTTP Method	`POST`
Version	1.0.30

Panel

borderColor	lightgray
title	Content

Table of Contents

maxLevel	2

Request

Parameters

Parameter

Name

Location

Type

Multi-ple

Values

Usage

Description

CME-Application-Name

Application Name

Header

String

No

Status

subtle	true
colour	Green
title	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

Status

subtle	true
colour	Green
title	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

Status

subtle	true
colour	Green
title	REQUIRED

Version identifier for the customer system.

CME-Request-ID

Request ID

Header

String

No

Status

subtle	true
colour	Green
title	REQUIRED

Identifier for the customer message.

CME-Transact-Time

Transaction Time

Header

DateTime

No

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

Status

subtle	true
colour	Green
title	REQUIRED

Timestamp of when the message was sent from customer system.

Body

Anchor
RequestCollateralRequestMessage
RequestCollateralRequestMessage
Collateral Request Message - CollateralRequestMessage

Field	Name	Type	Values	Usage	Description
payload[]	Payload	Collateral

Anchor
RequestCollateralRequestMessage.payload[]
RequestCollateralRequestMessage.payload[]
Collateral - CollateralRequestMessage.payload[]

Field

Name

Type

Values

Usage

Description

notificationGuid

Notification GUID

String

Status

subtle	true
colour	Green
title	REQUIRED

qty

Quantity

Status

subtle	true
colour	Green
title	REQUIRED

instrument

Instrument

Anchor
RequestCollateralRequestMessage.payload[].instrument
RequestCollateralRequestMessage.payload[].instrument
Instrument - CollateralRequestMessage.payload[].instrument

Field

Name

Type

Values

Usage

Description

cusip

Cusip

String

Status

subtle	true
colour	Blue
title	CONDITIONAL

Some identifier for the collateral being allocated must be provided, either GUID, CUSIP, or ISIN.

guid

GUID

String

Status

subtle	true
colour	Blue
title	CONDITIONAL

Some identifier for the collateral being allocated must be provided, either GUID, CUSIP, or ISIN.

isin

ISIN

String

Status

subtle	true
colour	Blue
title	CONDITIONAL

Some identifier for the collateral being allocated must be provided, either GUID, CUSIP, or ISIN.

Response - 200

Body

Anchor
Response200CollateralResponseMessage
Response200CollateralResponseMessage
Collateral Response Message - CollateralResponseMessage

Field	Name	Type	Values	Usage	Description
payload[]	Payload	Collateral

Anchor
Response200CollateralResponseMessage.payload[]
Response200CollateralResponseMessage.payload[]
Collateral - CollateralResponseMessage.payload[]

Field

Name

Type

Values

Usage

Description

collateralGuid

Collateral GUID

String

Status

subtle	true
colour	Green
title	ALWAYS

Note: this is the GUID of the newly introduced collateral.

venueCollateralNbr

Venue Collateral ID

String

Status

subtle	true
colour	Green
title	ALWAYS

links[]

Links

Link

Anchor
Response200CollateralResponseMessage.payload[].links[]
Response200CollateralResponseMessage.payload[].links[]
Link - CollateralResponseMessage.payload[].links[]

Field

Name

Type

Values

Usage

Description

href

Reference

URI

Status

subtle	true
colour	Green
title	ALWAYS

rel

Relationship Type

LinkRelationshipType

ORIGINAL_ALLOCATION
REMAINING_ALLOCATION
SELF
SUBSTITUTION

Status

subtle	true
colour	Green
title	ALWAYS

Allocations will only result in a SELF link, while substitutions may include all four

Response - 400

Body

Anchor
Response400ErrorResponseMessage
Response400ErrorResponseMessage
Error Response Message - ErrorResponseMessage

Field	Name	Type	Values	Usage	Description
errors[]	Errors	Error

Anchor
Response400ErrorResponseMessage.errors[]
Response400ErrorResponseMessage.errors[]
Error - ErrorResponseMessage.errors[]

Field

Name

Type

Values

Usage

Description

code

Code

String

Status

subtle	true
colour	Green
title	ALWAYS

instance

Instance

String

Status

subtle	true
colour	Grey
title	OPTIONAL

message

Message

String

Status

subtle	true
colour	Green
title	ALWAYS

referenceIndex

Reference Index

Integer

Status

subtle	true
colour	Green
title	ALWAYS

Versions Compared

Old Version 2

New Version Current

Key

Request

Parameters

Body

Anchor
RequestCollateralRequestMessage
RequestCollateralRequestMessage
Collateral Request Message - CollateralRequestMessage

Anchor
RequestCollateralRequestMessage.payload[]
RequestCollateralRequestMessage.payload[]
Collateral - CollateralRequestMessage.payload[]

Anchor
RequestCollateralRequestMessage.payload[].instrument
RequestCollateralRequestMessage.payload[].instrument
Instrument - CollateralRequestMessage.payload[].instrument

Response - 200

Body

Anchor
Response200CollateralResponseMessage
Response200CollateralResponseMessage
Collateral Response Message - CollateralResponseMessage

Anchor
Response200CollateralResponseMessage.payload[]
Response200CollateralResponseMessage.payload[]
Collateral - CollateralResponseMessage.payload[]

Anchor
Response200CollateralResponseMessage.payload[].links[]
Response200CollateralResponseMessage.payload[].links[]
Link - CollateralResponseMessage.payload[].links[]

Response - 400

Body

Anchor
Response400ErrorResponseMessage
Response400ErrorResponseMessage
Error Response Message - ErrorResponseMessage

Anchor
Response400ErrorResponseMessage.errors[]
Response400ErrorResponseMessage.errors[]
Error - ErrorResponseMessage.errors[]

Response - 401

Page Comparison

Versions Compared

Old Version 2

New Version Current

Key

Request

Parameters

Body

AnchorRequestCollateralRequestMessageRequestCollateralRequestMessageCollateral Request Message - CollateralRequestMessage

AnchorRequestCollateralRequestMessage.payload[]RequestCollateralRequestMessage.payload[]Collateral - CollateralRequestMessage.payload[]

AnchorRequestCollateralRequestMessage.payload[].instrumentRequestCollateralRequestMessage.payload[].instrumentInstrument - CollateralRequestMessage.payload[].instrument

Response - 200

Body

AnchorResponse200CollateralResponseMessageResponse200CollateralResponseMessageCollateral Response Message - CollateralResponseMessage

AnchorResponse200CollateralResponseMessage.payload[]Response200CollateralResponseMessage.payload[]Collateral - CollateralResponseMessage.payload[]

AnchorResponse200CollateralResponseMessage.payload[].links[]Response200CollateralResponseMessage.payload[].links[]Link - CollateralResponseMessage.payload[].links[]

Response - 400

Body

AnchorResponse400ErrorResponseMessageResponse400ErrorResponseMessageError Response Message - ErrorResponseMessage

AnchorResponse400ErrorResponseMessage.errors[]Response400ErrorResponseMessage.errors[]Error - ErrorResponseMessage.errors[]

Response - 401

Anchor
RequestCollateralRequestMessage
RequestCollateralRequestMessage
Collateral Request Message - CollateralRequestMessage

Anchor
RequestCollateralRequestMessage.payload[]
RequestCollateralRequestMessage.payload[]
Collateral - CollateralRequestMessage.payload[]

Anchor
RequestCollateralRequestMessage.payload[].instrument
RequestCollateralRequestMessage.payload[].instrument
Instrument - CollateralRequestMessage.payload[].instrument

Anchor
Response200CollateralResponseMessage
Response200CollateralResponseMessage
Collateral Response Message - CollateralResponseMessage

Anchor
Response200CollateralResponseMessage.payload[]
Response200CollateralResponseMessage.payload[]
Collateral - CollateralResponseMessage.payload[]

Anchor
Response200CollateralResponseMessage.payload[].links[]
Response200CollateralResponseMessage.payload[].links[]
Link - CollateralResponseMessage.payload[].links[]

Anchor
Response400ErrorResponseMessage
Response400ErrorResponseMessage
Error Response Message - ErrorResponseMessage

Anchor
Response400ErrorResponseMessage.errors[]
Response400ErrorResponseMessage.errors[]
Error - ErrorResponseMessage.errors[]