POST api/Targets/GetCompanyYearlyTargets

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
companyCode	string	None.
year	string	None.
user	string	None.
deviceID	string	None.
ticketID	string	None.

Request Formats

application/json, text/json

Sample:

{
  "companyCode": "sample string 1",
  "year": "sample string 2",
  "user": "sample string 3",
  "deviceID": "sample string 4",
  "ticketID": "sample string 5"
}

application/xml, text/xml

Sample:

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

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

TargetsAllMetricView

Name	Type	Additional information
Year	integer	None.
BuCode	string	None.
BuType	string	None.
ReturnMessage	string	None.
TargetMetrics	Collection of TargetsMetricItemList	None.

Response Formats

application/json, text/json

Sample:

{
  "Year": 1,
  "BuCode": "sample string 2",
  "BuType": "sample string 3",
  "ReturnMessage": "sample string 4",
  "TargetMetrics": [
    {
      "TargetParty": "sample string 1",
      "TargetPartyCode": "sample string 2",
      "TargetPartyName": "sample string 3",
      "MetricCode": "sample string 4",
      "MetricName": "sample string 5",
      "MetricCategory": "sample string 6",
      "TargetsLst": [
        {
          "YearMonth": "sample string 1",
          "TargetValue": 2,
          "TargetPercentage": 3.0,
          "EnableForUpdate": true
        },
        {
          "YearMonth": "sample string 1",
          "TargetValue": 2,
          "TargetPercentage": 3.0,
          "EnableForUpdate": true
        }
      ]
    },
    {
      "TargetParty": "sample string 1",
      "TargetPartyCode": "sample string 2",
      "TargetPartyName": "sample string 3",
      "MetricCode": "sample string 4",
      "MetricName": "sample string 5",
      "MetricCategory": "sample string 6",
      "TargetsLst": [
        {
          "YearMonth": "sample string 1",
          "TargetValue": 2,
          "TargetPercentage": 3.0,
          "EnableForUpdate": true
        },
        {
          "YearMonth": "sample string 1",
          "TargetValue": 2,
          "TargetPercentage": 3.0,
          "EnableForUpdate": true
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample:

<TargetsAllMetricView xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TMXWebAPI.Models">
  <BuCode>sample string 2</BuCode>
  <BuType>sample string 3</BuType>
  <ReturnMessage>sample string 4</ReturnMessage>
  <TargetMetrics>
    <TargetsMetricItemList>
      <MetricCategory>sample string 6</MetricCategory>
      <MetricCode>sample string 4</MetricCode>
      <MetricName>sample string 5</MetricName>
      <TargetParty>sample string 1</TargetParty>
      <TargetPartyCode>sample string 2</TargetPartyCode>
      <TargetPartyName>sample string 3</TargetPartyName>
      <TargetsLst>
        <TargetsModel>
          <EnableForUpdate>true</EnableForUpdate>
          <TargetPercentage>3</TargetPercentage>
          <TargetValue>2</TargetValue>
          <YearMonth>sample string 1</YearMonth>
        </TargetsModel>
        <TargetsModel>
          <EnableForUpdate>true</EnableForUpdate>
          <TargetPercentage>3</TargetPercentage>
          <TargetValue>2</TargetValue>
          <YearMonth>sample string 1</YearMonth>
        </TargetsModel>
      </TargetsLst>
    </TargetsMetricItemList>
    <TargetsMetricItemList>
      <MetricCategory>sample string 6</MetricCategory>
      <MetricCode>sample string 4</MetricCode>
      <MetricName>sample string 5</MetricName>
      <TargetParty>sample string 1</TargetParty>
      <TargetPartyCode>sample string 2</TargetPartyCode>
      <TargetPartyName>sample string 3</TargetPartyName>
      <TargetsLst>
        <TargetsModel>
          <EnableForUpdate>true</EnableForUpdate>
          <TargetPercentage>3</TargetPercentage>
          <TargetValue>2</TargetValue>
          <YearMonth>sample string 1</YearMonth>
        </TargetsModel>
        <TargetsModel>
          <EnableForUpdate>true</EnableForUpdate>
          <TargetPercentage>3</TargetPercentage>
          <TargetValue>2</TargetValue>
          <YearMonth>sample string 1</YearMonth>
        </TargetsModel>
      </TargetsLst>
    </TargetsMetricItemList>
  </TargetMetrics>
  <Year>1</Year>
</TargetsAllMetricView>