POST api/service/GetServiceMetricsForBranchesInRegion

Request Information

URI Parameters

None.

Body Parameters

RegionMetricsParameters
NameDescriptionTypeAdditional information
regionCode

string

None.

yearMonth

string

None.

user

string

None.

deviceID

string

None.

ticketID

string

None.

Request Formats

application/json, text/json

Sample:
{
  "regionCode": "sample string 1",
  "yearMonth": "sample string 2",
  "user": "sample string 3",
  "deviceID": "sample string 4",
  "ticketID": "sample string 5"
}

application/xml, text/xml

Sample:
<RegionMetricsParameters xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TMXWebAPI.Models">
  <deviceID>sample string 4</deviceID>
  <regionCode>sample string 1</regionCode>
  <ticketID>sample string 5</ticketID>
  <user>sample string 3</user>
  <yearMonth>sample string 2</yearMonth>
</RegionMetricsParameters>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of RegionalServiceDetailModel
NameDescriptionTypeAdditional information
CompanyCode

string

None.

DivisionCode

string

None.

DivisionName

string

None.

RegionCode

string

None.

RegionName

string

None.

BranchCode

string

None.

BranchName

string

None.

RCPC

string

None.

RCPCTargetValue

string

None.

RCPCScoreColor

string

None.

RCPCPlanValue

string

None.

RCPCActualValue

string

None.

RCPCProjectedValue

string

None.

StartRatePC

string

None.

StartRatePCTargetValue

string

None.

StartRatePCScoreColor

string

None.

StartRatePCPlanValue

string

None.

StartRatePCActualValue

string

None.

StartRatePCProjectedValue

string

None.

StartRateTC

string

None.

StartRateTCTargetValue

string

None.

StartRateTCScoreColor

string

None.

StartRateTCPlanValue

string

None.

StartRateTCActualValue

string

None.

StartRateTCProjectedValue

string

None.

StartRateCommPC

string

None.

StartRateCommPCTargetValue

string

None.

StartRateCommPCScoreColor

string

None.

StartRateCommPCPlanValue

string

None.

StartRateCommPCActualValue

string

None.

StartRateCommPCProjectedValue

string

None.

BKLOG

string

None.

BKLOGTargetValue

string

None.

BKLOGScoreColor

string

None.

BKLOGPlanValue

string

None.

BKLOGActualValue

string

None.

BKLOGProjectedValue

string

None.

BKLOGFumes

string

None.

BKLOGFumesTargetValue

string

None.

BKLOGFumesScoreColor

string

None.

BKLOGFumesPlanValue

string

None.

BKLOGFumesActualValue

string

None.

BKLOGFumesProjectedValue

string

None.

ReturnMessage

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "CompanyCode": "sample string 1",
    "DivisionCode": "sample string 2",
    "DivisionName": "sample string 3",
    "RegionCode": "sample string 4",
    "RegionName": "sample string 5",
    "BranchCode": "sample string 6",
    "BranchName": "sample string 7",
    "RCPC": "sample string 8",
    "RCPCTargetValue": "sample string 9",
    "RCPCScoreColor": "sample string 10",
    "RCPCPlanValue": "sample string 11",
    "RCPCActualValue": "sample string 12",
    "RCPCProjectedValue": "sample string 13",
    "StartRatePC": "sample string 14",
    "StartRatePCTargetValue": "sample string 15",
    "StartRatePCScoreColor": "sample string 16",
    "StartRatePCPlanValue": "sample string 17",
    "StartRatePCActualValue": "sample string 18",
    "StartRatePCProjectedValue": "sample string 19",
    "StartRateTC": "sample string 20",
    "StartRateTCTargetValue": "sample string 21",
    "StartRateTCScoreColor": "sample string 22",
    "StartRateTCPlanValue": "sample string 23",
    "StartRateTCActualValue": "sample string 24",
    "StartRateTCProjectedValue": "sample string 25",
    "StartRateCommPC": "sample string 26",
    "StartRateCommPCTargetValue": "sample string 27",
    "StartRateCommPCScoreColor": "sample string 28",
    "StartRateCommPCPlanValue": "sample string 29",
    "StartRateCommPCActualValue": "sample string 30",
    "StartRateCommPCProjectedValue": "sample string 31",
    "BKLOG": "sample string 32",
    "BKLOGTargetValue": "sample string 33",
    "BKLOGScoreColor": "sample string 34",
    "BKLOGPlanValue": "sample string 35",
    "BKLOGActualValue": "sample string 36",
    "BKLOGProjectedValue": "sample string 37",
    "BKLOGFumes": "sample string 38",
    "BKLOGFumesTargetValue": "sample string 39",
    "BKLOGFumesScoreColor": "sample string 40",
    "BKLOGFumesPlanValue": "sample string 41",
    "BKLOGFumesActualValue": "sample string 42",
    "BKLOGFumesProjectedValue": "sample string 43",
    "ReturnMessage": "sample string 44"
  },
  {
    "CompanyCode": "sample string 1",
    "DivisionCode": "sample string 2",
    "DivisionName": "sample string 3",
    "RegionCode": "sample string 4",
    "RegionName": "sample string 5",
    "BranchCode": "sample string 6",
    "BranchName": "sample string 7",
    "RCPC": "sample string 8",
    "RCPCTargetValue": "sample string 9",
    "RCPCScoreColor": "sample string 10",
    "RCPCPlanValue": "sample string 11",
    "RCPCActualValue": "sample string 12",
    "RCPCProjectedValue": "sample string 13",
    "StartRatePC": "sample string 14",
    "StartRatePCTargetValue": "sample string 15",
    "StartRatePCScoreColor": "sample string 16",
    "StartRatePCPlanValue": "sample string 17",
    "StartRatePCActualValue": "sample string 18",
    "StartRatePCProjectedValue": "sample string 19",
    "StartRateTC": "sample string 20",
    "StartRateTCTargetValue": "sample string 21",
    "StartRateTCScoreColor": "sample string 22",
    "StartRateTCPlanValue": "sample string 23",
    "StartRateTCActualValue": "sample string 24",
    "StartRateTCProjectedValue": "sample string 25",
    "StartRateCommPC": "sample string 26",
    "StartRateCommPCTargetValue": "sample string 27",
    "StartRateCommPCScoreColor": "sample string 28",
    "StartRateCommPCPlanValue": "sample string 29",
    "StartRateCommPCActualValue": "sample string 30",
    "StartRateCommPCProjectedValue": "sample string 31",
    "BKLOG": "sample string 32",
    "BKLOGTargetValue": "sample string 33",
    "BKLOGScoreColor": "sample string 34",
    "BKLOGPlanValue": "sample string 35",
    "BKLOGActualValue": "sample string 36",
    "BKLOGProjectedValue": "sample string 37",
    "BKLOGFumes": "sample string 38",
    "BKLOGFumesTargetValue": "sample string 39",
    "BKLOGFumesScoreColor": "sample string 40",
    "BKLOGFumesPlanValue": "sample string 41",
    "BKLOGFumesActualValue": "sample string 42",
    "BKLOGFumesProjectedValue": "sample string 43",
    "ReturnMessage": "sample string 44"
  }
]

application/xml, text/xml

Sample:
<ArrayOfRegionalServiceDetailModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TMXWebAPI.Models">
  <RegionalServiceDetailModel>
    <BKLOG>sample string 32</BKLOG>
    <BKLOGActualValue>sample string 36</BKLOGActualValue>
    <BKLOGFumes>sample string 38</BKLOGFumes>
    <BKLOGFumesActualValue>sample string 42</BKLOGFumesActualValue>
    <BKLOGFumesPlanValue>sample string 41</BKLOGFumesPlanValue>
    <BKLOGFumesProjectedValue>sample string 43</BKLOGFumesProjectedValue>
    <BKLOGFumesScoreColor>sample string 40</BKLOGFumesScoreColor>
    <BKLOGFumesTargetValue>sample string 39</BKLOGFumesTargetValue>
    <BKLOGPlanValue>sample string 35</BKLOGPlanValue>
    <BKLOGProjectedValue>sample string 37</BKLOGProjectedValue>
    <BKLOGScoreColor>sample string 34</BKLOGScoreColor>
    <BKLOGTargetValue>sample string 33</BKLOGTargetValue>
    <BranchCode>sample string 6</BranchCode>
    <BranchName>sample string 7</BranchName>
    <CompanyCode>sample string 1</CompanyCode>
    <DivisionCode>sample string 2</DivisionCode>
    <DivisionName>sample string 3</DivisionName>
    <RCPC>sample string 8</RCPC>
    <RCPCActualValue>sample string 12</RCPCActualValue>
    <RCPCPlanValue>sample string 11</RCPCPlanValue>
    <RCPCProjectedValue>sample string 13</RCPCProjectedValue>
    <RCPCScoreColor>sample string 10</RCPCScoreColor>
    <RCPCTargetValue>sample string 9</RCPCTargetValue>
    <RegionCode>sample string 4</RegionCode>
    <RegionName>sample string 5</RegionName>
    <ReturnMessage>sample string 44</ReturnMessage>
    <StartRateCommPC>sample string 26</StartRateCommPC>
    <StartRateCommPCActualValue>sample string 30</StartRateCommPCActualValue>
    <StartRateCommPCPlanValue>sample string 29</StartRateCommPCPlanValue>
    <StartRateCommPCProjectedValue>sample string 31</StartRateCommPCProjectedValue>
    <StartRateCommPCScoreColor>sample string 28</StartRateCommPCScoreColor>
    <StartRateCommPCTargetValue>sample string 27</StartRateCommPCTargetValue>
    <StartRatePC>sample string 14</StartRatePC>
    <StartRatePCActualValue>sample string 18</StartRatePCActualValue>
    <StartRatePCPlanValue>sample string 17</StartRatePCPlanValue>
    <StartRatePCProjectedValue>sample string 19</StartRatePCProjectedValue>
    <StartRatePCScoreColor>sample string 16</StartRatePCScoreColor>
    <StartRatePCTargetValue>sample string 15</StartRatePCTargetValue>
    <StartRateTC>sample string 20</StartRateTC>
    <StartRateTCActualValue>sample string 24</StartRateTCActualValue>
    <StartRateTCPlanValue>sample string 23</StartRateTCPlanValue>
    <StartRateTCProjectedValue>sample string 25</StartRateTCProjectedValue>
    <StartRateTCScoreColor>sample string 22</StartRateTCScoreColor>
    <StartRateTCTargetValue>sample string 21</StartRateTCTargetValue>
  </RegionalServiceDetailModel>
  <RegionalServiceDetailModel>
    <BKLOG>sample string 32</BKLOG>
    <BKLOGActualValue>sample string 36</BKLOGActualValue>
    <BKLOGFumes>sample string 38</BKLOGFumes>
    <BKLOGFumesActualValue>sample string 42</BKLOGFumesActualValue>
    <BKLOGFumesPlanValue>sample string 41</BKLOGFumesPlanValue>
    <BKLOGFumesProjectedValue>sample string 43</BKLOGFumesProjectedValue>
    <BKLOGFumesScoreColor>sample string 40</BKLOGFumesScoreColor>
    <BKLOGFumesTargetValue>sample string 39</BKLOGFumesTargetValue>
    <BKLOGPlanValue>sample string 35</BKLOGPlanValue>
    <BKLOGProjectedValue>sample string 37</BKLOGProjectedValue>
    <BKLOGScoreColor>sample string 34</BKLOGScoreColor>
    <BKLOGTargetValue>sample string 33</BKLOGTargetValue>
    <BranchCode>sample string 6</BranchCode>
    <BranchName>sample string 7</BranchName>
    <CompanyCode>sample string 1</CompanyCode>
    <DivisionCode>sample string 2</DivisionCode>
    <DivisionName>sample string 3</DivisionName>
    <RCPC>sample string 8</RCPC>
    <RCPCActualValue>sample string 12</RCPCActualValue>
    <RCPCPlanValue>sample string 11</RCPCPlanValue>
    <RCPCProjectedValue>sample string 13</RCPCProjectedValue>
    <RCPCScoreColor>sample string 10</RCPCScoreColor>
    <RCPCTargetValue>sample string 9</RCPCTargetValue>
    <RegionCode>sample string 4</RegionCode>
    <RegionName>sample string 5</RegionName>
    <ReturnMessage>sample string 44</ReturnMessage>
    <StartRateCommPC>sample string 26</StartRateCommPC>
    <StartRateCommPCActualValue>sample string 30</StartRateCommPCActualValue>
    <StartRateCommPCPlanValue>sample string 29</StartRateCommPCPlanValue>
    <StartRateCommPCProjectedValue>sample string 31</StartRateCommPCProjectedValue>
    <StartRateCommPCScoreColor>sample string 28</StartRateCommPCScoreColor>
    <StartRateCommPCTargetValue>sample string 27</StartRateCommPCTargetValue>
    <StartRatePC>sample string 14</StartRatePC>
    <StartRatePCActualValue>sample string 18</StartRatePCActualValue>
    <StartRatePCPlanValue>sample string 17</StartRatePCPlanValue>
    <StartRatePCProjectedValue>sample string 19</StartRatePCProjectedValue>
    <StartRatePCScoreColor>sample string 16</StartRatePCScoreColor>
    <StartRatePCTargetValue>sample string 15</StartRatePCTargetValue>
    <StartRateTC>sample string 20</StartRateTC>
    <StartRateTCActualValue>sample string 24</StartRateTCActualValue>
    <StartRateTCPlanValue>sample string 23</StartRateTCPlanValue>
    <StartRateTCProjectedValue>sample string 25</StartRateTCProjectedValue>
    <StartRateTCScoreColor>sample string 22</StartRateTCScoreColor>
    <StartRateTCTargetValue>sample string 21</StartRateTCTargetValue>
  </RegionalServiceDetailModel>
</ArrayOfRegionalServiceDetailModel>