Endpoint Parameters

  • Request parameters

    Name Type Origin Description
    EntitlementFieldSet EntitlementFieldSet Query-String
  • Response Parameters

    View Response Codes
    Name Type Description
    __count Number The total count of items in the feed.
    __next String The link for the next page of items in the feed.
    Data EntitlementDetails [] The collection of entities for this feed.
    MaxRows Number The maximum number of rows that can be returned (if applicable).
  • Request Example

    Request URL
    GET /port/v1/users/me/entitlements?EntitlementFieldSet=Default
  • Response Example

    Response body
    {
      "Data": [
        {
          "Entitlements": [
            {
              "DelayedFullBook": [
                "CertificateCapitalProtectionWithCoupon"
              ],
              "DelayedGreeks": [
                "CertificateOtherCapitalProtection"
              ],
              "Greeks": [
                "CertificateCapitalProtectionWithKnockOut"
              ],
              "RealTimeFullBook": [
                "WarrantOtherLeverageWithKnockOut"
              ],
              "RealTimeTopOfBook": [
                "WarrantOtherLeverageWithoutKnockOut"
              ]
            }
          ],
          "ExchangeId": "stringValue"
        }
      ],
      "MaxRows": 99
    }