GET v1/onlinehelp?mainProduct={mainProduct}&subProduct={subProduct}

Gets the online help topics.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
mainProduct

The main product.

integer

Required

subProduct

The sub product.

string

Default value is

Body Parameters

None.

Response Information

Resource Description

HelpTopicResults
NameDescriptionTypeAdditional information
HelpTopics

Collection of HelpTopic

None.

Errors

Collection of Exception

None.

IsSuccess

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "HelpTopics": [
    {
      "Category": "sample string 1",
      "ItemKey": "sample string 2",
      "ItemValue": "sample string 3",
      "MainProduct": 4,
      "Id": "ae9406f4-bf84-4074-ad34-98bed661ef01",
      "SubProduct": "sample string 6"
    },
    {
      "Category": "sample string 1",
      "ItemKey": "sample string 2",
      "ItemValue": "sample string 3",
      "MainProduct": 4,
      "Id": "ae9406f4-bf84-4074-ad34-98bed661ef01",
      "SubProduct": "sample string 6"
    }
  ],
  "Errors": [
    {
      "ClassName": "System.Exception",
      "Message": null,
      "Data": null,
      "InnerException": null,
      "HelpURL": "sample string 1",
      "StackTraceString": null,
      "RemoteStackTraceString": null,
      "RemoteStackIndex": 0,
      "ExceptionMethod": null,
      "HResult": 3,
      "Source": "sample string 2",
      "WatsonBuckets": null
    },
    {
      "ClassName": "System.Exception",
      "Message": null,
      "Data": null,
      "InnerException": null,
      "HelpURL": "sample string 1",
      "StackTraceString": null,
      "RemoteStackTraceString": null,
      "RemoteStackIndex": 0,
      "ExceptionMethod": null,
      "HResult": 3,
      "Source": "sample string 2",
      "WatsonBuckets": null
    }
  ],
  "IsSuccess": true
}

application/xml, text/xml

Sample:
<HelpTopicResults xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OpenTech.IssnWebApi.Web.Models">
  <Errors xmlns:d2p1="http://schemas.datacontract.org/2004/07/System" xmlns="http://schemas.datacontract.org/2004/07/OpenTech.IssnWebApi.Web.Models.BindingModels">
    <d2p1:Exception>
      <ClassName xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string" xmlns="">System.Exception</ClassName>
      <Message i:nil="true" xmlns="" />
      <Data i:nil="true" xmlns="" />
      <InnerException i:nil="true" xmlns="" />
      <HelpURL xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string" xmlns="">sample string 1</HelpURL>
      <StackTraceString i:nil="true" xmlns="" />
      <RemoteStackTraceString i:nil="true" xmlns="" />
      <RemoteStackIndex xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:int" xmlns="">0</RemoteStackIndex>
      <ExceptionMethod i:nil="true" xmlns="" />
      <HResult xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:int" xmlns="">3</HResult>
      <Source xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string" xmlns="">sample string 2</Source>
      <WatsonBuckets i:nil="true" xmlns="" />
    </d2p1:Exception>
    <d2p1:Exception>
      <ClassName xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string" xmlns="">System.Exception</ClassName>
      <Message i:nil="true" xmlns="" />
      <Data i:nil="true" xmlns="" />
      <InnerException i:nil="true" xmlns="" />
      <HelpURL xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string" xmlns="">sample string 1</HelpURL>
      <StackTraceString i:nil="true" xmlns="" />
      <RemoteStackTraceString i:nil="true" xmlns="" />
      <RemoteStackIndex xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:int" xmlns="">0</RemoteStackIndex>
      <ExceptionMethod i:nil="true" xmlns="" />
      <HResult xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:int" xmlns="">3</HResult>
      <Source xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string" xmlns="">sample string 2</Source>
      <WatsonBuckets i:nil="true" xmlns="" />
    </d2p1:Exception>
  </Errors>
  <IsSuccess xmlns="http://schemas.datacontract.org/2004/07/OpenTech.IssnWebApi.Web.Models.BindingModels">true</IsSuccess>
  <HelpTopics>
    <HelpTopic>
      <Category>sample string 1</Category>
      <Id>ae9406f4-bf84-4074-ad34-98bed661ef01</Id>
      <ItemKey>sample string 2</ItemKey>
      <ItemValue>sample string 3</ItemValue>
      <MainProduct>4</MainProduct>
      <SubProduct>sample string 6</SubProduct>
    </HelpTopic>
    <HelpTopic>
      <Category>sample string 1</Category>
      <Id>ae9406f4-bf84-4074-ad34-98bed661ef01</Id>
      <ItemKey>sample string 2</ItemKey>
      <ItemValue>sample string 3</ItemValue>
      <MainProduct>4</MainProduct>
      <SubProduct>sample string 6</SubProduct>
    </HelpTopic>
  </HelpTopics>
</HelpTopicResults>