ACacculynx
supplements

Get Supplement Items

Changed on

Use this endpoint to get a list of items for a specific supplement in the current location. StartIndex starts at 0. The default PageSize is 25. Pagination parameters are optional. Example: api/v2/supplements/{supplementId}/items?pageSize=25&pageStartIndex=0

get/supplements/{supplementId}/items

Request

  • Base URL
    https://api.acculynx.com/api/v2
  • URL
    https://api.acculynx.com/api/v2/supplements/{supplementId}/items
  • Auth
    HTTP bearer

Path parameters

supplementIdstring uuid required

The supplement's unique identifier

Query parameters

pageSizeinteger

How many items to be returned at a time.

recordStartIndexinteger

The zero-based index of the first record to return.

Response

OK

countinteger

The total number of items matching the current query.

pageSizeinteger

The requested or default page size.

pageStartIndexinteger

The requested or default index of the first element to return.

Example response

{
  "items": [
    {
      "id": "a646a794-4265-4b2b-bf01-1aa4afe127de",
      "_link": "https://api.acculynx.com/api/v2/supplements/b195ca49-aeff-4e19-8ddd-193e01f5e649/items/a646a794-4265-4b2b-bf01-1aa4afe127de",
      "name": "supplement item",
      "originalClaimAmount": 650.6,
      "requestedAmount": 1100.05,
      "approvedAmount": 1100.4,
      "appliedAmount": 900.48
    }
  ]
}

Changes

  • 443924b00f43Revision changes
    • breaking

      for the query request parameter pageSize, default value 25 was removed

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      added the optional property to the response with the status