POST api/V3/Outlet/UpdateMultipleBeats
Update Multiple Beats
Request Information
URI Parameters
None.
Body Parameters
Collection of BeatUpdate| Name | Description | Type | Additional information |
|---|---|---|---|
| Beat |
Beat Name |
string |
String length: inclusive between 3 and 100 |
| BeatErpId |
ERP Id of an existing Beat |
string |
Required String length: inclusive between 0 and 100 |
| City |
City in which beat is located |
string |
String length: inclusive between 3 and 200 |
| State |
State in which beat is located |
string |
String length: inclusive between 3 and 200 |
| Country |
Country in which beat is located |
string |
String length: inclusive between 3 and 200 |
| TerritoryERPId |
ERPID of the Territory to be assigned to Beat |
string |
String length: inclusive between 3 and 200 |
| BeatAttributeText1 |
Additional Attribute Text 1 of Beat |
string |
Not Mandatory String length: inclusive between 0 and 50 |
| BeatAttributeText2 |
Additional Attribute Text 2 of Beat |
string |
Not Mandatory String length: inclusive between 0 and 50 |
| BeatAttributeText3 |
Additional Attribute Text 3 of Beat |
string |
Not Mandatory String length: inclusive between 0 and 50 |
| BeatAttributeText4 |
Additional Attribute Text 4 of Beat |
string |
Not Mandatory String length: inclusive between 0 and 50 |
| BeatAttributeBoolean1 |
Additional Attribute Boolean 1 of Beat |
boolean |
None. |
| BeatAttributeBoolean2 |
Additional Attribute Boolean 2 of Beat |
boolean |
None. |
| BeatAttributeNumber1 |
Additional Attribute Number 1 of Beat |
decimal number |
Not Mandatory Range: inclusive between -1E+50 and 1E+50 |
| BeatAttributeNumber2 |
Additional Attribute Number 2 of Beat |
decimal number |
Not Mandatory Range: inclusive between -1E+50 and 1E+50 |
| BeatAttributeNumber3 |
Additional Attribute Number 3 of Beat |
decimal number |
Not Mandatory Range: inclusive between -1E+50 and 1E+50 |
| BeatAttributeNumber4 |
Additional Attribute Number 4 of Beat |
decimal number |
Not Mandatory Range: inclusive between -1E+50 and 1E+50 |
| IsActive |
Active status of the beat |
boolean |
None. |
Request Formats
application/json, text/json
[
{
"Beat": "sample string 1",
"BeatErpId": "sample string 2",
"City": "sample string 3",
"State": "sample string 4",
"Country": "sample string 5",
"TerritoryERPId": "sample string 6",
"BeatAttributeText1": "sample string 7",
"BeatAttributeText2": "sample string 8",
"BeatAttributeText3": "sample string 9",
"BeatAttributeText4": "sample string 10",
"BeatAttributeBoolean1": true,
"BeatAttributeBoolean2": true,
"BeatAttributeNumber1": 1.1,
"BeatAttributeNumber2": 1.1,
"BeatAttributeNumber3": 1.1,
"BeatAttributeNumber4": 1.1,
"IsActive": true
},
{
"Beat": "sample string 1",
"BeatErpId": "sample string 2",
"City": "sample string 3",
"State": "sample string 4",
"Country": "sample string 5",
"TerritoryERPId": "sample string 6",
"BeatAttributeText1": "sample string 7",
"BeatAttributeText2": "sample string 8",
"BeatAttributeText3": "sample string 9",
"BeatAttributeText4": "sample string 10",
"BeatAttributeBoolean1": true,
"BeatAttributeBoolean2": true,
"BeatAttributeNumber1": 1.1,
"BeatAttributeNumber2": 1.1,
"BeatAttributeNumber3": 1.1,
"BeatAttributeNumber4": 1.1,
"IsActive": true
}
]
application/xml, text/xml
<ArrayOfBeatUpdate xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ExternalApis.V3.Models">
<BeatUpdate>
<Beat>sample string 1</Beat>
<BeatAttributeBoolean1>true</BeatAttributeBoolean1>
<BeatAttributeBoolean2>true</BeatAttributeBoolean2>
<BeatAttributeNumber1>1.1</BeatAttributeNumber1>
<BeatAttributeNumber2>1.1</BeatAttributeNumber2>
<BeatAttributeNumber3>1.1</BeatAttributeNumber3>
<BeatAttributeNumber4>1.1</BeatAttributeNumber4>
<BeatAttributeText1>sample string 7</BeatAttributeText1>
<BeatAttributeText2>sample string 8</BeatAttributeText2>
<BeatAttributeText3>sample string 9</BeatAttributeText3>
<BeatAttributeText4>sample string 10</BeatAttributeText4>
<BeatErpId>sample string 2</BeatErpId>
<City>sample string 3</City>
<Country>sample string 5</Country>
<IsActive>true</IsActive>
<State>sample string 4</State>
<TerritoryERPId>sample string 6</TerritoryERPId>
</BeatUpdate>
<BeatUpdate>
<Beat>sample string 1</Beat>
<BeatAttributeBoolean1>true</BeatAttributeBoolean1>
<BeatAttributeBoolean2>true</BeatAttributeBoolean2>
<BeatAttributeNumber1>1.1</BeatAttributeNumber1>
<BeatAttributeNumber2>1.1</BeatAttributeNumber2>
<BeatAttributeNumber3>1.1</BeatAttributeNumber3>
<BeatAttributeNumber4>1.1</BeatAttributeNumber4>
<BeatAttributeText1>sample string 7</BeatAttributeText1>
<BeatAttributeText2>sample string 8</BeatAttributeText2>
<BeatAttributeText3>sample string 9</BeatAttributeText3>
<BeatAttributeText4>sample string 10</BeatAttributeText4>
<BeatErpId>sample string 2</BeatErpId>
<City>sample string 3</City>
<Country>sample string 5</Country>
<IsActive>true</IsActive>
<State>sample string 4</State>
<TerritoryERPId>sample string 6</TerritoryERPId>
</BeatUpdate>
</ArrayOfBeatUpdate>
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>