POST api/V3/Outlet/GetBeatWithHierarchy
For a List of All Beat, Territory, Region and Zones of The Company
Request Information
URI Parameters
None.
Body Parameters
Collection of stringRequest Formats
application/json, text/json
Sample:
[ "sample string 1", "sample string 2" ]
application/xml, text/xml
Sample:
<ArrayOfstring xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <string>sample string 1</string> <string>sample string 2</string> </ArrayOfstring>
Response Information
Resource Description
Collection of BeatFlat| Name | Description | Type | Additional information |
|---|---|---|---|
| Id | integer |
None. |
|
| ZoneName | string |
None. |
|
| TerritoryName | string |
None. |
|
| BeatName | string |
None. |
|
| BeatERPId | string |
None. |
|
| BeatGuid | globally unique identifier |
None. |
|
| Region | string |
None. |
|
| RegionId | integer |
None. |
|
| CompanyId | integer |
None. |
|
| City | string |
None. |
|
| State | string |
None. |
|
| IsDeactive | boolean |
None. |
|
| RegionERPId | string |
None. |
|
| TerritoryERPId | string |
None. |
|
| ZoneERPId | string |
None. |
|
| Level5 | string |
None. |
|
| Level5ERPId | string |
None. |
|
| Level6 | string |
None. |
|
| Level6ERPId | string |
None. |
|
| Level7 | string |
None. |
|
| Level7ERPId | string |
None. |
|
| CityDuplicate | string |
None. |
|
| NumberOfOutletsAttached | integer |
None. |
|
| BeatGrade | BeatGrade |
None. |
|
| AttributeText1 | string |
String length: inclusive between 0 and 50 |
|
| AttributeText2 | string |
String length: inclusive between 0 and 50 |
|
| AttributeText3 | string |
String length: inclusive between 0 and 50 |
|
| AttributeText4 | string |
String length: inclusive between 0 and 50 |
|
| AttributeBoolean1 | boolean |
None. |
|
| AttributeBoolean2 | boolean |
None. |
|
| AttributeNumber1 | decimal number |
Range: inclusive between -1E+50 and 1E+50 |
|
| AttributeNumber2 | decimal number |
Range: inclusive between -1E+50 and 1E+50 |
|
| AttributeNumber3 | decimal number |
Range: inclusive between -1E+50 and 1E+50 |
|
| AttributeNumber4 | decimal number |
Range: inclusive between -1E+50 and 1E+50 |
Response Formats
application/json, text/json
Sample:
[
{
"Id": 1,
"ZoneName": "sample string 2",
"TerritoryName": "sample string 3",
"BeatName": "sample string 4",
"BeatERPId": "sample string 5",
"BeatGuid": "527fdbce-300b-4462-9139-ae418e311a08",
"Region": "sample string 7",
"RegionId": 8,
"CompanyId": 9,
"City": "sample string 10",
"State": "sample string 11",
"IsDeactive": true,
"RegionERPId": "sample string 13",
"TerritoryERPId": "sample string 14",
"ZoneERPId": "sample string 15",
"Level5": "sample string 16",
"Level5ERPId": "sample string 17",
"Level6": "sample string 18",
"Level6ERPId": "sample string 19",
"Level7": "sample string 20",
"Level7ERPId": "sample string 21",
"CityDuplicate": "sample string 22",
"NumberOfOutletsAttached": 23,
"BeatGrade": "None",
"AttributeText1": "sample string 24",
"AttributeText2": "sample string 25",
"AttributeText3": "sample string 26",
"AttributeText4": "sample string 27",
"AttributeBoolean1": true,
"AttributeBoolean2": true,
"AttributeNumber1": 1.1,
"AttributeNumber2": 1.1,
"AttributeNumber3": 1.1,
"AttributeNumber4": 1.1
},
{
"Id": 1,
"ZoneName": "sample string 2",
"TerritoryName": "sample string 3",
"BeatName": "sample string 4",
"BeatERPId": "sample string 5",
"BeatGuid": "527fdbce-300b-4462-9139-ae418e311a08",
"Region": "sample string 7",
"RegionId": 8,
"CompanyId": 9,
"City": "sample string 10",
"State": "sample string 11",
"IsDeactive": true,
"RegionERPId": "sample string 13",
"TerritoryERPId": "sample string 14",
"ZoneERPId": "sample string 15",
"Level5": "sample string 16",
"Level5ERPId": "sample string 17",
"Level6": "sample string 18",
"Level6ERPId": "sample string 19",
"Level7": "sample string 20",
"Level7ERPId": "sample string 21",
"CityDuplicate": "sample string 22",
"NumberOfOutletsAttached": 23,
"BeatGrade": "None",
"AttributeText1": "sample string 24",
"AttributeText2": "sample string 25",
"AttributeText3": "sample string 26",
"AttributeText4": "sample string 27",
"AttributeBoolean1": true,
"AttributeBoolean2": true,
"AttributeNumber1": 1.1,
"AttributeNumber2": 1.1,
"AttributeNumber3": 1.1,
"AttributeNumber4": 1.1
}
]
application/xml, text/xml
Sample:
<ArrayOfBeatFlat xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MasterDataServices.FlatModels">
<BeatFlat>
<AttributeBoolean1>true</AttributeBoolean1>
<AttributeBoolean2>true</AttributeBoolean2>
<AttributeNumber1>1.1</AttributeNumber1>
<AttributeNumber2>1.1</AttributeNumber2>
<AttributeNumber3>1.1</AttributeNumber3>
<AttributeNumber4>1.1</AttributeNumber4>
<AttributeText1>sample string 24</AttributeText1>
<AttributeText2>sample string 25</AttributeText2>
<AttributeText3>sample string 26</AttributeText3>
<AttributeText4>sample string 27</AttributeText4>
<BeatERPId>sample string 5</BeatERPId>
<BeatGrade>None</BeatGrade>
<BeatGuid>527fdbce-300b-4462-9139-ae418e311a08</BeatGuid>
<BeatName>sample string 4</BeatName>
<City>sample string 10</City>
<CityDuplicate>sample string 22</CityDuplicate>
<CompanyId>9</CompanyId>
<Id>1</Id>
<IsDeactive>true</IsDeactive>
<Level5>sample string 16</Level5>
<Level5ERPId>sample string 17</Level5ERPId>
<Level6>sample string 18</Level6>
<Level6ERPId>sample string 19</Level6ERPId>
<Level7>sample string 20</Level7>
<Level7ERPId>sample string 21</Level7ERPId>
<NumberOfOutletsAttached>23</NumberOfOutletsAttached>
<Region>sample string 7</Region>
<RegionERPId>sample string 13</RegionERPId>
<RegionId>8</RegionId>
<State>sample string 11</State>
<TerritoryERPId>sample string 14</TerritoryERPId>
<TerritoryName>sample string 3</TerritoryName>
<ZoneERPId>sample string 15</ZoneERPId>
<ZoneName>sample string 2</ZoneName>
</BeatFlat>
<BeatFlat>
<AttributeBoolean1>true</AttributeBoolean1>
<AttributeBoolean2>true</AttributeBoolean2>
<AttributeNumber1>1.1</AttributeNumber1>
<AttributeNumber2>1.1</AttributeNumber2>
<AttributeNumber3>1.1</AttributeNumber3>
<AttributeNumber4>1.1</AttributeNumber4>
<AttributeText1>sample string 24</AttributeText1>
<AttributeText2>sample string 25</AttributeText2>
<AttributeText3>sample string 26</AttributeText3>
<AttributeText4>sample string 27</AttributeText4>
<BeatERPId>sample string 5</BeatERPId>
<BeatGrade>None</BeatGrade>
<BeatGuid>527fdbce-300b-4462-9139-ae418e311a08</BeatGuid>
<BeatName>sample string 4</BeatName>
<City>sample string 10</City>
<CityDuplicate>sample string 22</CityDuplicate>
<CompanyId>9</CompanyId>
<Id>1</Id>
<IsDeactive>true</IsDeactive>
<Level5>sample string 16</Level5>
<Level5ERPId>sample string 17</Level5ERPId>
<Level6>sample string 18</Level6>
<Level6ERPId>sample string 19</Level6ERPId>
<Level7>sample string 20</Level7>
<Level7ERPId>sample string 21</Level7ERPId>
<NumberOfOutletsAttached>23</NumberOfOutletsAttached>
<Region>sample string 7</Region>
<RegionERPId>sample string 13</RegionERPId>
<RegionId>8</RegionId>
<State>sample string 11</State>
<TerritoryERPId>sample string 14</TerritoryERPId>
<TerritoryName>sample string 3</TerritoryName>
<ZoneERPId>sample string 15</ZoneERPId>
<ZoneName>sample string 2</ZoneName>
</BeatFlat>
</ArrayOfBeatFlat>