POST api/branch/GetActivityReportInBranch

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

Collection of RegionActivityModel
NameDescriptionTypeAdditional information
Status

string

None.

Division

integer

None.

Region

integer

None.

Branch

integer

None.

LeadCreatedDate

string

None.

CreatedBunit

string

None.

LeadCreatedBy

string

None.

Employee

string

None.

EmployeeNo

string

None.

CustomerNo

integer

None.

SalesAgreementNumber

integer

None.

CustomerName

string

None.

Address

string

None.

Activity

string

None.

LeadType

string

None.

ServiceLine

string

None.

ServiceType

string

None.

NetAmount

integer

None.

GrossAmount

integer

None.

DiscountAmount

integer

None.

Workorder

integer

None.

ScheduledDate

string

None.

CompletionDate

string

None.

RawSaleValue

integer

None.

RenewalAmount

integer

None.

ProductionValue

string

None.

PaymentType

string

None.

ReturnMessage

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Status": "sample string 1",
    "Division": 2,
    "Region": 3,
    "Branch": 4,
    "LeadCreatedDate": "sample string 5",
    "CreatedBunit": "sample string 6",
    "LeadCreatedBy": "sample string 7",
    "Employee": "sample string 8",
    "EmployeeNo": "sample string 9",
    "CustomerNo": 10,
    "SalesAgreementNumber": 11,
    "CustomerName": "sample string 12",
    "Address": "sample string 13",
    "Activity": "sample string 14",
    "LeadType": "sample string 15",
    "ServiceLine": "sample string 16",
    "ServiceType": "sample string 17",
    "NetAmount": 18,
    "GrossAmount": 19,
    "DiscountAmount": 20,
    "Workorder": 21,
    "ScheduledDate": "sample string 22",
    "CompletionDate": "sample string 23",
    "RawSaleValue": 24,
    "RenewalAmount": 25,
    "ProductionValue": "sample string 26",
    "PaymentType": "sample string 27",
    "ReturnMessage": "sample string 28"
  },
  {
    "Status": "sample string 1",
    "Division": 2,
    "Region": 3,
    "Branch": 4,
    "LeadCreatedDate": "sample string 5",
    "CreatedBunit": "sample string 6",
    "LeadCreatedBy": "sample string 7",
    "Employee": "sample string 8",
    "EmployeeNo": "sample string 9",
    "CustomerNo": 10,
    "SalesAgreementNumber": 11,
    "CustomerName": "sample string 12",
    "Address": "sample string 13",
    "Activity": "sample string 14",
    "LeadType": "sample string 15",
    "ServiceLine": "sample string 16",
    "ServiceType": "sample string 17",
    "NetAmount": 18,
    "GrossAmount": 19,
    "DiscountAmount": 20,
    "Workorder": 21,
    "ScheduledDate": "sample string 22",
    "CompletionDate": "sample string 23",
    "RawSaleValue": 24,
    "RenewalAmount": 25,
    "ProductionValue": "sample string 26",
    "PaymentType": "sample string 27",
    "ReturnMessage": "sample string 28"
  }
]

application/xml, text/xml

Sample:
<ArrayOfRegionActivityModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TMXWebAPI.Models">
  <RegionActivityModel>
    <Activity>sample string 14</Activity>
    <Address>sample string 13</Address>
    <Branch>4</Branch>
    <CompletionDate>sample string 23</CompletionDate>
    <CreatedBunit>sample string 6</CreatedBunit>
    <CustomerName>sample string 12</CustomerName>
    <CustomerNo>10</CustomerNo>
    <DiscountAmount>20</DiscountAmount>
    <Division>2</Division>
    <Employee>sample string 8</Employee>
    <EmployeeNo>sample string 9</EmployeeNo>
    <GrossAmount>19</GrossAmount>
    <LeadCreatedBy>sample string 7</LeadCreatedBy>
    <LeadCreatedDate>sample string 5</LeadCreatedDate>
    <LeadType>sample string 15</LeadType>
    <NetAmount>18</NetAmount>
    <PaymentType>sample string 27</PaymentType>
    <ProductionValue>sample string 26</ProductionValue>
    <RawSaleValue>24</RawSaleValue>
    <Region>3</Region>
    <RenewalAmount>25</RenewalAmount>
    <ReturnMessage>sample string 28</ReturnMessage>
    <SalesAgreementNumber>11</SalesAgreementNumber>
    <ScheduledDate>sample string 22</ScheduledDate>
    <ServiceLine>sample string 16</ServiceLine>
    <ServiceType>sample string 17</ServiceType>
    <Status>sample string 1</Status>
    <Workorder>21</Workorder>
  </RegionActivityModel>
  <RegionActivityModel>
    <Activity>sample string 14</Activity>
    <Address>sample string 13</Address>
    <Branch>4</Branch>
    <CompletionDate>sample string 23</CompletionDate>
    <CreatedBunit>sample string 6</CreatedBunit>
    <CustomerName>sample string 12</CustomerName>
    <CustomerNo>10</CustomerNo>
    <DiscountAmount>20</DiscountAmount>
    <Division>2</Division>
    <Employee>sample string 8</Employee>
    <EmployeeNo>sample string 9</EmployeeNo>
    <GrossAmount>19</GrossAmount>
    <LeadCreatedBy>sample string 7</LeadCreatedBy>
    <LeadCreatedDate>sample string 5</LeadCreatedDate>
    <LeadType>sample string 15</LeadType>
    <NetAmount>18</NetAmount>
    <PaymentType>sample string 27</PaymentType>
    <ProductionValue>sample string 26</ProductionValue>
    <RawSaleValue>24</RawSaleValue>
    <Region>3</Region>
    <RenewalAmount>25</RenewalAmount>
    <ReturnMessage>sample string 28</ReturnMessage>
    <SalesAgreementNumber>11</SalesAgreementNumber>
    <ScheduledDate>sample string 22</ScheduledDate>
    <ServiceLine>sample string 16</ServiceLine>
    <ServiceType>sample string 17</ServiceType>
    <Status>sample string 1</Status>
    <Workorder>21</Workorder>
  </RegionActivityModel>
</ArrayOfRegionActivityModel>