GET api/subjects/{id}

Requires authentication. Get an individual subject by GUID. If successful returns "200 OK", with the body of the response containing a representation of the subject. 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

Name	Description	Type	Additional information
id		globally unique identifier	Required

Body Parameters

None.

Response Information

Resource Description

SubjectRepresentation

Name	Description	Type	Additional information
Id	Unique identifier - same as in CRM	globally unique identifier	None.
Name	Login for this system	string	None.
Links		Collection of Link	None.

Response Formats

application/json, text/json

Sample:

{
  "Id": "72306c9a-11a8-4b4b-a8c0-50eb049cfdfb",
  "Name": "sample string 2",
  "_links": [
    {
      "Rel": "self",
      "Href": "~/subjects/72306c9a-11a8-4b4b-a8c0-50eb049cfdfb",
      "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:

<SubjectRepresentation 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">~/subjects/72306c9a-11a8-4b4b-a8c0-50eb049cfdfb</Href>
  <LinkName xmlns="http://schemas.datacontract.org/2004/07/WebApi.Hal">sample string 5</LinkName>
  <Links xmlns="http://schemas.datacontract.org/2004/07/WebApi.Hal">
    <Link>
      <Href>~/subjects/72306c9a-11a8-4b4b-a8c0-50eb049cfdfb</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 3</Rel>
  <Id>72306c9a-11a8-4b4b-a8c0-50eb049cfdfb</Id>
  <Name>sample string 2</Name>
</SubjectRepresentation>

application/hal+json

Sample:

{
  "Id": "72306c9a-11a8-4b4b-a8c0-50eb049cfdfb",
  "Name": "sample string 2",
  "_links": {
    "self": {
      "href": "/subjects/72306c9a-11a8-4b4b-a8c0-50eb049cfdfb"
    },
    "sample string 1": {
      "href": "sample string 2",
      "title": "sample string 3"
    }
  }
}

application/hal+xml

Sample:

<resource rel="sample string 3" href="~/subjects/72306c9a-11a8-4b4b-a8c0-50eb049cfdfb" name="sample string 5">
  <link rel="sample string 1" href="sample string 2" />
  <Id>72306c9a-11a8-4b4b-a8c0-50eb049cfdfb</Id>
  <Name>sample string 2</Name>
</resource>