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

GET api/commissions/volumeReport/{repDID}/detailByLeg/{volumeTypeID}

This method will return a volume report for a representative and volume type. The returned data will be ordered by leg volume.

Request Information

URI Parameters

Name	Description	Type	Additional information
repDID	Representative identifier	string	Required
volumeTypeID	The primary identifier of the volume type	integer	Required

Body Parameters

None.

Response Information

Resource Description

Collection of VolumeReportDetailByLegViewModel

Name	Description	Type	Additional information
BCKey	The primary identifier of business center of the leg.	integer	None.
RepDID	Representative's identifier of the leg.	string	None.
Name	Representative's name of the leg. This is formatted as "CompanyName", if present, or "LastName, FirstName".	string	None.
LegVolume	Total volume of the leg.	decimal number	None.

Response Formats

application/xml, text/xml

Sample:

<ListOfVolumeReportDetailByLegViewModel>
  <VolumeReportDetailByLegViewModel>
    <BCKey>1</BCKey>
    <RepDID>sample string 2</RepDID>
    <Name>sample string 3</Name>
    <LegVolume>4</LegVolume>
  </VolumeReportDetailByLegViewModel>
  <VolumeReportDetailByLegViewModel>
    <BCKey>1</BCKey>
    <RepDID>sample string 2</RepDID>
    <Name>sample string 3</Name>
    <LegVolume>4</LegVolume>
  </VolumeReportDetailByLegViewModel>
</ListOfVolumeReportDetailByLegViewModel>

application/json, text/json

Sample:

[
  {
    "BCKey": 1,
    "RepDID": "sample string 2",
    "Name": "sample string 3",
    "LegVolume": 4.0
  },
  {
    "BCKey": 1,
    "RepDID": "sample string 2",
    "Name": "sample string 3",
    "LegVolume": 4.0
  }
]