GET api/v1/businessgroup/credits

List business group credit

Request Information

URI Parameters

NameDescriptionTypeAdditional information
Filter

Filter records

ListBusinessGroupCreditV1Filter

None.

Select

Select columns

Collection of ListBusinessGroupCreditV1Select

Default value: All

Example value: TotalRegistrationCount, TotalCreditsOfNonEmptyBundles

Unique items

Sort

Sort records Sort by the first column, then by the second column, and so on

Collection of ListBusinessGroupCreditV1Sort

Default value: CreateDate

Example value: CreateDate

Max items: 3

Unique items

PageNumber

Page number

integer (32 bits)

Default value: 1

Example value: 1

Range: inclusive between 1 and 2147483647

PageSize

Number of records per page

integer (32 bits)

Default value: 10

Example value: 10

Range: inclusive between 0 and 100

Body Parameters

None.

Response Information

Resource Description

Retrieve a list of business group credits

ListBusinessGroupCreditV1Response
NameDescriptionTypeAdditional information
BusinessGroupCredits

List of business group credits

Collection of ListBusinessGroupCreditV1ResponseBusinessGroupCredit

None.

Total

Total number of records matching the request

integer (32 bits)

Required

Example value: 42

Range: inclusive between 0 and 2147483647

Response Formats

application/json

Sample:
{
  "BusinessGroupCredits": [
    {
      "BusinessGroupId": "fe574b61-56e8-45a8-b504-78916e8297d4",
      "TotalRegistrationCount": 2900,
      "TotalAvailableCredits": 100,
      "TotalCreditsOfNonEmptyBundles": 300,
      "TotalCredits": 3000,
      "TotalPendingCredits": 100,
      "CreateDate": "2018-12-31T21:59:59.999+00:00",
      "LastUpdateDate": "2018-12-31T21:59:59.999+00:00"
    },
    {
      "BusinessGroupId": "fe574b61-56e8-45a8-b504-78916e8297d4",
      "TotalRegistrationCount": 2900,
      "TotalAvailableCredits": 100,
      "TotalCreditsOfNonEmptyBundles": 300,
      "TotalCredits": 3000,
      "TotalPendingCredits": 100,
      "CreateDate": "2018-12-31T21:59:59.999+00:00",
      "LastUpdateDate": "2018-12-31T21:59:59.999+00:00"
    }
  ],
  "Total": 42
}