POST api/V3/Outlet/CreateMultipleBeats

Creates Beats with Its Hierarchy

Request Information

URI Parameters

None.

Body Parameters

Collection of BeatWithHierarchy
NameDescriptionTypeAdditional information
Beat

Beat Name

 string

Required

String length: inclusive between 3 and 100
BeatErpId

Erp Id of Beat

 string

String length: inclusive between 0 and 100
Territory

Territory to be assigened to Beat

 string

Required

String length: inclusive between 1 and 200
Region

Region to be assigned to Territory

 string

Required

String length: inclusive between 1 and 200
Zone

Zone to be assigened to Territory of Beat

 string

Required

String length: inclusive between 1 and 100
BeatGrade

Possible Values - 1. Urban 2 SemiUrban 3. Metro 4. NonMetro 5. Rural

 BeatGrade

Not Mandatory
Beat_AttributeText1

Additional Attribute of Beat

 string

Not Mandatory

String length: inclusive between 0 and 50
Beat_AttributeText2

Additional Attribute of Beat

 string

Not Mandatory

String length: inclusive between 0 and 50
Beat_AttributeText3

Additional Attribute of Beat

 string

Not Mandatory

String length: inclusive between 0 and 50
Beat_AttributeText4

Additional Attribute of Beat

 string

Not Mandatory

String length: inclusive between 0 and 50
Beat_AttributeBoolean1

Additional Attribute of Beat

 boolean

None.
Beat_AttributeBoolean2

Additional Attribute of Beat

 boolean

None.
Beat_AttributeNumber1

Additional Attribute of Beat

 decimal number

Not Mandatory

Range: inclusive between -1E+50 and 1E+50
Beat_AttributeNumber2

Additional Attribute of Beat

 decimal number

Not Mandatory

Range: inclusive between -1E+50 and 1E+50
Beat_AttributeNumber3

Additional Attribute of Beat

 decimal number

Not Mandatory

Range: inclusive between -1E+50 and 1E+50
Beat_AttributeNumber4

Additional Attribute of Beat

 decimal number

Not Mandatory

Range: inclusive between -1E+50 and 1E+50

Request Formats

application/json, text/json

Sample: 
[
  {
    "Beat": "sample string 1",
    "BeatErpId": "sample string 2",
    "Territory": "sample string 3",
    "Region": "sample string 4",
    "Zone": "sample string 5",
    "BeatGrade": "None",
    "Beat_AttributeText1": "sample string 6",
    "Beat_AttributeText2": "sample string 7",
    "Beat_AttributeText3": "sample string 8",
    "Beat_AttributeText4": "sample string 9",
    "Beat_AttributeBoolean1": true,
    "Beat_AttributeBoolean2": true,
    "Beat_AttributeNumber1": 1.1,
    "Beat_AttributeNumber2": 1.1,
    "Beat_AttributeNumber3": 1.1,
    "Beat_AttributeNumber4": 1.1
  },
  {
    "Beat": "sample string 1",
    "BeatErpId": "sample string 2",
    "Territory": "sample string 3",
    "Region": "sample string 4",
    "Zone": "sample string 5",
    "BeatGrade": "None",
    "Beat_AttributeText1": "sample string 6",
    "Beat_AttributeText2": "sample string 7",
    "Beat_AttributeText3": "sample string 8",
    "Beat_AttributeText4": "sample string 9",
    "Beat_AttributeBoolean1": true,
    "Beat_AttributeBoolean2": true,
    "Beat_AttributeNumber1": 1.1,
    "Beat_AttributeNumber2": 1.1,
    "Beat_AttributeNumber3": 1.1,
    "Beat_AttributeNumber4": 1.1
  }
]

application/xml, text/xml

Sample: 
<ArrayOfBeatWithHierarchy xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ExternalApis.V3.Models">
  <BeatWithHierarchy>
    <Beat>sample string 1</Beat>
    <BeatErpId>sample string 2</BeatErpId>
    <BeatGrade>None</BeatGrade>
    <Beat_AttributeBoolean1>true</Beat_AttributeBoolean1>
    <Beat_AttributeBoolean2>true</Beat_AttributeBoolean2>
    <Beat_AttributeNumber1>1.1</Beat_AttributeNumber1>
    <Beat_AttributeNumber2>1.1</Beat_AttributeNumber2>
    <Beat_AttributeNumber3>1.1</Beat_AttributeNumber3>
    <Beat_AttributeNumber4>1.1</Beat_AttributeNumber4>
    <Beat_AttributeText1>sample string 6</Beat_AttributeText1>
    <Beat_AttributeText2>sample string 7</Beat_AttributeText2>
    <Beat_AttributeText3>sample string 8</Beat_AttributeText3>
    <Beat_AttributeText4>sample string 9</Beat_AttributeText4>
    <Region>sample string 4</Region>
    <Territory>sample string 3</Territory>
    <Zone>sample string 5</Zone>
  </BeatWithHierarchy>
  <BeatWithHierarchy>
    <Beat>sample string 1</Beat>
    <BeatErpId>sample string 2</BeatErpId>
    <BeatGrade>None</BeatGrade>
    <Beat_AttributeBoolean1>true</Beat_AttributeBoolean1>
    <Beat_AttributeBoolean2>true</Beat_AttributeBoolean2>
    <Beat_AttributeNumber1>1.1</Beat_AttributeNumber1>
    <Beat_AttributeNumber2>1.1</Beat_AttributeNumber2>
    <Beat_AttributeNumber3>1.1</Beat_AttributeNumber3>
    <Beat_AttributeNumber4>1.1</Beat_AttributeNumber4>
    <Beat_AttributeText1>sample string 6</Beat_AttributeText1>
    <Beat_AttributeText2>sample string 7</Beat_AttributeText2>
    <Beat_AttributeText3>sample string 8</Beat_AttributeText3>
    <Beat_AttributeText4>sample string 9</Beat_AttributeText4>
    <Region>sample string 4</Region>
    <Territory>sample string 3</Territory>
    <Zone>sample string 5</Zone>
  </BeatWithHierarchy>
</ArrayOfBeatWithHierarchy>

Response Information

Resource Description

ApiResponse
NameDescriptionTypeAdditional 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

Sample: 
{
  "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

Sample: 
<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>