POST api/service/GetBranchREICompletionMetrics

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

WOeActivityModel

Name	Type	Additional information
EmpWoItem	Collection of EmployeeWOItem	None.
WOItem	Collection of WOItem	None.
ReturnMessage	string	None.

Response Formats

application/json, text/json

Sample:

{
  "EmpWoItem": [
    {
      "EmployeeCode": "sample string 1",
      "EmployeeName": "sample string 2",
      "ScheduledCount": 3,
      "CompletedCount": 4,
      "Rate": 5.0
    },
    {
      "EmployeeCode": "sample string 1",
      "EmployeeName": "sample string 2",
      "ScheduledCount": 3,
      "CompletedCount": 4,
      "Rate": 5.0
    }
  ],
  "WOItem": [
    {
      "BranchCode": "sample string 1",
      "SalesAgreementNumber": "sample string 2",
      "Territory": "sample string 3",
      "CustomerNumber": "sample string 4",
      "CustomerName": "sample string 5",
      "ServiceLine": "sample string 6",
      "ServiceType": "sample string 7",
      "Frequency": "sample string 8",
      "SAEffectiveDate": 9,
      "SAAmount": 10.0,
      "EmployeeCode": "sample string 11",
      "EmployeeName": "sample string 12",
      "WorkOrderNumber": "sample string 13",
      "PlannedDate": "sample string 14",
      "ScheduledDate": "sample string 15",
      "CompletedDate": "sample string 16",
      "Status": "sample string 17",
      "Reason": "sample string 18"
    },
    {
      "BranchCode": "sample string 1",
      "SalesAgreementNumber": "sample string 2",
      "Territory": "sample string 3",
      "CustomerNumber": "sample string 4",
      "CustomerName": "sample string 5",
      "ServiceLine": "sample string 6",
      "ServiceType": "sample string 7",
      "Frequency": "sample string 8",
      "SAEffectiveDate": 9,
      "SAAmount": 10.0,
      "EmployeeCode": "sample string 11",
      "EmployeeName": "sample string 12",
      "WorkOrderNumber": "sample string 13",
      "PlannedDate": "sample string 14",
      "ScheduledDate": "sample string 15",
      "CompletedDate": "sample string 16",
      "Status": "sample string 17",
      "Reason": "sample string 18"
    }
  ],
  "ReturnMessage": "sample string 1"
}

application/xml, text/xml

Sample:

<WOeActivityModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TMXWebAPI.Models">
  <EmpWoItem>
    <EmployeeWOItem>
      <CompletedCount>4</CompletedCount>
      <EmployeeCode>sample string 1</EmployeeCode>
      <EmployeeName>sample string 2</EmployeeName>
      <Rate>5</Rate>
      <ScheduledCount>3</ScheduledCount>
    </EmployeeWOItem>
    <EmployeeWOItem>
      <CompletedCount>4</CompletedCount>
      <EmployeeCode>sample string 1</EmployeeCode>
      <EmployeeName>sample string 2</EmployeeName>
      <Rate>5</Rate>
      <ScheduledCount>3</ScheduledCount>
    </EmployeeWOItem>
  </EmpWoItem>
  <ReturnMessage>sample string 1</ReturnMessage>
  <WOItem>
    <WOItem>
      <BranchCode>sample string 1</BranchCode>
      <CompletedDate>sample string 16</CompletedDate>
      <CustomerName>sample string 5</CustomerName>
      <CustomerNumber>sample string 4</CustomerNumber>
      <EmployeeCode>sample string 11</EmployeeCode>
      <EmployeeName>sample string 12</EmployeeName>
      <Frequency>sample string 8</Frequency>
      <PlannedDate>sample string 14</PlannedDate>
      <Reason>sample string 18</Reason>
      <SAAmount>10</SAAmount>
      <SAEffectiveDate>9</SAEffectiveDate>
      <SalesAgreementNumber>sample string 2</SalesAgreementNumber>
      <ScheduledDate>sample string 15</ScheduledDate>
      <ServiceLine>sample string 6</ServiceLine>
      <ServiceType>sample string 7</ServiceType>
      <Status>sample string 17</Status>
      <Territory>sample string 3</Territory>
      <WorkOrderNumber>sample string 13</WorkOrderNumber>
    </WOItem>
    <WOItem>
      <BranchCode>sample string 1</BranchCode>
      <CompletedDate>sample string 16</CompletedDate>
      <CustomerName>sample string 5</CustomerName>
      <CustomerNumber>sample string 4</CustomerNumber>
      <EmployeeCode>sample string 11</EmployeeCode>
      <EmployeeName>sample string 12</EmployeeName>
      <Frequency>sample string 8</Frequency>
      <PlannedDate>sample string 14</PlannedDate>
      <Reason>sample string 18</Reason>
      <SAAmount>10</SAAmount>
      <SAEffectiveDate>9</SAEffectiveDate>
      <SalesAgreementNumber>sample string 2</SalesAgreementNumber>
      <ScheduledDate>sample string 15</ScheduledDate>
      <ServiceLine>sample string 6</ServiceLine>
      <ServiceType>sample string 7</ServiceType>
      <Status>sample string 17</Status>
      <Territory>sample string 3</Territory>
      <WorkOrderNumber>sample string 13</WorkOrderNumber>
    </WOItem>
  </WOItem>
</WOeActivityModel>