Reports the current status of an allocation cancellation.
Sent to the requester whenever the cancellation status changes.
Note:
This message is used only to track the status of the "allocation cancellation action."
For details about the Operation generated by the cancellation, consume the TradeOperationsSnapshot, which will also be sent.
The following flow shows the messages involved in the allocation cancellation process:
(In this example, assume that 'Operation 1111' originally had a quantity of 50.)
R1: This field will only be populated when AllocationCancellationStatus is 91, 92, or 99.
R2: This field will only be populated when AllocationCancellationStatus is 41.
R3: This field will only be populated when AllocationCancellationStatus is 42.
| Index | Field | Type | Required | Description | Rules |
|---|---|---|---|---|---|
| 1 | ParticipantRequestInfo | object | YES | Information about the original request whose status is being updated | |
| 1.1 | RequestId | string | YES | Unique request identifier assigned by the participant | |
| 1.2 | RequesterParticipantCode | string | YES | Requesting participant code | |
| 1.3 | OriginalMessageTypeCode | string | NO | Original message type in the base-m-cad-???-##-### pattern |
|
| 2 | AllocationCancellationStatus | integer | YES | Cancellation status Possible values: AllocationCancellationStatus |
|
| 3 | ResultingOperationInformation | object | NO | Information about the operation created as a result of the cancellation, when successful | R1 |
| 3.1 | AssignedOperationCode | string | YES | Code assigned by the Clearinghouse to the operation resulting from the allocation. It is the unique identifier and must be used for future actions | |
| 4 | RemainingOperationInformation | object | NO | Information about the remaining operation, when successful | R1 |
| 4.1 | Quantity | integer | YES | Quantity remaining in the previous operation after the allocation | |
| 5 | Errors | array | NO | If errors occur, identifies them | R2 |
| 5.1 | ErrorCode | string | YES | Error code | |
| 5.2 | ErrorMessage | string | NO | Brief error description | |
| 5.3 | ElementPath | string | NO | Path of the field related to the error, when applicable | |
| 5.4 | ElementContent | string | NO | Content received in the field related to the error, when applicable | |
| 6 | RejectionReason | object | NO | When applicable, information about the reason for rejecting the cancellation | R3 |
| 6.1 | Message | string | YES | Reason for rejecting the allocation |
{
"ParticipantRequestInfo": {
"RequestId": "3F1127A12A9B47E7B6D638CBFE0C0824",
"RequesterParticipantCode": "22"
},
"AllocationCancellationStatus": 91,
"ResultingOperationInformation": {
"AssignedOperationCode": "E22FCABBA8FB41A096F9AF4088FD9B4C"
},
"RemainingOperationInformation": {
"Quantity": 0
}
}