Endpoint Parameters

  • Request parameters

    Name Type Origin Description
    $skip Integer Query-String The number of entries to skip from the beginning of the collection
    $top Integer Query-String The number of entries to return from the beginning of the collection
    MustRenewBy Date Query-String Optional, Date till which the pending renewals should be returned, default value is 30 days from today
    OwnerKey ClientKey Query-String Optional, ClientKey of the owner, whose subclient's renewal status is needed
  • 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 RenewalStatusData [] 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 /cm/v1/clientrenewals/pending?$skip=1&$top=1&MustRenewBy=2020-12-31&OwnerKey=d2-PzdC5wIPy1284wD-rRA==
  • Response Example

    Response body
    {
      "__count": 2,
      "Data": [
        {
          "ClientId": "2147279170",
          "ClientKey": "7m4I|vtYLUnEGg77o9uQhw==",
          "RenewalBy": "2024-05-02T00:00:00Z",
          "RenewalStatus": "Waiting"
        },
        {
          "ClientId": "2147279171",
          "ClientKey": "27KN2aJ-338aeKnLTNOyCw==",
          "RenewalBy": "2024-05-12T00:00:00Z"
        }
      ]
    }