AM/TA - Update Positions

Details

/external/v1/position/batch-update

Synopsis

Update Positions

put

This route is used to trigger the update of a set of provided positions. This triggers an asynchronous process (the id of which is returned on the success response) to persist this information on the blockchain which can be monitored using the "Transactions API" endpoints. This endpoint can be invoked if the security is in one of the following statuses: ["active","completed","approved_revert_to_active","closed"]. This endpoint can be invoked if the positions are in one of the following statuses: ["sync"]. This endpoint can be invoked only by the organizations that own the positions. This endpoint can't be invoked if the security is restricted. This endpoint can be called by applications with access to scope "managePosition".

Required scopes

This endpoint requires the following scopes:

• : managePosition

Authorizations

oauth2

OAuth2clientCredentialsRequired

Token URL:

Body

application/json

Responses

200

Successfully triggered the process to update the list of positions on the ledger. The "processId" and "orchestrationId" properties can be used on the "Transactions API" to monitor the status of this asynchronous process.

application/json

400

The following error codes can be returned: - GN0002 - PO0013 - PO0011 - PO0015 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 - PO0014 Please refer to the error code dictionary for the details of each error code.

application/json

404

The following error codes can be returned: - IS0009 - PO0013 Please refer to the error code dictionary for the details of each error code.

application/json

409

The following error codes can be returned: - IS0120 Please refer to the error code dictionary for the details of each error code.

application/json

put

/external/v1/position/batch-update

HTTPcURLJavaScriptPython

PUT /external/v1/position/batch-update HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 299

{
  "transactionData": {
    "securityId": "USS3JKS01I00",
    "signer": {
      "email": "[email protected]",
      "name": "John Doe"
    }
  },
  "positionData": [
    {
      "positionIdentifier": {
        "positionId": "POS123456789"
      },
      "dividendReinvestmentPlanElection": "reinvest",
      "lotSelectionElection": "fifo",
      "extraData": {
        "customField1": "customValue1"
      }
    }
  ]
}

{
  "processData": {
    "processId": "2159457f-0167-4e93-a969-9cf0db05e0bf",
    "orchestrationId": "2159457f-0167-4e93-a969-9cf0db05e0bf"
  }
}