POST api/V3/Incentives/NewOutletMonthWise

(Max 2000 records can be updated in one request)

Request Information

URI Parameters

None.

Body Parameters

Date, Outlet and Style for the Sale

Collection of V3.NewOutletMonthWise
NameDescriptionTypeAdditional information
OutletErpId

Erp id Of the Outlet

 string

None.
Month

JC Month number i.e., 8

 integer

None.
Year

JC Year i.e., 2019

 integer

None.

Request Formats

application/json, text/json

Sample: 
[
  {
    "OutletErpId": "sample string 1",
    "Month": 2,
    "Year": 3
  },
  {
    "OutletErpId": "sample string 1",
    "Month": 2,
    "Year": 3
  }
]

application/xml, text/xml

Sample: 
<ArrayOfNewOutletMonthWise xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ExternalApis.Models.V3">
  <NewOutletMonthWise>
    <Month>2</Month>
    <OutletErpId>sample string 1</OutletErpId>
    <Year>3</Year>
  </NewOutletMonthWise>
  <NewOutletMonthWise>
    <Month>2</Month>
    <OutletErpId>sample string 1</OutletErpId>
    <Year>3</Year>
  </NewOutletMonthWise>
</ArrayOfNewOutletMonthWise>

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>