GET api/Help?pageKey={pageKey}

Request Information

URI Parameters

Name	Description	Type	Additional information
pageKey		string	Required

Body Parameters

None.

Response Information

Resource Description

Dictionary of string [key] and PageHelp [value]

Response Formats

application/json, text/json

Sample:

{
  "sample string 1": {
    "Key": "sample string 1",
    "Title": "sample string 2",
    "Abstract": "sample string 3",
    "Sections": [
      {
        "Topic": "sample string 1",
        "Content": "sample string 2"
      },
      {
        "Topic": "sample string 1",
        "Content": "sample string 2"
      }
    ],
    "FieldTooltip": true
  },
  "sample string 2": {
    "Key": "sample string 1",
    "Title": "sample string 2",
    "Abstract": "sample string 3",
    "Sections": [
      {
        "Topic": "sample string 1",
        "Content": "sample string 2"
      },
      {
        "Topic": "sample string 1",
        "Content": "sample string 2"
      }
    ],
    "FieldTooltip": true
  }
}

application/xml, text/xml

Sample:

<ArrayOfKeyValueOfstringPageHelpssiUkFgx xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
  <KeyValueOfstringPageHelpssiUkFgx>
    <Key>sample string 1</Key>
    <Value xmlns:d3p1="http://schemas.datacontract.org/2004/07/ConsoleAPI.Internal.Models.Common">
      <d3p1:Abstract>sample string 3</d3p1:Abstract>
      <d3p1:FieldTooltip>true</d3p1:FieldTooltip>
      <d3p1:Key>sample string 1</d3p1:Key>
      <d3p1:Sections>
        <d3p1:HelpPageSection>
          <d3p1:Content>sample string 2</d3p1:Content>
          <d3p1:Topic>sample string 1</d3p1:Topic>
        </d3p1:HelpPageSection>
        <d3p1:HelpPageSection>
          <d3p1:Content>sample string 2</d3p1:Content>
          <d3p1:Topic>sample string 1</d3p1:Topic>
        </d3p1:HelpPageSection>
      </d3p1:Sections>
      <d3p1:Title>sample string 2</d3p1:Title>
    </Value>
  </KeyValueOfstringPageHelpssiUkFgx>
  <KeyValueOfstringPageHelpssiUkFgx>
    <Key>sample string 2</Key>
    <Value xmlns:d3p1="http://schemas.datacontract.org/2004/07/ConsoleAPI.Internal.Models.Common">
      <d3p1:Abstract>sample string 3</d3p1:Abstract>
      <d3p1:FieldTooltip>true</d3p1:FieldTooltip>
      <d3p1:Key>sample string 1</d3p1:Key>
      <d3p1:Sections>
        <d3p1:HelpPageSection>
          <d3p1:Content>sample string 2</d3p1:Content>
          <d3p1:Topic>sample string 1</d3p1:Topic>
        </d3p1:HelpPageSection>
        <d3p1:HelpPageSection>
          <d3p1:Content>sample string 2</d3p1:Content>
          <d3p1:Topic>sample string 1</d3p1:Topic>
        </d3p1:HelpPageSection>
      </d3p1:Sections>
      <d3p1:Title>sample string 2</d3p1:Title>
    </Value>
  </KeyValueOfstringPageHelpssiUkFgx>
</ArrayOfKeyValueOfstringPageHelpssiUkFgx>