GET configuration/client/detail

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Name	Type	Additional information
Name	string	None.
ClientNumber	string	None.
ClientId	integer	None.
Status	byte	None.
Links	Collection of Link	None.

Response Formats

application/json, text/json

Sample:

{
  "Name": "sample string 1",
  "ClientNumber": "sample string 2",
  "ClientId": 3,
  "Status": 64,
  "_links": [
    {
      "$id": "2",
      "Curie": null,
      "Rel": "sample string 1",
      "Href": "sample string 2",
      "Title": "sample string 3",
      "Type": "sample string 4",
      "Deprecation": "sample string 5",
      "Name": "sample string 6",
      "Profile": "sample string 7",
      "HrefLang": "sample string 8",
      "IsTemplated": false
    },
    {
      "$ref": "2"
    }
  ],
  "_embedded": null
}

application/xml, text/xml

Sample:

<ClientDetailHalRepresentation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ITAGroup.EnterpriseServices.Domain">
  <Href xmlns="http://schemas.datacontract.org/2004/07/WebApi.Hal">~/client/3</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>
      <Deprecation>sample string 5</Deprecation>
      <Href>sample string 2</Href>
      <HrefLang>sample string 8</HrefLang>
      <Name>sample string 6</Name>
      <Profile>sample string 7</Profile>
      <Rel>sample string 1</Rel>
      <Title>sample string 3</Title>
      <Type>sample string 4</Type>
    </Link>
    <Link>
      <Deprecation>sample string 5</Deprecation>
      <Href>sample string 2</Href>
      <HrefLang>sample string 8</HrefLang>
      <Name>sample string 6</Name>
      <Profile>sample string 7</Profile>
      <Rel>sample string 1</Rel>
      <Title>sample string 3</Title>
      <Type>sample string 4</Type>
    </Link>
  </Links>
  <Rel xmlns="http://schemas.datacontract.org/2004/07/WebApi.Hal">clients</Rel>
  <ClientId>3</ClientId>
  <ClientNumber>sample string 2</ClientNumber>
  <Name>sample string 1</Name>
  <Status>64</Status>
</ClientDetailHalRepresentation>

application/hal+json, application/hal+json.vnd.es.basic

Sample:

{
  "Name": "sample string 1",
  "ClientNumber": "sample string 2",
  "ClientId": 3,
  "Status": 64,
  "_links": {
    "self": {
      "href": "/client/3"
    },
    "sample string 1": {
      "href": "sample string 2",
      "title": "sample string 3",
      "type": "sample string 4",
      "deprecation": "sample string 5",
      "name": "sample string 6",
      "profile": "sample string 7",
      "hreflang": "sample string 8"
    }
  }
}

application/hal+xml

Sample:

<resource rel="clients" href="~/client/3" name="sample string 5">
  <link rel="sample string 1" href="sample string 2" />
  <Name>sample string 1</Name>
  <ClientNumber>sample string 2</ClientNumber>
  <ClientId>3</ClientId>
  <Status>64</Status>
</resource>