POST api/service/GetBranchRollupStatus

Request Information

URI Parameters

None.

Body Parameters

BranchOSPSalesCheckinParameters
NameDescriptionTypeAdditional information
user

string

None.

BranchCode

string

None.

deviceID

string

None.

ticketID

string

None.

StartDate

string

None.

EndDate

string

None.

strCode

string

None.

code

string

None.

Request Formats

application/json, text/json

Sample:
{
  "user": "sample string 1",
  "BranchCode": "sample string 2",
  "deviceID": "sample string 3",
  "ticketID": "sample string 4",
  "StartDate": "sample string 5",
  "EndDate": "sample string 6",
  "strCode": "sample string 7",
  "code": "sample string 8"
}

application/xml, text/xml

Sample:
<BranchOSPSalesCheckinParameters xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TMXWebAPI.Models">
  <BranchCode>sample string 2</BranchCode>
  <EndDate>sample string 6</EndDate>
  <StartDate>sample string 5</StartDate>
  <code>sample string 8</code>
  <deviceID>sample string 3</deviceID>
  <strCode>sample string 7</strCode>
  <ticketID>sample string 4</ticketID>
  <user>sample string 1</user>
</BranchOSPSalesCheckinParameters>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of MetricViewModel
NameDescriptionTypeAdditional information
DivisionCode

string

None.

RegionCode

string

None.

BranchCode

string

None.

BuType

string

None.

yearMonth

string

None.

CurrentScore

integer

None.

CurrentScoreString

string

None.

MetricCategory

string

None.

MetricCategoryName

string

None.

Branchstatus

string

None.

Metrics

Collection of MetricModel

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "DivisionCode": "sample string 1",
    "RegionCode": "sample string 2",
    "BranchCode": "sample string 3",
    "BuType": "sample string 4",
    "yearMonth": "sample string 5",
    "CurrentScore": 6,
    "CurrentScoreString": "sample string 7",
    "MetricCategory": "sample string 8",
    "MetricCategoryName": "sample string 9",
    "Branchstatus": "sample string 10",
    "Metrics": [
      {
        "MetricCode": "sample string 1",
        "MetricName": "sample string 2",
        "MetricValue": 3,
        "CancelMetricValue": 4.0,
        "TargetValue": 5.0,
        "ScoreColor": "sample string 6",
        "PlanValue": "sample string 7",
        "ActualValue": "sample string 8",
        "ProjectedValue": "sample string 9",
        "ReturnMessage": "sample string 10"
      },
      {
        "MetricCode": "sample string 1",
        "MetricName": "sample string 2",
        "MetricValue": 3,
        "CancelMetricValue": 4.0,
        "TargetValue": 5.0,
        "ScoreColor": "sample string 6",
        "PlanValue": "sample string 7",
        "ActualValue": "sample string 8",
        "ProjectedValue": "sample string 9",
        "ReturnMessage": "sample string 10"
      }
    ]
  },
  {
    "DivisionCode": "sample string 1",
    "RegionCode": "sample string 2",
    "BranchCode": "sample string 3",
    "BuType": "sample string 4",
    "yearMonth": "sample string 5",
    "CurrentScore": 6,
    "CurrentScoreString": "sample string 7",
    "MetricCategory": "sample string 8",
    "MetricCategoryName": "sample string 9",
    "Branchstatus": "sample string 10",
    "Metrics": [
      {
        "MetricCode": "sample string 1",
        "MetricName": "sample string 2",
        "MetricValue": 3,
        "CancelMetricValue": 4.0,
        "TargetValue": 5.0,
        "ScoreColor": "sample string 6",
        "PlanValue": "sample string 7",
        "ActualValue": "sample string 8",
        "ProjectedValue": "sample string 9",
        "ReturnMessage": "sample string 10"
      },
      {
        "MetricCode": "sample string 1",
        "MetricName": "sample string 2",
        "MetricValue": 3,
        "CancelMetricValue": 4.0,
        "TargetValue": 5.0,
        "ScoreColor": "sample string 6",
        "PlanValue": "sample string 7",
        "ActualValue": "sample string 8",
        "ProjectedValue": "sample string 9",
        "ReturnMessage": "sample string 10"
      }
    ]
  }
]

application/xml, text/xml

Sample:
<ArrayOfMetricViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TMXWebAPI.Models">
  <MetricViewModel>
    <BranchCode>sample string 3</BranchCode>
    <Branchstatus>sample string 10</Branchstatus>
    <BuType>sample string 4</BuType>
    <CurrentScore>6</CurrentScore>
    <CurrentScoreString>sample string 7</CurrentScoreString>
    <DivisionCode>sample string 1</DivisionCode>
    <MetricCategory>sample string 8</MetricCategory>
    <MetricCategoryName>sample string 9</MetricCategoryName>
    <Metrics>
      <MetricModel>
        <ActualValue>sample string 8</ActualValue>
        <CancelMetricValue>4</CancelMetricValue>
        <MetricCode>sample string 1</MetricCode>
        <MetricName>sample string 2</MetricName>
        <MetricValue>3</MetricValue>
        <PlanValue>sample string 7</PlanValue>
        <ProjectedValue>sample string 9</ProjectedValue>
        <ReturnMessage>sample string 10</ReturnMessage>
        <ScoreColor>sample string 6</ScoreColor>
        <TargetValue>5</TargetValue>
      </MetricModel>
      <MetricModel>
        <ActualValue>sample string 8</ActualValue>
        <CancelMetricValue>4</CancelMetricValue>
        <MetricCode>sample string 1</MetricCode>
        <MetricName>sample string 2</MetricName>
        <MetricValue>3</MetricValue>
        <PlanValue>sample string 7</PlanValue>
        <ProjectedValue>sample string 9</ProjectedValue>
        <ReturnMessage>sample string 10</ReturnMessage>
        <ScoreColor>sample string 6</ScoreColor>
        <TargetValue>5</TargetValue>
      </MetricModel>
    </Metrics>
    <RegionCode>sample string 2</RegionCode>
    <yearMonth>sample string 5</yearMonth>
  </MetricViewModel>
  <MetricViewModel>
    <BranchCode>sample string 3</BranchCode>
    <Branchstatus>sample string 10</Branchstatus>
    <BuType>sample string 4</BuType>
    <CurrentScore>6</CurrentScore>
    <CurrentScoreString>sample string 7</CurrentScoreString>
    <DivisionCode>sample string 1</DivisionCode>
    <MetricCategory>sample string 8</MetricCategory>
    <MetricCategoryName>sample string 9</MetricCategoryName>
    <Metrics>
      <MetricModel>
        <ActualValue>sample string 8</ActualValue>
        <CancelMetricValue>4</CancelMetricValue>
        <MetricCode>sample string 1</MetricCode>
        <MetricName>sample string 2</MetricName>
        <MetricValue>3</MetricValue>
        <PlanValue>sample string 7</PlanValue>
        <ProjectedValue>sample string 9</ProjectedValue>
        <ReturnMessage>sample string 10</ReturnMessage>
        <ScoreColor>sample string 6</ScoreColor>
        <TargetValue>5</TargetValue>
      </MetricModel>
      <MetricModel>
        <ActualValue>sample string 8</ActualValue>
        <CancelMetricValue>4</CancelMetricValue>
        <MetricCode>sample string 1</MetricCode>
        <MetricName>sample string 2</MetricName>
        <MetricValue>3</MetricValue>
        <PlanValue>sample string 7</PlanValue>
        <ProjectedValue>sample string 9</ProjectedValue>
        <ReturnMessage>sample string 10</ReturnMessage>
        <ScoreColor>sample string 6</ScoreColor>
        <TargetValue>5</TargetValue>
      </MetricModel>
    </Metrics>
    <RegionCode>sample string 2</RegionCode>
    <yearMonth>sample string 5</yearMonth>
  </MetricViewModel>
</ArrayOfMetricViewModel>