POST api/v7/Groups

Accepts group information from a client.

Tables Impacted

Group, GroupDesc, GroupType

Request Information

URI Parameters

None.

Body Parameters

Group information to be inserted in database

Group Data
NameDescriptionTypeRequired?Additional information
groupCode *

The unique code to refer to the product group

 string

Yes

String length: between 1 and 24, inclusive
groupName

The name/description for the group

 string

No

String length: between 1 and 24, inclusive
groupType *

The group type code of the group, e.g. "AMS_Group" or "LikeCode"

 string

Yes

String length: between 1 and 24, inclusive
autoSuggested

autoSuggested

 boolean

No

None.
groupDescriptions

Set of culture-specific descriptions

 Collection of General Description

No

None.
customerAuditDate

Last modified audit information

 date

No

None.

Request Formats

application/json, text/json

Sample: 
{
  "groupCode": "sample string 1",
  "groupName": "sample string 2",
  "groupType": "sample string 3",
  "autoSuggested": true,
  "groupDescriptions": [
    {
      "culture": "sample string 1",
      "description": "sample string 2",
      "customerAuditDate": "2018-01-01T00:00:00"
    },
    {
      "culture": "sample string 1",
      "description": "sample string 2",
      "customerAuditDate": "2018-01-01T00:00:00"
    }
  ],
  "customerAuditDate": "2018-01-01T00:00:00"
}

application/xml, text/xml

Sample: 
<Group xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <groupCode>sample string 1</groupCode>
  <groupName>sample string 2</groupName>
  <groupType>sample string 3</groupType>
  <autoSuggested>true</autoSuggested>
  <groupDescriptions>
    <Description>
      <culture>sample string 1</culture>
      <description>sample string 2</description>
      <customerAuditDate>2018-01-01T00:00:00</customerAuditDate>
    </Description>
    <Description>
      <culture>sample string 1</culture>
      <description>sample string 2</description>
      <customerAuditDate>2018-01-01T00:00:00</customerAuditDate>
    </Description>
  </groupDescriptions>
  <customerAuditDate>2018-01-01T00:00:00</customerAuditDate>
</Group>

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