Platform API

GetApplianceComponentHelp

Get all help content for the specified UI Appliance Component

The following routes are available for this service:
All Verbs	/api/component/{ApplianceComponentId}/help/

**GetApplianceComponentHelp** Parameters:
Name	Parameter	Data Type	Required	Description
ApplianceComponentId	path	Guid	No	Appliance Component Id to retrieve help for.

**GetApplianceComponentHelpResponse** Parameters:
Name	Parameter	Data Type	Required	Description
HelpContent	query	List<HelpContentModel>	No	List of help content.
ResponseStatus	query	ResponseStatus	No	Response Status

**HelpContentModel** Parameters:
Name	Parameter	Data Type	Required	Description
Name	query	string	No	Content Name - Can be used as a heading/title.
URL	query	string	No	URL containing the help notes. This will either be a web page or a html blob file containing the information.
IsSnippet	query	bool	No	If true, the URL is a blob file and details should be shown in a pop up or tooltip, if false, this is a full URL to a web page and should be opened in a new tab.
IsUserFacing	query	bool	No	If true, this content is for external client/users. False means it is a developer note.
Index	query	int	No	If you have multiple snippets, this is an order you should display them in.
StatusId	query	Guid	No	This is the document status of the help content. It will be either draft or final.

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/component/{ApplianceComponentId}/help/ HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetApplianceComponentHelp xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
  <ApplianceComponentId>00000000-0000-0000-0000-000000000000</ApplianceComponentId>
</GetApplianceComponentHelp>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetApplianceComponentHelpResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
  <HelpContent xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.Models">
    <d2p1:HelpContentModel>
      <d2p1:Index>0</d2p1:Index>
      <d2p1:IsSnippet>false</d2p1:IsSnippet>
      <d2p1:IsUserFacing>false</d2p1:IsUserFacing>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:StatusId>00000000-0000-0000-0000-000000000000</d2p1:StatusId>
      <d2p1:URL>String</d2p1:URL>
    </d2p1:HelpContentModel>
  </HelpContent>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</GetApplianceComponentHelpResponse>