POST api/sales/GetBranchResidentialTCSales

Request Information

URI Parameters

None.

Body Parameters

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

SalesActivityModel

Name	Type	Additional information
SalesItems	Collection of SalesActivityFinalItem	None.
EmployeeItems	Collection of EmployeeSalesItem	None.
ReturnMessage	string	None.

Response Formats

application/json, text/json

Sample:

{
  "SalesItems": [
    {
      "BranchName": "sample string 1",
      "BranchCode": "sample string 2",
      "SalesAgreementNumber": "sample string 3",
      "CustomerNumber": "sample string 4",
      "CustomerName": "sample string 5",
      "ServiceLine": "sample string 6",
      "SAEffectiveDate": 7,
      "SAActEffectiveDate": 8,
      "SAAmount": 9.0,
      "RenewalAmount": 10.0,
      "EmployeeCode": "sample string 11",
      "EmployeeName": "sample string 12",
      "LeadEmployeeCode": "sample string 13",
      "LeadEmployeeName": "sample string 14",
      "LeadSource": "sample string 15",
      "LeadType": "sample string 16",
      "SaleCount": 17
    },
    {
      "BranchName": "sample string 1",
      "BranchCode": "sample string 2",
      "SalesAgreementNumber": "sample string 3",
      "CustomerNumber": "sample string 4",
      "CustomerName": "sample string 5",
      "ServiceLine": "sample string 6",
      "SAEffectiveDate": 7,
      "SAActEffectiveDate": 8,
      "SAAmount": 9.0,
      "RenewalAmount": 10.0,
      "EmployeeCode": "sample string 11",
      "EmployeeName": "sample string 12",
      "LeadEmployeeCode": "sample string 13",
      "LeadEmployeeName": "sample string 14",
      "LeadSource": "sample string 15",
      "LeadType": "sample string 16",
      "SaleCount": 17
    }
  ],
  "EmployeeItems": [
    {
      "EmployeeCode": "sample string 1",
      "EmployeeName": "sample string 2",
      "Count": 3,
      "Count2": 4,
      "AvgCount": 5.0,
      "Amount": 6.0
    },
    {
      "EmployeeCode": "sample string 1",
      "EmployeeName": "sample string 2",
      "Count": 3,
      "Count2": 4,
      "AvgCount": 5.0,
      "Amount": 6.0
    }
  ],
  "ReturnMessage": "sample string 1"
}

application/xml, text/xml

Sample:

<SalesActivityModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TMXWebAPI.Models">
  <EmployeeItems>
    <EmployeeSalesItem>
      <Amount>6</Amount>
      <AvgCount>5</AvgCount>
      <Count>3</Count>
      <Count2>4</Count2>
      <EmployeeCode>sample string 1</EmployeeCode>
      <EmployeeName>sample string 2</EmployeeName>
    </EmployeeSalesItem>
    <EmployeeSalesItem>
      <Amount>6</Amount>
      <AvgCount>5</AvgCount>
      <Count>3</Count>
      <Count2>4</Count2>
      <EmployeeCode>sample string 1</EmployeeCode>
      <EmployeeName>sample string 2</EmployeeName>
    </EmployeeSalesItem>
  </EmployeeItems>
  <ReturnMessage>sample string 1</ReturnMessage>
  <SalesItems>
    <SalesActivityFinalItem>
      <BranchCode>sample string 2</BranchCode>
      <BranchName>sample string 1</BranchName>
      <CustomerName>sample string 5</CustomerName>
      <CustomerNumber>sample string 4</CustomerNumber>
      <EmployeeCode>sample string 11</EmployeeCode>
      <EmployeeName>sample string 12</EmployeeName>
      <LeadEmployeeCode>sample string 13</LeadEmployeeCode>
      <LeadEmployeeName>sample string 14</LeadEmployeeName>
      <LeadSource>sample string 15</LeadSource>
      <LeadType>sample string 16</LeadType>
      <RenewalAmount>10</RenewalAmount>
      <SAActEffectiveDate>8</SAActEffectiveDate>
      <SAAmount>9</SAAmount>
      <SAEffectiveDate>7</SAEffectiveDate>
      <SaleCount>17</SaleCount>
      <SalesAgreementNumber>sample string 3</SalesAgreementNumber>
      <ServiceLine>sample string 6</ServiceLine>
    </SalesActivityFinalItem>
    <SalesActivityFinalItem>
      <BranchCode>sample string 2</BranchCode>
      <BranchName>sample string 1</BranchName>
      <CustomerName>sample string 5</CustomerName>
      <CustomerNumber>sample string 4</CustomerNumber>
      <EmployeeCode>sample string 11</EmployeeCode>
      <EmployeeName>sample string 12</EmployeeName>
      <LeadEmployeeCode>sample string 13</LeadEmployeeCode>
      <LeadEmployeeName>sample string 14</LeadEmployeeName>
      <LeadSource>sample string 15</LeadSource>
      <LeadType>sample string 16</LeadType>
      <RenewalAmount>10</RenewalAmount>
      <SAActEffectiveDate>8</SAActEffectiveDate>
      <SAAmount>9</SAAmount>
      <SAEffectiveDate>7</SAEffectiveDate>
      <SaleCount>17</SaleCount>
      <SalesAgreementNumber>sample string 3</SalesAgreementNumber>
      <ServiceLine>sample string 6</ServiceLine>
    </SalesActivityFinalItem>
  </SalesItems>
</SalesActivityModel>