POST api/V3/Outlet/CreateMultipleBeatsWithErp
Creates and update Beats with Its Hierarchy, and erpid is required
Request Information
URI Parameters
None.
Body Parameters
Collection of BeatWithHierarchyWithERPID| Name | Description | Type | Additional information |
|---|---|---|---|
| BeatName |
Beat Name |
string |
Required String length: inclusive between 3 and 100 |
| BeatErpId |
Beat ErpId |
string |
Required String length: inclusive between 1 and 100 |
| TerritoryName |
Territory Name |
string |
Required String length: inclusive between 3 and 100 |
| TerritoryErpId |
Territory ErpId |
string |
Required String length: inclusive between 1 and 100 |
| SubTerritories |
can be used City Duplicates or sub territoies |
string |
None. |
| RegionName |
Region Name |
string |
Required String length: inclusive between 3 and 100 |
| RegionErpId |
Region ErpId |
string |
Required String length: inclusive between 1 and 100 |
| ZoneName |
Zon Name |
string |
Required String length: inclusive between 3 and 100 |
| ZoneErpId |
Zon ErpId |
string |
Required String length: inclusive between 1 and 100 |
Request Formats
application/json, text/json
[
{
"BeatName": "sample string 1",
"BeatErpId": "sample string 2",
"TerritoryName": "sample string 3",
"TerritoryErpId": "sample string 4",
"SubTerritories": "sample string 5",
"RegionName": "sample string 6",
"RegionErpId": "sample string 7",
"ZoneName": "sample string 8",
"ZoneErpId": "sample string 9"
},
{
"BeatName": "sample string 1",
"BeatErpId": "sample string 2",
"TerritoryName": "sample string 3",
"TerritoryErpId": "sample string 4",
"SubTerritories": "sample string 5",
"RegionName": "sample string 6",
"RegionErpId": "sample string 7",
"ZoneName": "sample string 8",
"ZoneErpId": "sample string 9"
}
]
application/xml, text/xml
<ArrayOfBeatWithHierarchyWithERPID xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ExternalApis.V3.Models">
<BeatWithHierarchyWithERPID>
<BeatErpId>sample string 2</BeatErpId>
<BeatName>sample string 1</BeatName>
<RegionErpId>sample string 7</RegionErpId>
<RegionName>sample string 6</RegionName>
<SubTerritories>sample string 5</SubTerritories>
<TerritoryErpId>sample string 4</TerritoryErpId>
<TerritoryName>sample string 3</TerritoryName>
<ZoneErpId>sample string 9</ZoneErpId>
<ZoneName>sample string 8</ZoneName>
</BeatWithHierarchyWithERPID>
<BeatWithHierarchyWithERPID>
<BeatErpId>sample string 2</BeatErpId>
<BeatName>sample string 1</BeatName>
<RegionErpId>sample string 7</RegionErpId>
<RegionName>sample string 6</RegionName>
<SubTerritories>sample string 5</SubTerritories>
<TerritoryErpId>sample string 4</TerritoryErpId>
<TerritoryName>sample string 3</TerritoryName>
<ZoneErpId>sample string 9</ZoneErpId>
<ZoneName>sample string 8</ZoneName>
</BeatWithHierarchyWithERPID>
</ArrayOfBeatWithHierarchyWithERPID>
Response Information
Resource Description
ApiResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| Message |
Message Indicating the Overall Response Summary of the Requested API |
string |
None. |
| ResponseList |
List of Errors |
Collection of ApiResponseMessage |
None. |
| Response |
Enum Indicating the Response status |
ResponseStatus |
None. |
| ResponseStatusCount |
Summary containing Number of SuccessFull And Failed Tasks |
ResponseStatusCount |
None. |
Response Formats
application/json, text/json
{
"Message": "sample string 1",
"ResponseList": [
{
"ERPId": "sample string 1",
"Message": "sample string 2",
"ResponseStatus": "Failure",
"GUID": "sample string 3"
},
{
"ERPId": "sample string 1",
"Message": "sample string 2",
"ResponseStatus": "Failure",
"GUID": "sample string 3"
}
],
"Response": "Failure",
"ResponseStatusCount": {
"Updated": 1,
"Failed": 2,
"Ignored": 3,
"Name": "sample string 1",
"Total": 6,
"StatusMessage": "sample string 1: Total-6, Updated-1, Failed-2, Ignored-3",
"ResponseStatus": "PartialSuccess"
}
}
application/xml, text/xml
<ApiResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ExternalApis.Models.Common">
<Message>sample string 1</Message>
<Response>Failure</Response>
<ResponseList>
<ApiResponseMessage>
<ERPId>sample string 1</ERPId>
<GUID>sample string 3</GUID>
<Message>sample string 2</Message>
<ResponseStatus>Failure</ResponseStatus>
</ApiResponseMessage>
<ApiResponseMessage>
<ERPId>sample string 1</ERPId>
<GUID>sample string 3</GUID>
<Message>sample string 2</Message>
<ResponseStatus>Failure</ResponseStatus>
</ApiResponseMessage>
</ResponseList>
<ResponseStatusCount>
<Failed>2</Failed>
<Ignored>3</Ignored>
<Name>sample string 1</Name>
<Updated>1</Updated>
</ResponseStatusCount>
</ApiResponse>