Documentation for GET api/commissions/volumeReport/{repDID}

GET api/commissions/volumeReport/{repDID}

This method can be used to return a volume report for a RepDID. This returns the table used to display the Rep Volume report as shown in the Freedom Extranet.

Request Information

URI Parameters

Name	Description	Type	Additional information
repDID	Representative identifier	string	Required

Body Parameters

None.

Response Information

Resource Description

Collection of VolumeReportViewModel

Name	Description	Type	Additional information
VolumeTypeID	The primary identifier of the volume type	integer	None.
GenealogyTypeID	The primary identifier of the genealogy type	integer	None.
GenealogyTypeDescription	Description of the genealogy type	string	None.
PlanType	Description of the genealogy plan type.	string	None.
Description	Description of the volume type.	string	None.
OrderStartDate	Start date of the volume type range.	date	None.
OrderEndDate	End date of the volume type range.	date	None.
Volumes	Any volume value belonging to a Volume Column enabled for Extranet.	Dictionary of string [key] and decimal number [value]	None.

Response Formats

application/xml, text/xml

Sample:

<ListOfVolumeReportViewModel>
  <VolumeReportViewModel>
    <VolumeTypeID>1</VolumeTypeID>
    <GenealogyTypeID>2</GenealogyTypeID>
    <GenealogyTypeDescription>sample string 3</GenealogyTypeDescription>
    <PlanType>sample string 4</PlanType>
    <Description>sample string 5</Description>
    <OrderStartDate>01/09/2025 02:05:52</OrderStartDate>
    <OrderEndDate>01/09/2025 02:05:52</OrderEndDate>
    <Volumes>
      <KeyValuePairOfStringDecimal>
        <Key>sample string 1</Key>
        <Value>2</Value>
      </KeyValuePairOfStringDecimal>
      <KeyValuePairOfStringDecimal>
        <Key>sample string 3</Key>
        <Value>4</Value>
      </KeyValuePairOfStringDecimal>
    </Volumes>
  </VolumeReportViewModel>
  <VolumeReportViewModel>
    <VolumeTypeID>1</VolumeTypeID>
    <GenealogyTypeID>2</GenealogyTypeID>
    <GenealogyTypeDescription>sample string 3</GenealogyTypeDescription>
    <PlanType>sample string 4</PlanType>
    <Description>sample string 5</Description>
    <OrderStartDate>01/09/2025 02:05:52</OrderStartDate>
    <OrderEndDate>01/09/2025 02:05:52</OrderEndDate>
    <Volumes>
      <KeyValuePairOfStringDecimal>
        <Key>sample string 1</Key>
        <Value>2</Value>
      </KeyValuePairOfStringDecimal>
      <KeyValuePairOfStringDecimal>
        <Key>sample string 3</Key>
        <Value>4</Value>
      </KeyValuePairOfStringDecimal>
    </Volumes>
  </VolumeReportViewModel>
</ListOfVolumeReportViewModel>

application/json, text/json

Sample:

[
  {
    "VolumeTypeID": 1,
    "GenealogyTypeID": 2,
    "GenealogyTypeDescription": "sample string 3",
    "PlanType": "sample string 4",
    "Description": "sample string 5",
    "OrderStartDate": "2025-01-09T02:05:52.7108326-05:00",
    "OrderEndDate": "2025-01-09T02:05:52.7108326-05:00",
    "Volumes": {
      "sample string 1": 2.0,
      "sample string 3": 4.0
    }
  },
  {
    "VolumeTypeID": 1,
    "GenealogyTypeID": 2,
    "GenealogyTypeDescription": "sample string 3",
    "PlanType": "sample string 4",
    "Description": "sample string 5",
    "OrderStartDate": "2025-01-09T02:05:52.7108326-05:00",
    "OrderEndDate": "2025-01-09T02:05:52.7108326-05:00",
    "Volumes": {
      "sample string 1": 2.0,
      "sample string 3": 4.0
    }
  }
]