POST api/V3/Outlet/CreateRegionsWithZone

Creates Region with Zone

Request Information

URI Parameters

None.

Body Parameters

Collection of V3.RegionWithZone
NameDescriptionTypeAdditional information
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:
[
  {
    "Region": "sample string 1",
    "Zone": "sample string 2"
  },
  {
    "Region": "sample string 1",
    "Zone": "sample string 2"
  }
]

application/xml, text/xml

Sample:
<ArrayOfRegionWithZone xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ExternalApis.V3.Models">
  <RegionWithZone>
    <Region>sample string 1</Region>
    <Zone>sample string 2</Zone>
  </RegionWithZone>
  <RegionWithZone>
    <Region>sample string 1</Region>
    <Zone>sample string 2</Zone>
  </RegionWithZone>
</ArrayOfRegionWithZone>

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

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>