GET api/responsibilities/{id}

Requires authentication. Get an individual responsibility by GUID. If successful returns "200 OK", with the body of the response containing a representation of the responsibility. If not found, returns "404 Not Found" If CRM operations fail for an un-recoverable reason, the service returns "502 Bad Gateway" Any other server-side errors return "500 Internal Server Error"

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

ResponsibilityRepresentation

ResponsibilityRepresentation
NameDescriptionTypeAdditional information
Id

Unique identifier - same as in CRM

globally unique identifier

None.

Name

Name of the responsibility

string

None.

TreeLevel1

First column of grouping

string

None.

TreeLevel2

Second column of grouping

string

None.

Links

Collection of Link

None.

Response Formats

application/json, text/json

Sample:
{
  "Id": "cf71cab6-1019-41b9-afd9-fa11cb132c0e",
  "Name": "sample string 2",
  "TreeLevel1": "sample string 3",
  "TreeLevel2": "sample string 4",
  "_links": [
    {
      "Rel": "self",
      "Href": "~/responsibilities/cf71cab6-1019-41b9-afd9-fa11cb132c0e",
      "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/xml, text/xml

Sample:
<ResponsibilityRepresentation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SSAT.WebServices.WebApp.Representations.Version1">
  <Href xmlns="http://schemas.datacontract.org/2004/07/WebApi.Hal">~/responsibilities/cf71cab6-1019-41b9-afd9-fa11cb132c0e</Href>
  <LinkName xmlns="http://schemas.datacontract.org/2004/07/WebApi.Hal">sample string 7</LinkName>
  <Links xmlns="http://schemas.datacontract.org/2004/07/WebApi.Hal">
    <Link>
      <Href>~/responsibilities/cf71cab6-1019-41b9-afd9-fa11cb132c0e</Href>
      <Rel>self</Rel>
      <Title i:nil="true" />
    </Link>
    <Link>
      <Href>sample string 2</Href>
      <Rel>sample string 1</Rel>
      <Title>sample string 3</Title>
    </Link>
    <Link>
      <Href>sample string 2</Href>
      <Rel>sample string 1</Rel>
      <Title>sample string 3</Title>
    </Link>
  </Links>
  <Rel xmlns="http://schemas.datacontract.org/2004/07/WebApi.Hal">sample string 5</Rel>
  <Id>cf71cab6-1019-41b9-afd9-fa11cb132c0e</Id>
  <Name>sample string 2</Name>
  <TreeLevel1>sample string 3</TreeLevel1>
  <TreeLevel2>sample string 4</TreeLevel2>
</ResponsibilityRepresentation>

application/hal+json

Sample:
{
  "Id": "cf71cab6-1019-41b9-afd9-fa11cb132c0e",
  "Name": "sample string 2",
  "TreeLevel1": "sample string 3",
  "TreeLevel2": "sample string 4",
  "_links": {
    "self": {
      "href": "/responsibilities/cf71cab6-1019-41b9-afd9-fa11cb132c0e"
    },
    "sample string 1": {
      "href": "sample string 2",
      "title": "sample string 3"
    }
  }
}

application/hal+xml

Sample:
<resource rel="sample string 5" href="~/responsibilities/cf71cab6-1019-41b9-afd9-fa11cb132c0e" name="sample string 7">
  <link rel="sample string 1" href="sample string 2" />
  <Id>cf71cab6-1019-41b9-afd9-fa11cb132c0e</Id>
  <Name>sample string 2</Name>
  <TreeLevel1>sample string 3</TreeLevel1>
  <TreeLevel2>sample string 4</TreeLevel2>
</resource>