GET api/roles/{id}

Requires authentication. Get details of one role from the backend system

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

Unique identifier of role (guid)

globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

RoleRepresentation

RoleRepresentation
NameDescriptionTypeAdditional information
Id

Unique identifier of Role

globally unique identifier

None.

Name

System name of Role

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Id": "4e96b974-d0b9-4e2a-be3a-f52b038c345b",
  "Name": "sample string 2",
  "_links": [
    {
      "Rel": "self",
      "Href": "~/roles/4e96b974-d0b9-4e2a-be3a-f52b038c345b",
      "Title": null,
      "IsTemplated": false
    },
    {
      "Rel": "sample string 1",
      "Href": "sample string 2",
      "Title": "sample string 3",
      "IsTemplated": false
    },
    {
      "Rel": "sample string 1",
      "Href": "sample string 2",
      "Title": "sample string 3",
      "IsTemplated": false
    }
  ],
  "_embedded": null
}

application/hal+json

Sample:
{
  "Id": "4e96b974-d0b9-4e2a-be3a-f52b038c345b",
  "Name": "sample string 2",
  "_links": {
    "self": {
      "href": "/roles/4e96b974-d0b9-4e2a-be3a-f52b038c345b"
    },
    "sample string 1": {
      "href": "sample string 2",
      "title": "sample string 3"
    }
  }
}

application/hal+xml

Sample:
<resource rel="sample string 4" href="~/roles/4e96b974-d0b9-4e2a-be3a-f52b038c345b" name="sample string 6">
  <link rel="sample string 1" href="sample string 2" />
  <Id>4e96b974-d0b9-4e2a-be3a-f52b038c345b</Id>
  <Name>sample string 2</Name>
  <Description>sample string 3</Description>
</resource>