POST api/BiometricUsageData/Usage

Request Information

Body Parameters

Name	Type	Additional information
CustomerKey	string	None.
ItemsPerPage	integer	None.
PageNumber	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "CustomerKey": "sample string 1",
  "ItemsPerPage": 2,
  "PageNumber": 3
}

application/xml, text/xml

Sample:

<UsageDataParam xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BioPluginCloudAPI.Models">
  <CustomerKey>sample string 1</CustomerKey>
  <ItemsPerPage>2</ItemsPerPage>
  <PageNumber>3</PageNumber>
</UsageDataParam>

Response Information

BioPluginCustomerDataUsage

Name	Description	Type	Additional information
TotalRecords		integer	None.
UsageData		Collection of BioPluginCustomerUsage	None.

Response Formats

application/json, text/json

Sample:

{
  "TotalRecords": 1,
  "UsageData": [
    {
      "NumOfEnrolled": 1,
      "NumOfHourlyCalls": 2,
      "HourlyCallStart": "2024-11-22T16:00:23.2675791-08:00",
      "NumOfDailyCalls": 4,
      "DailyCallStart": "2024-11-22T16:00:23.2675791-08:00",
      "NumOfMonthlyCalls": 6,
      "MonthlyCallStart": "2024-11-22T16:00:23.2685991-08:00",
      "NumOfExtraCalls": 8
    },
    {
      "NumOfEnrolled": 1,
      "NumOfHourlyCalls": 2,
      "HourlyCallStart": "2024-11-22T16:00:23.2675791-08:00",
      "NumOfDailyCalls": 4,
      "DailyCallStart": "2024-11-22T16:00:23.2675791-08:00",
      "NumOfMonthlyCalls": 6,
      "MonthlyCallStart": "2024-11-22T16:00:23.2685991-08:00",
      "NumOfExtraCalls": 8
    }
  ]
}

application/xml, text/xml

Sample:

<BioPluginCustomerDataUsage xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BioPluginCloudAPI.Models">
  <TotalRecords>1</TotalRecords>
  <UsageData>
    <BioPluginCustomerUsage>
      <DailyCallStart>2024-11-22T16:00:23.2675791-08:00</DailyCallStart>
      <HourlyCallStart>2024-11-22T16:00:23.2675791-08:00</HourlyCallStart>
      <MonthlyCallStart>2024-11-22T16:00:23.2685991-08:00</MonthlyCallStart>
      <NumOfDailyCalls>4</NumOfDailyCalls>
      <NumOfEnrolled>1</NumOfEnrolled>
      <NumOfExtraCalls>8</NumOfExtraCalls>
      <NumOfHourlyCalls>2</NumOfHourlyCalls>
      <NumOfMonthlyCalls>6</NumOfMonthlyCalls>
    </BioPluginCustomerUsage>
    <BioPluginCustomerUsage>
      <DailyCallStart>2024-11-22T16:00:23.2675791-08:00</DailyCallStart>
      <HourlyCallStart>2024-11-22T16:00:23.2675791-08:00</HourlyCallStart>
      <MonthlyCallStart>2024-11-22T16:00:23.2685991-08:00</MonthlyCallStart>
      <NumOfDailyCalls>4</NumOfDailyCalls>
      <NumOfEnrolled>1</NumOfEnrolled>
      <NumOfExtraCalls>8</NumOfExtraCalls>
      <NumOfHourlyCalls>2</NumOfHourlyCalls>
      <NumOfMonthlyCalls>6</NumOfMonthlyCalls>
    </BioPluginCustomerUsage>
  </UsageData>
</BioPluginCustomerDataUsage>