POST api/V3/Geography/UpdateGeographies

Update Geographies based on Geography ERPId

Request Information

URI Parameters

None.

Body Parameters

Collection of V3.GeographyUpdate
NameDescriptionTypeAdditional information
GeoEntityERPId

ERP ID of the Entity (Territory, Region, Zone, Level 5, Level 6, Level 7)

 string

Required
GeoEntityName

Name of the Entity to be updated

 string

None.
GeoEntityLevel

Geo hierarchy level of the Entity ("Territory, "Region", "Zone", "Level 5" , "Level 6", "Level7") (Nomenclature applied level)

 string

Required
ParentERPId

ERP ID of the Parent Entity to be mapped (Region, Zone, Level 5, Level 6, Level 7)

 string

None.

Request Formats

application/json, text/json

Sample: 
[
  {
    "GeoEntityERPId": "sample string 1",
    "GeoEntityName": "sample string 2",
    "GeoEntityLevel": "sample string 3",
    "ParentERPId": "sample string 4"
  },
  {
    "GeoEntityERPId": "sample string 1",
    "GeoEntityName": "sample string 2",
    "GeoEntityLevel": "sample string 3",
    "ParentERPId": "sample string 4"
  }
]

application/xml, text/xml

Sample: 
<ArrayOfGeographyUpdate xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ExternalApis.V3.Models">
  <GeographyUpdate>
    <GeoEntityERPId>sample string 1</GeoEntityERPId>
    <GeoEntityLevel>sample string 3</GeoEntityLevel>
    <GeoEntityName>sample string 2</GeoEntityName>
    <ParentERPId>sample string 4</ParentERPId>
  </GeographyUpdate>
  <GeographyUpdate>
    <GeoEntityERPId>sample string 1</GeoEntityERPId>
    <GeoEntityLevel>sample string 3</GeoEntityLevel>
    <GeoEntityName>sample string 2</GeoEntityName>
    <ParentERPId>sample string 4</ParentERPId>
  </GeographyUpdate>
</ArrayOfGeographyUpdate>

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>