POST api/v7/GroupDetails

Create group detail information.

Tables Impacted

GroupProduct, GroupHierarchy, GroupAttribute

Request Information

URI Parameters

None.

Body Parameters

Group detail information update in db

Group Detail
NameDescriptionTypeRequired?Additional information
groupCode *

Group code used to uniquely identify the group

 string

Yes

String length: between 1 and 24, inclusive
productList

The list of product codes for a product based group.

 Collection of Group Product Detail

No

None.
hierarchyList

The list of hierarchy codes for a hierarchy based group.

 Collection of Group Hierarchy Detail

No

None.
attributeList

The list of attributes for an attribute based group.

 Collection of Group Attribute Detail

No

None.
customerAuditDate

Last modified audit information

 date

No

None.

Request Formats

application/json, text/json

Sample: 
{
  "groupCode": "sample string 1",
  "productList": [
    {
      "productCode": "sample string 1",
      "suggest": true,
      "quantity": 1,
      "order": 1,
      "customerAuditDate": "2018-01-01T00:00:00"
    },
    {
      "productCode": "sample string 1",
      "suggest": true,
      "quantity": 1,
      "order": 1,
      "customerAuditDate": "2018-01-01T00:00:00"
    }
  ],
  "hierarchyList": [
    {
      "hierarchyCode": "sample string 1",
      "suggest": true,
      "quantity": 1,
      "customerAuditDate": "2018-01-01T00:00:00"
    },
    {
      "hierarchyCode": "sample string 1",
      "suggest": true,
      "quantity": 1,
      "customerAuditDate": "2018-01-01T00:00:00"
    }
  ],
  "attributeList": [
    {
      "name": "sample string 1",
      "value": "sample string 2",
      "customerAuditDate": "2018-01-01T00:00:00"
    },
    {
      "name": "sample string 1",
      "value": "sample string 2",
      "customerAuditDate": "2018-01-01T00:00:00"
    }
  ],
  "customerAuditDate": "2018-01-01T00:00:00"
}

application/xml, text/xml

Sample: 
<GroupDetail xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <groupCode>sample string 1</groupCode>
  <productList>
    <GroupProductDetail>
      <productCode>sample string 1</productCode>
      <suggest>true</suggest>
      <quantity>1</quantity>
      <order>1</order>
      <customerAuditDate>2018-01-01T00:00:00</customerAuditDate>
    </GroupProductDetail>
    <GroupProductDetail>
      <productCode>sample string 1</productCode>
      <suggest>true</suggest>
      <quantity>1</quantity>
      <order>1</order>
      <customerAuditDate>2018-01-01T00:00:00</customerAuditDate>
    </GroupProductDetail>
  </productList>
  <hierarchyList>
    <GroupHierarchyDetail>
      <hierarchyCode>sample string 1</hierarchyCode>
      <suggest>true</suggest>
      <quantity>1</quantity>
      <customerAuditDate>2018-01-01T00:00:00</customerAuditDate>
    </GroupHierarchyDetail>
    <GroupHierarchyDetail>
      <hierarchyCode>sample string 1</hierarchyCode>
      <suggest>true</suggest>
      <quantity>1</quantity>
      <customerAuditDate>2018-01-01T00:00:00</customerAuditDate>
    </GroupHierarchyDetail>
  </hierarchyList>
  <attributeList>
    <GroupAttributeDetail>
      <name>sample string 1</name>
      <value>sample string 2</value>
      <customerAuditDate>2018-01-01T00:00:00</customerAuditDate>
    </GroupAttributeDetail>
    <GroupAttributeDetail>
      <name>sample string 1</name>
      <value>sample string 2</value>
      <customerAuditDate>2018-01-01T00:00:00</customerAuditDate>
    </GroupAttributeDetail>
  </attributeList>
  <customerAuditDate>2018-01-01T00:00:00</customerAuditDate>
</GroupDetail>

Response Information

Resource Description

Returns a HTTPResponse Message stating the success/failure of API Action

HttpResponseMessage
NameDescriptionType
Version

Version
Content

HttpContent
StatusCode

HttpStatusCode
ReasonPhrase

string
Headers

Collection of Object
RequestMessage

HttpRequestMessage
IsSuccessStatusCode

boolean