PUT api/leadinout/{id}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id | integer |
Required |
Body Parameters
LeadInOut| Name | Description | Type | Additional information |
|---|---|---|---|
| ID |
Sequential ID |
integer |
None. |
| SummaryID | integer |
None. |
|
| InStorePrefixCode | string |
None. |
|
| MinPeriodInDays | integer |
None. |
|
| MaxPeriodInDays | integer |
None. |
|
| PeriodType | string |
None. |
|
| InStoreStartOption | InStoreStartOptions |
None. |
|
| InStoreEndOption | InStoreEndOptions |
None. |
|
| OverrideHostPromotionSell | boolean |
None. |
|
| RoundSell | boolean |
None. |
|
| IncludeComplianceIndicator |
Include lines that have a compliance indicator set |
boolean |
None. |
| Enabled | boolean |
None. |
|
| ExcludeAdvertised | boolean |
None. |
|
| ExcludeNonAdvertised | boolean |
None. |
|
| ExcludePromotionalProducts | boolean |
None. |
|
| EnsurePriceNotLowerThanNormalPromotion | boolean |
None. |
|
| EnableCampaignWeekStarts | boolean |
None. |
|
| EnableCampaignWeekEnds | boolean |
None. |
|
| DepartmentTrees | Collection of DepartmentTree |
None. |
|
| PromoTypeGuids | Collection of globally unique identifier |
None. |
Request Formats
application/json, text/json
Sample:
{
"id": 1,
"summaryID": 2,
"inStorePrefixCode": "sample string 3",
"minPeriodInDays": 4,
"maxPeriodInDays": 5,
"periodType": "sample string 6",
"inStoreStartOption": 7,
"inStoreEndOption": 8,
"overrideHostPromotionSell": true,
"roundSell": true,
"includeComplianceIndicator": true,
"enabled": true,
"excludeAdvertised": true,
"excludeNonAdvertised": true,
"excludePromotionalProducts": true,
"ensurePriceNotLowerThanNormalPromotion": true,
"enableCampaignWeekStarts": true,
"enableCampaignWeekEnds": true,
"departmentTrees": [
{
"$id": "2",
"code": "sample string 1",
"subDeptCodes": [
"sample string 1",
"sample string 2"
]
},
{
"$ref": "2"
}
],
"promoTypeGuids": [
"68135afe-aa01-4196-a6d1-e93e12fd0efa",
"4579aad3-a7e2-4cb4-bf96-fcb12285ef25"
]
}
application/xml, text/xml
Sample:
<LeadInOut xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://gapsolutions.com.au/schema/ezimanager">
<DepartmentTrees xmlns:d2p1="http://schemas.datacontract.org/2004/07/EziManager.Models.EMC.Hosts">
<d2p1:DepartmentTree>
<d2p1:Code>sample string 1</d2p1:Code>
<d2p1:SubDeptCodes xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:string>sample string 1</d4p1:string>
<d4p1:string>sample string 2</d4p1:string>
</d2p1:SubDeptCodes>
</d2p1:DepartmentTree>
<d2p1:DepartmentTree>
<d2p1:Code>sample string 1</d2p1:Code>
<d2p1:SubDeptCodes xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:string>sample string 1</d4p1:string>
<d4p1:string>sample string 2</d4p1:string>
</d2p1:SubDeptCodes>
</d2p1:DepartmentTree>
</DepartmentTrees>
<EnableCampaignWeekEnds>true</EnableCampaignWeekEnds>
<EnableCampaignWeekStarts>true</EnableCampaignWeekStarts>
<Enabled>true</Enabled>
<EnsurePriceNotLowerThanNormalPromotion>true</EnsurePriceNotLowerThanNormalPromotion>
<ExcludeAdvertised>true</ExcludeAdvertised>
<ExcludeNonAdvertised>true</ExcludeNonAdvertised>
<ExcludePromotionalProducts>true</ExcludePromotionalProducts>
<ID>1</ID>
<InStoreEndOption>8</InStoreEndOption>
<InStorePrefixCode>sample string 3</InStorePrefixCode>
<InStoreStartOption>7</InStoreStartOption>
<IncludeComplianceIndicator>true</IncludeComplianceIndicator>
<MaxPeriodInDays>5</MaxPeriodInDays>
<MinPeriodInDays>4</MinPeriodInDays>
<OverrideHostPromotionSell>true</OverrideHostPromotionSell>
<PeriodType>sample string 6</PeriodType>
<PromoTypeGuids xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>68135afe-aa01-4196-a6d1-e93e12fd0efa</d2p1:guid>
<d2p1:guid>4579aad3-a7e2-4cb4-bf96-fcb12285ef25</d2p1:guid>
</PromoTypeGuids>
<RoundSell>true</RoundSell>
<SummaryID>2</SummaryID>
</LeadInOut>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
None.