GET v1/detailBoxes/{moduleID}/{recordID}

Retrieve data for detail page boxes

Request Information

URI Parameters

NameDescriptionTypeAdditional information
moduleID

integer

Required

recordID

integer

Required

Body Parameters

None.

Response Information

Resource Description

Collection of SummaryBoxModel
NameDescriptionTypeAdditional information
Title

Title of box

string

None.

Tooltip

Tooltip for box

string

None.

DisplayType

Indicate how data should be displayed: Text or PieChart

string

None.

Data

List of data components

Collection of SummaryBoxDataModel

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "title": "sample string 1",
    "tooltip": "sample string 2",
    "displayType": "sample string 3",
    "data": [
      {
        "category": "sample string 1",
        "total": 2
      },
      {
        "category": "sample string 1",
        "total": 2
      }
    ]
  },
  {
    "title": "sample string 1",
    "tooltip": "sample string 2",
    "displayType": "sample string 3",
    "data": [
      {
        "category": "sample string 1",
        "total": 2
      },
      {
        "category": "sample string 1",
        "total": 2
      }
    ]
  }
]