POST api/compliance/GetComplianceMetricsForBranchesInRegion

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 RegionalComplianceGPSDetailModel
NameDescriptionTypeAdditional information
CompanyCode

string

None.

DivisionCode

string

None.

DivisionName

string

None.

RegionCode

string

None.

RegionName

string

None.

BranchCode

string

None.

BranchName

string

None.

SafetyGPS

string

None.

SafetyGPSTargetValue

string

None.

SafetyGPSScoreColor

string

None.

SafetyGPSPlanValue

string

None.

SafetyGPSActualValue

string

None.

SafetyGPSProjectedValue

string

None.

LowestScore

string

None.

LowestScoreTargetValue

string

None.

LowestScoreScoreColor

string

None.

LowestScorePlanValue

string

None.

LowestScoreActualValue

string

None.

LowestScoreProjectedValue

string

None.

ExceptionSummary

MobiException

None.

SafetyCompClaims

string

None.

SafetyCompClaimsTargetValue

string

None.

SafetyCompClaimsScoreColor

string

None.

SafetyCompClaimsPlanValue

string

None.

SafetyCompClaimsActualValue

string

None.

SafetyCompClaimsProjectedValue

string

None.

SafetyPrevClaims

string

None.

SafetyPrevClaimsTargetValue

string

None.

SafetyPrevClaimsScoreColor

string

None.

SafetyPrevClaimsPlanValue

string

None.

SafetyPrevClaimsActualValue

string

None.

SafetyPrevClaimsProjectedValue

string

None.

SafetyRecClaims

string

None.

SafetyRecClaimsTargetValue

string

None.

SafetyRecClaimsScoreColor

string

None.

SafetyRecClaimsPlanValue

string

None.

SafetyRecClaimsActualValue

string

None.

SafetyRecClaimsProjectedValue

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",
    "SafetyGPS": "sample string 8",
    "SafetyGPSTargetValue": "sample string 9",
    "SafetyGPSScoreColor": "sample string 10",
    "SafetyGPSPlanValue": "sample string 11",
    "SafetyGPSActualValue": "sample string 12",
    "SafetyGPSProjectedValue": "sample string 13",
    "LowestScore": "sample string 14",
    "LowestScoreTargetValue": "sample string 15",
    "LowestScoreScoreColor": "sample string 16",
    "LowestScorePlanValue": "sample string 17",
    "LowestScoreActualValue": "sample string 18",
    "LowestScoreProjectedValue": "sample string 19",
    "ExceptionSummary": {
      "BranchCode": "sample string 1",
      "EmployeeNumber": "sample string 2",
      "EmployeeName": "sample string 3",
      "SafetyCount": 4,
      "SafetyRate": 5.0,
      "Swerving": 6,
      "Speading": 7,
      "RapidAcceleration": 8,
      "HardBraking": 9,
      "DeviceUnplugged": 10,
      "DeviceUnpluggedCount": 11
    },
    "SafetyCompClaims": "sample string 20",
    "SafetyCompClaimsTargetValue": "sample string 21",
    "SafetyCompClaimsScoreColor": "sample string 22",
    "SafetyCompClaimsPlanValue": "sample string 23",
    "SafetyCompClaimsActualValue": "sample string 24",
    "SafetyCompClaimsProjectedValue": "sample string 25",
    "SafetyPrevClaims": "sample string 26",
    "SafetyPrevClaimsTargetValue": "sample string 27",
    "SafetyPrevClaimsScoreColor": "sample string 28",
    "SafetyPrevClaimsPlanValue": "sample string 29",
    "SafetyPrevClaimsActualValue": "sample string 30",
    "SafetyPrevClaimsProjectedValue": "sample string 31",
    "SafetyRecClaims": "sample string 32",
    "SafetyRecClaimsTargetValue": "sample string 33",
    "SafetyRecClaimsScoreColor": "sample string 34",
    "SafetyRecClaimsPlanValue": "sample string 35",
    "SafetyRecClaimsActualValue": "sample string 36",
    "SafetyRecClaimsProjectedValue": "sample string 37",
    "ReturnMessage": "sample string 38"
  },
  {
    "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",
    "SafetyGPS": "sample string 8",
    "SafetyGPSTargetValue": "sample string 9",
    "SafetyGPSScoreColor": "sample string 10",
    "SafetyGPSPlanValue": "sample string 11",
    "SafetyGPSActualValue": "sample string 12",
    "SafetyGPSProjectedValue": "sample string 13",
    "LowestScore": "sample string 14",
    "LowestScoreTargetValue": "sample string 15",
    "LowestScoreScoreColor": "sample string 16",
    "LowestScorePlanValue": "sample string 17",
    "LowestScoreActualValue": "sample string 18",
    "LowestScoreProjectedValue": "sample string 19",
    "ExceptionSummary": {
      "BranchCode": "sample string 1",
      "EmployeeNumber": "sample string 2",
      "EmployeeName": "sample string 3",
      "SafetyCount": 4,
      "SafetyRate": 5.0,
      "Swerving": 6,
      "Speading": 7,
      "RapidAcceleration": 8,
      "HardBraking": 9,
      "DeviceUnplugged": 10,
      "DeviceUnpluggedCount": 11
    },
    "SafetyCompClaims": "sample string 20",
    "SafetyCompClaimsTargetValue": "sample string 21",
    "SafetyCompClaimsScoreColor": "sample string 22",
    "SafetyCompClaimsPlanValue": "sample string 23",
    "SafetyCompClaimsActualValue": "sample string 24",
    "SafetyCompClaimsProjectedValue": "sample string 25",
    "SafetyPrevClaims": "sample string 26",
    "SafetyPrevClaimsTargetValue": "sample string 27",
    "SafetyPrevClaimsScoreColor": "sample string 28",
    "SafetyPrevClaimsPlanValue": "sample string 29",
    "SafetyPrevClaimsActualValue": "sample string 30",
    "SafetyPrevClaimsProjectedValue": "sample string 31",
    "SafetyRecClaims": "sample string 32",
    "SafetyRecClaimsTargetValue": "sample string 33",
    "SafetyRecClaimsScoreColor": "sample string 34",
    "SafetyRecClaimsPlanValue": "sample string 35",
    "SafetyRecClaimsActualValue": "sample string 36",
    "SafetyRecClaimsProjectedValue": "sample string 37",
    "ReturnMessage": "sample string 38"
  }
]

application/xml, text/xml

Sample:
<ArrayOfRegionalComplianceGPSDetailModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TMXWebAPI.Models">
  <RegionalComplianceGPSDetailModel>
    <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>
    <ExceptionSummary>
      <BranchCode>sample string 1</BranchCode>
      <DeviceUnplugged>10</DeviceUnplugged>
      <DeviceUnpluggedCount>11</DeviceUnpluggedCount>
      <EmployeeName>sample string 3</EmployeeName>
      <EmployeeNumber>sample string 2</EmployeeNumber>
      <HardBraking>9</HardBraking>
      <RapidAcceleration>8</RapidAcceleration>
      <SafetyCount>4</SafetyCount>
      <SafetyRate>5</SafetyRate>
      <Speading>7</Speading>
      <Swerving>6</Swerving>
    </ExceptionSummary>
    <LowestScore>sample string 14</LowestScore>
    <LowestScoreActualValue>sample string 18</LowestScoreActualValue>
    <LowestScorePlanValue>sample string 17</LowestScorePlanValue>
    <LowestScoreProjectedValue>sample string 19</LowestScoreProjectedValue>
    <LowestScoreScoreColor>sample string 16</LowestScoreScoreColor>
    <LowestScoreTargetValue>sample string 15</LowestScoreTargetValue>
    <RegionCode>sample string 4</RegionCode>
    <RegionName>sample string 5</RegionName>
    <ReturnMessage>sample string 38</ReturnMessage>
    <SafetyCompClaims>sample string 20</SafetyCompClaims>
    <SafetyCompClaimsActualValue>sample string 24</SafetyCompClaimsActualValue>
    <SafetyCompClaimsPlanValue>sample string 23</SafetyCompClaimsPlanValue>
    <SafetyCompClaimsProjectedValue>sample string 25</SafetyCompClaimsProjectedValue>
    <SafetyCompClaimsScoreColor>sample string 22</SafetyCompClaimsScoreColor>
    <SafetyCompClaimsTargetValue>sample string 21</SafetyCompClaimsTargetValue>
    <SafetyGPS>sample string 8</SafetyGPS>
    <SafetyGPSActualValue>sample string 12</SafetyGPSActualValue>
    <SafetyGPSPlanValue>sample string 11</SafetyGPSPlanValue>
    <SafetyGPSProjectedValue>sample string 13</SafetyGPSProjectedValue>
    <SafetyGPSScoreColor>sample string 10</SafetyGPSScoreColor>
    <SafetyGPSTargetValue>sample string 9</SafetyGPSTargetValue>
    <SafetyPrevClaims>sample string 26</SafetyPrevClaims>
    <SafetyPrevClaimsActualValue>sample string 30</SafetyPrevClaimsActualValue>
    <SafetyPrevClaimsPlanValue>sample string 29</SafetyPrevClaimsPlanValue>
    <SafetyPrevClaimsProjectedValue>sample string 31</SafetyPrevClaimsProjectedValue>
    <SafetyPrevClaimsScoreColor>sample string 28</SafetyPrevClaimsScoreColor>
    <SafetyPrevClaimsTargetValue>sample string 27</SafetyPrevClaimsTargetValue>
    <SafetyRecClaims>sample string 32</SafetyRecClaims>
    <SafetyRecClaimsActualValue>sample string 36</SafetyRecClaimsActualValue>
    <SafetyRecClaimsPlanValue>sample string 35</SafetyRecClaimsPlanValue>
    <SafetyRecClaimsProjectedValue>sample string 37</SafetyRecClaimsProjectedValue>
    <SafetyRecClaimsScoreColor>sample string 34</SafetyRecClaimsScoreColor>
    <SafetyRecClaimsTargetValue>sample string 33</SafetyRecClaimsTargetValue>
  </RegionalComplianceGPSDetailModel>
  <RegionalComplianceGPSDetailModel>
    <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>
    <ExceptionSummary>
      <BranchCode>sample string 1</BranchCode>
      <DeviceUnplugged>10</DeviceUnplugged>
      <DeviceUnpluggedCount>11</DeviceUnpluggedCount>
      <EmployeeName>sample string 3</EmployeeName>
      <EmployeeNumber>sample string 2</EmployeeNumber>
      <HardBraking>9</HardBraking>
      <RapidAcceleration>8</RapidAcceleration>
      <SafetyCount>4</SafetyCount>
      <SafetyRate>5</SafetyRate>
      <Speading>7</Speading>
      <Swerving>6</Swerving>
    </ExceptionSummary>
    <LowestScore>sample string 14</LowestScore>
    <LowestScoreActualValue>sample string 18</LowestScoreActualValue>
    <LowestScorePlanValue>sample string 17</LowestScorePlanValue>
    <LowestScoreProjectedValue>sample string 19</LowestScoreProjectedValue>
    <LowestScoreScoreColor>sample string 16</LowestScoreScoreColor>
    <LowestScoreTargetValue>sample string 15</LowestScoreTargetValue>
    <RegionCode>sample string 4</RegionCode>
    <RegionName>sample string 5</RegionName>
    <ReturnMessage>sample string 38</ReturnMessage>
    <SafetyCompClaims>sample string 20</SafetyCompClaims>
    <SafetyCompClaimsActualValue>sample string 24</SafetyCompClaimsActualValue>
    <SafetyCompClaimsPlanValue>sample string 23</SafetyCompClaimsPlanValue>
    <SafetyCompClaimsProjectedValue>sample string 25</SafetyCompClaimsProjectedValue>
    <SafetyCompClaimsScoreColor>sample string 22</SafetyCompClaimsScoreColor>
    <SafetyCompClaimsTargetValue>sample string 21</SafetyCompClaimsTargetValue>
    <SafetyGPS>sample string 8</SafetyGPS>
    <SafetyGPSActualValue>sample string 12</SafetyGPSActualValue>
    <SafetyGPSPlanValue>sample string 11</SafetyGPSPlanValue>
    <SafetyGPSProjectedValue>sample string 13</SafetyGPSProjectedValue>
    <SafetyGPSScoreColor>sample string 10</SafetyGPSScoreColor>
    <SafetyGPSTargetValue>sample string 9</SafetyGPSTargetValue>
    <SafetyPrevClaims>sample string 26</SafetyPrevClaims>
    <SafetyPrevClaimsActualValue>sample string 30</SafetyPrevClaimsActualValue>
    <SafetyPrevClaimsPlanValue>sample string 29</SafetyPrevClaimsPlanValue>
    <SafetyPrevClaimsProjectedValue>sample string 31</SafetyPrevClaimsProjectedValue>
    <SafetyPrevClaimsScoreColor>sample string 28</SafetyPrevClaimsScoreColor>
    <SafetyPrevClaimsTargetValue>sample string 27</SafetyPrevClaimsTargetValue>
    <SafetyRecClaims>sample string 32</SafetyRecClaims>
    <SafetyRecClaimsActualValue>sample string 36</SafetyRecClaimsActualValue>
    <SafetyRecClaimsPlanValue>sample string 35</SafetyRecClaimsPlanValue>
    <SafetyRecClaimsProjectedValue>sample string 37</SafetyRecClaimsProjectedValue>
    <SafetyRecClaimsScoreColor>sample string 34</SafetyRecClaimsScoreColor>
    <SafetyRecClaimsTargetValue>sample string 33</SafetyRecClaimsTargetValue>
  </RegionalComplianceGPSDetailModel>
</ArrayOfRegionalComplianceGPSDetailModel>