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 3 and 200
Region

Region to be assigned to Territory

 string

Required

String length: inclusive between 3 and 200
Zone

Zone to be assigened to Territory of Beat

 string

Required

String length: inclusive between 3 and 100

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"
  },
  {
    "Beat": "sample string 1",
    "BeatErpId": "sample string 2",
    "Territory": "sample string 3",
    "Region": "sample string 4",
    "Zone": "sample string 5"
  }
]

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>
    <Region>sample string 4</Region>
    <Zone>sample string 5</Zone>
    <Beat>sample string 1</Beat>
    <BeatErpId>sample string 2</BeatErpId>
    <Territory>sample string 3</Territory>
  </BeatWithHierarchy>
  <BeatWithHierarchy>
    <Region>sample string 4</Region>
    <Zone>sample string 5</Zone>
    <Beat>sample string 1</Beat>
    <BeatErpId>sample string 2</BeatErpId>
    <Territory>sample string 3</Territory>
  </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>