Documentation for GET api/Commissions/RankProgressRequirements?repDID={repDID}&localeID={localeID}&periodCalendar={periodCalendar}&period={period}

GET api/Commissions/RankProgressRequirements?repDID={repDID}&localeID={localeID}&periodCalendar={periodCalendar}&period={period}

Returns the progress percentage per rank for the current period and their requirements.

Request Information

URI Parameters

Name	Description	Type	Additional information
repDID	The rep display identifier.	string	Required
localeID	The locale identifier.	integer	Default value is 1
periodCalendar	Values for this could be "Monthly" Or "Weekly"	string	Default value is Monthly
period	Values for this could be "Current" Or "Previous"	string	Default value is Current

Body Parameters

None.

Response Information

Resource Description

Collection of RankProgressRequirementsViewModel

Name	Type	Additional information
Rank	string	None.
RankTypeId	integer	None.
ProgressPercentage	integer	None.
Requirements	Collection of RankRequirement	None.

Response Formats

application/xml, text/xml

Sample:

<ListOfRankProgressRequirementsViewModel>
  <RankProgressRequirementsViewModel>
    <Rank>sample string 1</Rank>
    <RankTypeId>2</RankTypeId>
    <ProgressPercentage>3</ProgressPercentage>
    <Requirements>
      <RankRequirement>
        <AgentDescription>sample string 1</AgentDescription>
        <Value>2</Value>
        <Required>3</Required>
        <IsAchieved>True</IsAchieved>
      </RankRequirement>
      <RankRequirement>
        <AgentDescription>sample string 1</AgentDescription>
        <Value>2</Value>
        <Required>3</Required>
        <IsAchieved>True</IsAchieved>
      </RankRequirement>
    </Requirements>
  </RankProgressRequirementsViewModel>
  <RankProgressRequirementsViewModel>
    <Rank>sample string 1</Rank>
    <RankTypeId>2</RankTypeId>
    <ProgressPercentage>3</ProgressPercentage>
    <Requirements>
      <RankRequirement>
        <AgentDescription>sample string 1</AgentDescription>
        <Value>2</Value>
        <Required>3</Required>
        <IsAchieved>True</IsAchieved>
      </RankRequirement>
      <RankRequirement>
        <AgentDescription>sample string 1</AgentDescription>
        <Value>2</Value>
        <Required>3</Required>
        <IsAchieved>True</IsAchieved>
      </RankRequirement>
    </Requirements>
  </RankProgressRequirementsViewModel>
</ListOfRankProgressRequirementsViewModel>

application/json, text/json

Sample:

[
  {
    "Rank": "sample string 1",
    "RankTypeId": 2,
    "ProgressPercentage": 3,
    "Requirements": [
      {
        "AgentDescription": "sample string 1",
        "Value": 2.0,
        "Required": 3.0,
        "IsAchieved": true
      },
      {
        "AgentDescription": "sample string 1",
        "Value": 2.0,
        "Required": 3.0,
        "IsAchieved": true
      }
    ]
  },
  {
    "Rank": "sample string 1",
    "RankTypeId": 2,
    "ProgressPercentage": 3,
    "Requirements": [
      {
        "AgentDescription": "sample string 1",
        "Value": 2.0,
        "Required": 3.0,
        "IsAchieved": true
      },
      {
        "AgentDescription": "sample string 1",
        "Value": 2.0,
        "Required": 3.0,
        "IsAchieved": true
      }
    ]
  }
]