POST api/compliance/GetBranchGPSComplianceMetrics

Request Information

URI Parameters

None.

Body Parameters

BranchMetricsParameters
NameDescriptionTypeAdditional information
branchCode

string

None.

yearMonth

string

None.

user

string

None.

deviceID

string

None.

ticketID

string

None.

Request Formats

application/json, text/json

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

application/xml, text/xml

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

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

GPSModel
NameDescriptionTypeAdditional information
EmpItem

Collection of MobiException

None.

GPSDet

Collection of ComplianceGPSItem

None.

ReturnMessage

string

None.

Response Formats

application/json, text/json

Sample:
{
  "EmpItem": [
    {
      "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
    },
    {
      "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
    }
  ],
  "GPSDet": [
    {
      "BranchCode": "sample string 1",
      "EmployeeNumber": "sample string 2",
      "EmployeeName": "sample string 3",
      "TrackingDate": "sample string 4",
      "Swerving": 5,
      "Speading": 6,
      "RapidAcceleration": 7,
      "HardBraking": 8,
      "DeviceUnplugged": 9,
      "DeviceUnpluggedOccurances": 10,
      "Offhours": 11,
      "Idiling": 12,
      "LowBattery": 13,
      "DurationDependency": 14,
      "ReturnMessage": "sample string 15"
    },
    {
      "BranchCode": "sample string 1",
      "EmployeeNumber": "sample string 2",
      "EmployeeName": "sample string 3",
      "TrackingDate": "sample string 4",
      "Swerving": 5,
      "Speading": 6,
      "RapidAcceleration": 7,
      "HardBraking": 8,
      "DeviceUnplugged": 9,
      "DeviceUnpluggedOccurances": 10,
      "Offhours": 11,
      "Idiling": 12,
      "LowBattery": 13,
      "DurationDependency": 14,
      "ReturnMessage": "sample string 15"
    }
  ],
  "ReturnMessage": "sample string 1"
}

application/xml, text/xml

Sample:
<GPSModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TMXWebAPI.Models">
  <EmpItem>
    <MobiException>
      <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>
    </MobiException>
    <MobiException>
      <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>
    </MobiException>
  </EmpItem>
  <GPSDet>
    <ComplianceGPSItem>
      <BranchCode>sample string 1</BranchCode>
      <DeviceUnplugged>9</DeviceUnplugged>
      <DeviceUnpluggedOccurances>10</DeviceUnpluggedOccurances>
      <DurationDependency>14</DurationDependency>
      <EmployeeName>sample string 3</EmployeeName>
      <EmployeeNumber>sample string 2</EmployeeNumber>
      <HardBraking>8</HardBraking>
      <Idiling>12</Idiling>
      <LowBattery>13</LowBattery>
      <Offhours>11</Offhours>
      <RapidAcceleration>7</RapidAcceleration>
      <ReturnMessage>sample string 15</ReturnMessage>
      <Speading>6</Speading>
      <Swerving>5</Swerving>
      <TrackingDate>sample string 4</TrackingDate>
    </ComplianceGPSItem>
    <ComplianceGPSItem>
      <BranchCode>sample string 1</BranchCode>
      <DeviceUnplugged>9</DeviceUnplugged>
      <DeviceUnpluggedOccurances>10</DeviceUnpluggedOccurances>
      <DurationDependency>14</DurationDependency>
      <EmployeeName>sample string 3</EmployeeName>
      <EmployeeNumber>sample string 2</EmployeeNumber>
      <HardBraking>8</HardBraking>
      <Idiling>12</Idiling>
      <LowBattery>13</LowBattery>
      <Offhours>11</Offhours>
      <RapidAcceleration>7</RapidAcceleration>
      <ReturnMessage>sample string 15</ReturnMessage>
      <Speading>6</Speading>
      <Swerving>5</Swerving>
      <TrackingDate>sample string 4</TrackingDate>
    </ComplianceGPSItem>
  </GPSDet>
  <ReturnMessage>sample string 1</ReturnMessage>
</GPSModel>