POST api/compliance/GetRegionComplianceMetrics

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional 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 MetricModel

Name	Type	Additional information
MetricCode	string	None.
MetricName	string	None.
MetricValue	integer	None.
CancelMetricValue	decimal number	None.
TargetValue	decimal number	None.
ScoreColor	string	None.
PlanValue	string	None.
ActualValue	string	None.
ProjectedValue	string	None.
ReturnMessage	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "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:

<ArrayOfMetricModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TMXWebAPI.Models">
  <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>
</ArrayOfMetricModel>