POST api/service/GetRegionSalesCheckinData

Request Information

URI Parameters

None.

Body Parameters

RegionSalesCheckinParameters
NameDescriptionTypeAdditional information
user

string

None.

DivisionCode

string

None.

deviceID

string

None.

ticketID

string

None.

StartDate

string

None.

EndDate

string

None.

Request Formats

application/json, text/json

Sample:
{
  "user": "sample string 1",
  "DivisionCode": "sample string 2",
  "deviceID": "sample string 3",
  "ticketID": "sample string 4",
  "StartDate": "sample string 5",
  "EndDate": "sample string 6"
}

application/xml, text/xml

Sample:
<RegionSalesCheckinParameters xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TMXWebAPI.Models">
  <DivisionCode>sample string 2</DivisionCode>
  <EndDate>sample string 6</EndDate>
  <StartDate>sample string 5</StartDate>
  <deviceID>sample string 3</deviceID>
  <ticketID>sample string 4</ticketID>
  <user>sample string 1</user>
</RegionSalesCheckinParameters>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of SalesCheckinModel
NameDescriptionTypeAdditional information
yearMonth

string

None.

yearMonthDisplay

string

None.

CompanyCode

string

None.

DivisionCode

string

None.

DivisionName

string

None.

RegionCode

string

None.

RegionName

string

None.

BranchCode

string

None.

BranchName

string

None.

NoOfOSP

integer

None.

Week1checkins

integer

None.

Week2checkins

integer

None.

Week3checkins

integer

None.

Week4checkins

integer

None.

Totalcheckins

integer

None.

Compliance

decimal number

None.

OSPName

string

None.

OSPNumber

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "yearMonth": "sample string 1",
    "yearMonthDisplay": "sample string 2",
    "CompanyCode": "sample string 3",
    "DivisionCode": "sample string 4",
    "DivisionName": "sample string 5",
    "RegionCode": "sample string 6",
    "RegionName": "sample string 7",
    "BranchCode": "sample string 8",
    "BranchName": "sample string 9",
    "NoOfOSP": 10,
    "Week1checkins": 11,
    "Week2checkins": 12,
    "Week3checkins": 13,
    "Week4checkins": 14,
    "Totalcheckins": 15,
    "Compliance": 16.0,
    "OSPName": "sample string 17",
    "OSPNumber": "sample string 18"
  },
  {
    "yearMonth": "sample string 1",
    "yearMonthDisplay": "sample string 2",
    "CompanyCode": "sample string 3",
    "DivisionCode": "sample string 4",
    "DivisionName": "sample string 5",
    "RegionCode": "sample string 6",
    "RegionName": "sample string 7",
    "BranchCode": "sample string 8",
    "BranchName": "sample string 9",
    "NoOfOSP": 10,
    "Week1checkins": 11,
    "Week2checkins": 12,
    "Week3checkins": 13,
    "Week4checkins": 14,
    "Totalcheckins": 15,
    "Compliance": 16.0,
    "OSPName": "sample string 17",
    "OSPNumber": "sample string 18"
  }
]

application/xml, text/xml

Sample:
<ArrayOfSalesCheckinModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TMXWebAPI.Models">
  <SalesCheckinModel>
    <BranchCode>sample string 8</BranchCode>
    <BranchName>sample string 9</BranchName>
    <CompanyCode>sample string 3</CompanyCode>
    <Compliance>16</Compliance>
    <DivisionCode>sample string 4</DivisionCode>
    <DivisionName>sample string 5</DivisionName>
    <NoOfOSP>10</NoOfOSP>
    <OSPName>sample string 17</OSPName>
    <OSPNumber>sample string 18</OSPNumber>
    <RegionCode>sample string 6</RegionCode>
    <RegionName>sample string 7</RegionName>
    <Totalcheckins>15</Totalcheckins>
    <Week1checkins>11</Week1checkins>
    <Week2checkins>12</Week2checkins>
    <Week3checkins>13</Week3checkins>
    <Week4checkins>14</Week4checkins>
    <yearMonth>sample string 1</yearMonth>
    <yearMonthDisplay>sample string 2</yearMonthDisplay>
  </SalesCheckinModel>
  <SalesCheckinModel>
    <BranchCode>sample string 8</BranchCode>
    <BranchName>sample string 9</BranchName>
    <CompanyCode>sample string 3</CompanyCode>
    <Compliance>16</Compliance>
    <DivisionCode>sample string 4</DivisionCode>
    <DivisionName>sample string 5</DivisionName>
    <NoOfOSP>10</NoOfOSP>
    <OSPName>sample string 17</OSPName>
    <OSPNumber>sample string 18</OSPNumber>
    <RegionCode>sample string 6</RegionCode>
    <RegionName>sample string 7</RegionName>
    <Totalcheckins>15</Totalcheckins>
    <Week1checkins>11</Week1checkins>
    <Week2checkins>12</Week2checkins>
    <Week3checkins>13</Week3checkins>
    <Week4checkins>14</Week4checkins>
    <yearMonth>sample string 1</yearMonth>
    <yearMonthDisplay>sample string 2</yearMonthDisplay>
  </SalesCheckinModel>
</ArrayOfSalesCheckinModel>