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/

using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Eros.Subtle.Canvara.WebAPIModel.ServiceModel;
using Eros.Subtle.Canvara.WebAPIModel.Models;

namespace Eros.Subtle.Canvara.WebAPIModel.Models
{
    public partial class HelpContentModel
    {
        ///<summary>
        ///Content Name - Can be used as a heading/title.
        ///</summary>
        [ApiMember(Description="Content Name - Can be used as a heading/title.", ParameterType="query")]
        public virtual string Name { get; set; }

        ///<summary>
        ///URL containing the help notes. This will either be a web page or a html blob file containing the information.
        ///</summary>
        [ApiMember(Description="URL containing the help notes. This will either be a web page or a html blob file containing the information.", ParameterType="query")]
        public virtual string URL { get; set; }

        ///<summary>
        ///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.
        ///</summary>
        [ApiMember(Description="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.", ParameterType="query")]
        public virtual bool IsSnippet { get; set; }

        ///<summary>
        ///If true, this content is for external client/users. False means it is a developer note.
        ///</summary>
        [ApiMember(Description="If true, this content is for external client/users. False means it is a developer note.", ParameterType="query")]
        public virtual bool IsUserFacing { get; set; }

        ///<summary>
        ///If you have multiple snippets, this is an order you should display them in.
        ///</summary>
        [ApiMember(Description="If you have multiple snippets, this is an order you should display them in.", ParameterType="query")]
        public virtual int Index { get; set; }

        ///<summary>
        ///This is the document status of the help content. It will be either draft or final.
        ///</summary>
        [ApiMember(Description="This is the document status of the help content. It will be either draft or final.", ParameterType="query")]
        public virtual Guid StatusId { get; set; }
    }

}

namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel
{
    ///<summary>
    ///Get all help content for the specified UI Appliance Component
    ///</summary>
    [Api(Description="Get all help content for the specified UI Appliance Component")]
    public partial class GetApplianceComponentHelp
    {
        ///<summary>
        ///Appliance Component Id to retrieve help for.
        ///</summary>
        [ApiMember(Description="Appliance Component Id to retrieve help for.", ParameterType="path")]
        public virtual Guid ApplianceComponentId { get; set; }
    }

    [ApiResponse(Description="A list of help content")]
    public partial class GetApplianceComponentHelpResponse
    {
        ///<summary>
        ///List of help content.
        ///</summary>
        [ApiMember(Description="List of help content.", ParameterType="query")]
        public virtual List<HelpContentModel> HelpContent { get; set; }

        ///<summary>
        ///Response Status
        ///</summary>
        [ApiMember(Description="Response Status", ParameterType="query")]
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

}

C# GetApplianceComponentHelp DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
Content-Type: application/json
Content-Length: length

{"ApplianceComponentId":"00000000-0000-0000-0000-000000000000"}

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

{"HelpContent":[{"Name":"String","URL":"String","IsSnippet":false,"IsUserFacing":false,"Index":0,"StatusId":"00000000-0000-0000-0000-000000000000"}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}