GET api/v7/Groups/{groupCode}

Returns a group record from the database.

Request Information

URI Parameters

NameDescriptionTypeRequired?Additional information
groupCode *

Unique code of the group record

 string

Yes

None.

Body Parameters

None.

Response Information

Resource Description

A response containing an acknowledgment and the requested group information.

Group Data
NameDescriptionType
groupCode

The unique code to refer to the product group

 string
groupName

The name/description for the group

 string
groupType

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

 string
autoSuggested

autoSuggested

 boolean
groupDescriptions

Set of culture-specific descriptions

 Collection of General Description
customerAuditDate

Last modified audit information

 date

Response 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>