POST api/service/GetBranchSignatureRatePCMetrics

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

SignatureRateActivityModel
NameDescriptionTypeAdditional information
EmpSerItem

Collection of EmployeeServiceItem

None.

SigRateItem

Collection of SignatureRateItem

None.

ReturnMessage

string

None.

Response Formats

application/json, text/json

Sample:
{
  "EmpSerItem": [
    {
      "EmployeeCode": "sample string 1",
      "EmployeeName": "sample string 2",
      "WOCount": 3,
      "WOSignedCount": 4,
      "Rate": 5.0
    },
    {
      "EmployeeCode": "sample string 1",
      "EmployeeName": "sample string 2",
      "WOCount": 3,
      "WOSignedCount": 4,
      "Rate": 5.0
    }
  ],
  "SigRateItem": [
    {
      "BranchCode": "sample string 1",
      "SalesAgreementNumber": "sample string 2",
      "CustomerNumber": "sample string 3",
      "CustomerName": "sample string 4",
      "ServiceLine": "sample string 5",
      "SAEffectiveDate": 6,
      "SAActEffectiveDate": 7,
      "SAAmount": 8.0,
      "EmployeeCode": "sample string 9",
      "EmployeeName": "sample string 10",
      "WorkOrderNumber": "sample string 11",
      "CompletedDate": "sample string 12",
      "WorkOrderSigned": "sample string 13"
    },
    {
      "BranchCode": "sample string 1",
      "SalesAgreementNumber": "sample string 2",
      "CustomerNumber": "sample string 3",
      "CustomerName": "sample string 4",
      "ServiceLine": "sample string 5",
      "SAEffectiveDate": 6,
      "SAActEffectiveDate": 7,
      "SAAmount": 8.0,
      "EmployeeCode": "sample string 9",
      "EmployeeName": "sample string 10",
      "WorkOrderNumber": "sample string 11",
      "CompletedDate": "sample string 12",
      "WorkOrderSigned": "sample string 13"
    }
  ],
  "ReturnMessage": "sample string 1"
}

application/xml, text/xml

Sample:
<SignatureRateActivityModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TMXWebAPI.Models">
  <EmpSerItem>
    <EmployeeServiceItem>
      <EmployeeCode>sample string 1</EmployeeCode>
      <EmployeeName>sample string 2</EmployeeName>
      <Rate>5</Rate>
      <WOCount>3</WOCount>
      <WOSignedCount>4</WOSignedCount>
    </EmployeeServiceItem>
    <EmployeeServiceItem>
      <EmployeeCode>sample string 1</EmployeeCode>
      <EmployeeName>sample string 2</EmployeeName>
      <Rate>5</Rate>
      <WOCount>3</WOCount>
      <WOSignedCount>4</WOSignedCount>
    </EmployeeServiceItem>
  </EmpSerItem>
  <ReturnMessage>sample string 1</ReturnMessage>
  <SigRateItem>
    <SignatureRateItem>
      <BranchCode>sample string 1</BranchCode>
      <CompletedDate>sample string 12</CompletedDate>
      <CustomerName>sample string 4</CustomerName>
      <CustomerNumber>sample string 3</CustomerNumber>
      <EmployeeCode>sample string 9</EmployeeCode>
      <EmployeeName>sample string 10</EmployeeName>
      <SAActEffectiveDate>7</SAActEffectiveDate>
      <SAAmount>8</SAAmount>
      <SAEffectiveDate>6</SAEffectiveDate>
      <SalesAgreementNumber>sample string 2</SalesAgreementNumber>
      <ServiceLine>sample string 5</ServiceLine>
      <WorkOrderNumber>sample string 11</WorkOrderNumber>
      <WorkOrderSigned>sample string 13</WorkOrderSigned>
    </SignatureRateItem>
    <SignatureRateItem>
      <BranchCode>sample string 1</BranchCode>
      <CompletedDate>sample string 12</CompletedDate>
      <CustomerName>sample string 4</CustomerName>
      <CustomerNumber>sample string 3</CustomerNumber>
      <EmployeeCode>sample string 9</EmployeeCode>
      <EmployeeName>sample string 10</EmployeeName>
      <SAActEffectiveDate>7</SAActEffectiveDate>
      <SAAmount>8</SAAmount>
      <SAEffectiveDate>6</SAEffectiveDate>
      <SalesAgreementNumber>sample string 2</SalesAgreementNumber>
      <ServiceLine>sample string 5</ServiceLine>
      <WorkOrderNumber>sample string 11</WorkOrderNumber>
      <WorkOrderSigned>sample string 13</WorkOrderSigned>
    </SignatureRateItem>
  </SigRateItem>
</SignatureRateActivityModel>