GET apioauth/matrixv2/groups/{groupId}

Get a group

Request Information

URI Parameters

NameDescriptionTypeAdditional information
groupId

The id of the group to query

unsigned integer

Required

Body Parameters

None.

Response Information

Resource Description

A GroupResponse

V2GroupResponse
NameDescriptionTypeAdditional information
GroupId

The id of the group

integer

None.

ParentGroupId

The id of the groups parent group

integer

None.

Name

The name of the group

string

None.

Links

Any links to other entities

Collection of Link

None.

Dot

The dot number

string

None.

Response Formats

application/json, text/json

Sample:
{
  "GroupId": 1,
  "ParentGroupId": 2,
  "Name": "sample string 3",
  "Links": [
    {
      "Href": "sample string 1",
      "Rel": "sample string 2"
    },
    {
      "Href": "sample string 1",
      "Rel": "sample string 2"
    }
  ],
  "Dot": "sample string 4"
}

application/xml, text/xml

Sample:
<GroupResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <GroupId>1</GroupId>
  <ParentGroupId>2</ParentGroupId>
  <Name>sample string 3</Name>
  <Links>
    <Link>
      <Href>sample string 1</Href>
      <Rel>sample string 2</Rel>
    </Link>
    <Link>
      <Href>sample string 1</Href>
      <Rel>sample string 2</Rel>
    </Link>
  </Links>
  <Dot>sample string 4</Dot>
</GroupResponse>