All pages
Powered by GitBook
1 of 1

Loading...

AM/FA/Inv - Get Tender Offer Correlation ID History

Details

/external/v1/tender-offers/correlation-id/history

Synopsis

Get Tender Offer Correlation Ids History

get

This route is used to retrieve the history data entries of tender offer correlation ids given a set of filters such as blockchain details.

The history entries will reflect the state of the Tender Offer correlation ids on a particular block on the ledger.

This endpoint returns paginated data. Up to 20 can be extracted per call.

This endpoint can be called by applications with access to scope "manageReferenceData".

Authorizations
Query parameters
pageSizenumberOptional

The number of rows being retrieved. Must be a positive integer.

offsetnumberOptional

The offset (i.e. row start index). Must be a positive integer (or 0).

blockNumbernumber · max: 2147483647Optional

The block number where the action was recorded on the ledger.

Example: 350
transactionIdstring · max: 500Optional

The transaction id where the action was recorded on the ledger.

Example: 456789OIJHGFCVGHJKLKJHGF67JHPattern: ^[a-zA-Z0-9-]*$
channelNamestring · max: 20Optional

The name of the channel where the action was recorded on the ledger.

Example: OG123Pattern: ^[a-zA-Z0-9-]*$
Responses
200
Successfully retrieved the Tender Offer Correlation Ids history entries
application/json
400
The following error codes can be returned: - GN0002 - GN0004 - GN0005 Please refer to the error code dictionary for the details of each error code.
application/json
401
The following error codes can be returned: - AU0001 Please refer to the error code dictionary for the details of each error code.
application/json
403
The following error codes can be returned: - AU0002 Please refer to the error code dictionary for the details of each error code.
application/json
get
GET /external/v1/tender-offers/correlation-id/history HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
[
  {
    "signerData": {
      "name": "John Doe",
      "email": "[email protected]"
    },
    "timestamp": "2024-09-12T00:00:00.000Z",
    "blockNumber": 350,
    "transactionId": "456789OIJHGFCVGHJKLKJHGF67JH",
    "channelName": "OG123",
    "organization": {
      "name": "Test Organization",
      "orgId": "TEST1234"
    },
    "event": "Created",
    "update": {
      "correlationId": "123245573717",
      "entityType": "account",
      "entityId": "OG1234567890",
      "status": "broadcast",
      "origin": "Backoffice-system-123",
      "organization": {
        "name": "Test Organization",
        "orgId": "TEST1234"
      }
    }
  }
]