GET api/statistics/BOFProgressReportByAdmin?accessToken={accessToken}&BMEmployeeId={BMEmployeeId}&BusinessPartnerId={BusinessPartnerId}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
accessToken

string

Required

BMEmployeeId

integer

Required

BusinessPartnerId

integer

Required

Body Parameters

None.

Response Information

Resource Description

POBProgressionByBM
NameDescriptionTypeAdditional information
EmployeeCode

string

None.

EmployeeName

string

None.

HQName

string

None.

HQCode

string

None.

objPOBProgressPartnersList

Collection of POBProgress_Partners

None.

Response Formats

application/json, text/json

Sample:
{
  "EmployeeCode": "sample string 1",
  "EmployeeName": "sample string 2",
  "HQName": "sample string 3",
  "HQCode": "sample string 4",
  "objPOBProgressPartnersList": [
    {
      "BusinessPartnerSchemeId": 1,
      "RetailerCode": "sample string 2",
      "BusinessName": "sample string 3",
      "City": "sample string 4",
      "Area": "sample string 5",
      "SchemeName": "sample string 6",
      "SchemeCode": "sample string 7",
      "DivisionName": "sample string 8",
      "CreatedDateTime": "2026-03-29T12:00:31.3360312+05:30",
      "NoOfMonths": 9,
      "AvgPOBSlab": 10.0,
      "CurrentMonthPOB": 11.0,
      "FirstMonthPOB": 12.0,
      "AveragePOB": 13.0,
      "BOFTargetDone": true,
      "BusinessPartnerId": 15,
      "SchemeId": 16,
      "EligibilityCriteriaPrice": 17.0,
      "TotalPOBDone": 18.0,
      "TotalPOBClaimed": 19.0,
      "BalancePOB": 20.0,
      "BalanceMonths": 21,
      "Phone": "sample string 22",
      "NOCApproved": true,
      "UpgradeAllowed": true,
      "ActivateUploadNOCButton": true,
      "DeRegisterBOF": true,
      "VisitDays": "sample string 27",
      "ValidBOF": 28,
      "ApprovalStatus": "sample string 29",
      "BOFSchemeList": [
        {
          "SchemeId": 1,
          "SchemeName": "sample string 2",
          "SchemeDescription": "sample string 3",
          "EligibilityCriteriaPrice": 4
        },
        {
          "SchemeId": 1,
          "SchemeName": "sample string 2",
          "SchemeDescription": "sample string 3",
          "EligibilityCriteriaPrice": 4
        }
      ]
    },
    {
      "BusinessPartnerSchemeId": 1,
      "RetailerCode": "sample string 2",
      "BusinessName": "sample string 3",
      "City": "sample string 4",
      "Area": "sample string 5",
      "SchemeName": "sample string 6",
      "SchemeCode": "sample string 7",
      "DivisionName": "sample string 8",
      "CreatedDateTime": "2026-03-29T12:00:31.3360312+05:30",
      "NoOfMonths": 9,
      "AvgPOBSlab": 10.0,
      "CurrentMonthPOB": 11.0,
      "FirstMonthPOB": 12.0,
      "AveragePOB": 13.0,
      "BOFTargetDone": true,
      "BusinessPartnerId": 15,
      "SchemeId": 16,
      "EligibilityCriteriaPrice": 17.0,
      "TotalPOBDone": 18.0,
      "TotalPOBClaimed": 19.0,
      "BalancePOB": 20.0,
      "BalanceMonths": 21,
      "Phone": "sample string 22",
      "NOCApproved": true,
      "UpgradeAllowed": true,
      "ActivateUploadNOCButton": true,
      "DeRegisterBOF": true,
      "VisitDays": "sample string 27",
      "ValidBOF": 28,
      "ApprovalStatus": "sample string 29",
      "BOFSchemeList": [
        {
          "SchemeId": 1,
          "SchemeName": "sample string 2",
          "SchemeDescription": "sample string 3",
          "EligibilityCriteriaPrice": 4
        },
        {
          "SchemeId": 1,
          "SchemeName": "sample string 2",
          "SchemeDescription": "sample string 3",
          "EligibilityCriteriaPrice": 4
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample:
<POBProgressionByBM xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/application.knh.webapi.BE">
  <EmployeeCode>sample string 1</EmployeeCode>
  <EmployeeName>sample string 2</EmployeeName>
  <HQCode>sample string 4</HQCode>
  <HQName>sample string 3</HQName>
  <objPOBProgressPartnersList>
    <POBProgress_Partners>
      <ActivateUploadNOCButton>true</ActivateUploadNOCButton>
      <ApprovalStatus>sample string 29</ApprovalStatus>
      <Area>sample string 5</Area>
      <AveragePOB>13</AveragePOB>
      <AvgPOBSlab>10</AvgPOBSlab>
      <BOFSchemeList>
        <BOFScheme>
          <EligibilityCriteriaPrice>4</EligibilityCriteriaPrice>
          <SchemeDescription>sample string 3</SchemeDescription>
          <SchemeId>1</SchemeId>
          <SchemeName>sample string 2</SchemeName>
        </BOFScheme>
        <BOFScheme>
          <EligibilityCriteriaPrice>4</EligibilityCriteriaPrice>
          <SchemeDescription>sample string 3</SchemeDescription>
          <SchemeId>1</SchemeId>
          <SchemeName>sample string 2</SchemeName>
        </BOFScheme>
      </BOFSchemeList>
      <BOFTargetDone>true</BOFTargetDone>
      <BalanceMonths>21</BalanceMonths>
      <BalancePOB>20</BalancePOB>
      <BusinessName>sample string 3</BusinessName>
      <BusinessPartnerId>15</BusinessPartnerId>
      <BusinessPartnerSchemeId>1</BusinessPartnerSchemeId>
      <City>sample string 4</City>
      <CreatedDateTime>2026-03-29T12:00:31.3360312+05:30</CreatedDateTime>
      <CurrentMonthPOB>11</CurrentMonthPOB>
      <DeRegisterBOF>true</DeRegisterBOF>
      <DivisionName>sample string 8</DivisionName>
      <EligibilityCriteriaPrice>17</EligibilityCriteriaPrice>
      <FirstMonthPOB>12</FirstMonthPOB>
      <NOCApproved>true</NOCApproved>
      <NoOfMonths>9</NoOfMonths>
      <Phone>sample string 22</Phone>
      <RetailerCode>sample string 2</RetailerCode>
      <SchemeCode>sample string 7</SchemeCode>
      <SchemeId>16</SchemeId>
      <SchemeName>sample string 6</SchemeName>
      <TotalPOBClaimed>19</TotalPOBClaimed>
      <TotalPOBDone>18</TotalPOBDone>
      <UpgradeAllowed>true</UpgradeAllowed>
      <ValidBOF>28</ValidBOF>
      <VisitDays>sample string 27</VisitDays>
    </POBProgress_Partners>
    <POBProgress_Partners>
      <ActivateUploadNOCButton>true</ActivateUploadNOCButton>
      <ApprovalStatus>sample string 29</ApprovalStatus>
      <Area>sample string 5</Area>
      <AveragePOB>13</AveragePOB>
      <AvgPOBSlab>10</AvgPOBSlab>
      <BOFSchemeList>
        <BOFScheme>
          <EligibilityCriteriaPrice>4</EligibilityCriteriaPrice>
          <SchemeDescription>sample string 3</SchemeDescription>
          <SchemeId>1</SchemeId>
          <SchemeName>sample string 2</SchemeName>
        </BOFScheme>
        <BOFScheme>
          <EligibilityCriteriaPrice>4</EligibilityCriteriaPrice>
          <SchemeDescription>sample string 3</SchemeDescription>
          <SchemeId>1</SchemeId>
          <SchemeName>sample string 2</SchemeName>
        </BOFScheme>
      </BOFSchemeList>
      <BOFTargetDone>true</BOFTargetDone>
      <BalanceMonths>21</BalanceMonths>
      <BalancePOB>20</BalancePOB>
      <BusinessName>sample string 3</BusinessName>
      <BusinessPartnerId>15</BusinessPartnerId>
      <BusinessPartnerSchemeId>1</BusinessPartnerSchemeId>
      <City>sample string 4</City>
      <CreatedDateTime>2026-03-29T12:00:31.3360312+05:30</CreatedDateTime>
      <CurrentMonthPOB>11</CurrentMonthPOB>
      <DeRegisterBOF>true</DeRegisterBOF>
      <DivisionName>sample string 8</DivisionName>
      <EligibilityCriteriaPrice>17</EligibilityCriteriaPrice>
      <FirstMonthPOB>12</FirstMonthPOB>
      <NOCApproved>true</NOCApproved>
      <NoOfMonths>9</NoOfMonths>
      <Phone>sample string 22</Phone>
      <RetailerCode>sample string 2</RetailerCode>
      <SchemeCode>sample string 7</SchemeCode>
      <SchemeId>16</SchemeId>
      <SchemeName>sample string 6</SchemeName>
      <TotalPOBClaimed>19</TotalPOBClaimed>
      <TotalPOBDone>18</TotalPOBDone>
      <UpgradeAllowed>true</UpgradeAllowed>
      <ValidBOF>28</ValidBOF>
      <VisitDays>sample string 27</VisitDays>
    </POBProgress_Partners>
  </objPOBProgressPartnersList>
</POBProgressionByBM>