GET api/v1/widgets/pointsuserankingwidget?organizationCode={organizationCode}&refresh={refresh}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
organizationCode

string

Required

refresh

boolean

Default value is False

Body Parameters

None.

Response Information

Resource Description

SingleResultResponseOfWidgetWithDataDtoOfPointsAndUseData
NameDescriptionTypeAdditional information
Meta

MetaSingleResult

None.

Notifications

None.

Response Formats

application/json, text/json

Sample:
{
  "meta": {},
  "notifications": [
    {},
    {}
  ],
  "result": {
    "id": "a72ad192-e22c-466c-b9b9-f41162824f19",
    "code": "sample string 2",
    "data": {
      "totalPoints": 1.0,
      "totalPointsGenerated": 2.0,
      "totalMember": 3.0,
      "totalMemberGenerated": 4.0,
      "totalMemberUsed": 5.0
    }
  }
}

application/xml, text/xml

Sample:
<SingleResultResponseOfWidgetWithDataDtoOfPointsAndUseDatadOvjT49_PdOvjT49_P xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Presentation.WebApi.Dtos.Response">
  <Meta />
  <Notifications>
    <Notification />
    <Notification />
  </Notifications>
  <Result xmlns:d2p1="http://schemas.datacontract.org/2004/07/Application.Services.Dtos">
    <d2p1:Code>sample string 2</d2p1:Code>
    <d2p1:Data>
      <d2p1:TotalMember>3</d2p1:TotalMember>
      <d2p1:TotalMemberGenerated>4</d2p1:TotalMemberGenerated>
      <d2p1:TotalMemberUsed>5</d2p1:TotalMemberUsed>
      <d2p1:TotalPoints>1</d2p1:TotalPoints>
      <d2p1:TotalPointsGenerated>2</d2p1:TotalPointsGenerated>
    </d2p1:Data>
    <d2p1:Id>a72ad192-e22c-466c-b9b9-f41162824f19</d2p1:Id>
  </Result>
</SingleResultResponseOfWidgetWithDataDtoOfPointsAndUseDatadOvjT49_PdOvjT49_P>