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/

import 'package:servicestack/servicestack.dart';

class HelpContentModel implements IConvertible
{
    /**
    * Content Name - Can be used as a heading/title.
    */
    // @ApiMember(Description="Content Name - Can be used as a heading/title.", ParameterType="query")
    String? Name;

    /**
    * URL containing the help notes. This will either be a web page or a html blob file containing the information.
    */
    // @ApiMember(Description="URL containing the help notes. This will either be a web page or a html blob file containing the information.", ParameterType="query")
    String? URL;

    /**
    * 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.
    */
    // @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")
    bool? IsSnippet;

    /**
    * If true, this content is for external client/users. False means it is a developer note.
    */
    // @ApiMember(Description="If true, this content is for external client/users. False means it is a developer note.", ParameterType="query")
    bool? IsUserFacing;

    /**
    * If you have multiple snippets, this is an order you should display them in.
    */
    // @ApiMember(Description="If you have multiple snippets, this is an order you should display them in.", ParameterType="query")
    int? Index;

    /**
    * This is the document status of the help content. It will be either draft or final.
    */
    // @ApiMember(Description="This is the document status of the help content. It will be either draft or final.", ParameterType="query")
    String? StatusId;

    HelpContentModel({this.Name,this.URL,this.IsSnippet,this.IsUserFacing,this.Index,this.StatusId});
    HelpContentModel.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Name = json['Name'];
        URL = json['URL'];
        IsSnippet = json['IsSnippet'];
        IsUserFacing = json['IsUserFacing'];
        Index = json['Index'];
        StatusId = json['StatusId'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Name': Name,
        'URL': URL,
        'IsSnippet': IsSnippet,
        'IsUserFacing': IsUserFacing,
        'Index': Index,
        'StatusId': StatusId
    };

    getTypeName() => "HelpContentModel";
    TypeContext? context = _ctx;
}

// @ApiResponse(Description="A list of help content")
class GetApplianceComponentHelpResponse implements IConvertible
{
    /**
    * List of help content.
    */
    // @ApiMember(Description="List of help content.", ParameterType="query")
    List<HelpContentModel>? HelpContent;

    /**
    * Response Status
    */
    // @ApiMember(Description="Response Status", ParameterType="query")
    ResponseStatus? ResponseStatus;

    GetApplianceComponentHelpResponse({this.HelpContent,this.ResponseStatus});
    GetApplianceComponentHelpResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        HelpContent = JsonConverters.fromJson(json['HelpContent'],'List<HelpContentModel>',context!);
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'HelpContent': JsonConverters.toJson(HelpContent,'List<HelpContentModel>',context!),
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
    };

    getTypeName() => "GetApplianceComponentHelpResponse";
    TypeContext? context = _ctx;
}

/**
* Get all help content for the specified UI Appliance Component
*/
// @Api(Description="Get all help content for the specified UI Appliance Component")
class GetApplianceComponentHelp implements IConvertible
{
    /**
    * Appliance Component Id to retrieve help for.
    */
    // @ApiMember(Description="Appliance Component Id to retrieve help for.", ParameterType="path")
    String? ApplianceComponentId;

    GetApplianceComponentHelp({this.ApplianceComponentId});
    GetApplianceComponentHelp.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ApplianceComponentId = json['ApplianceComponentId'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ApplianceComponentId': ApplianceComponentId
    };

    getTypeName() => "GetApplianceComponentHelp";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'pfapi.pstpf.com.au', types: <String, TypeInfo> {
    'HelpContentModel': TypeInfo(TypeOf.Class, create:() => HelpContentModel()),
    'GetApplianceComponentHelpResponse': TypeInfo(TypeOf.Class, create:() => GetApplianceComponentHelpResponse()),
    'List<HelpContentModel>': TypeInfo(TypeOf.Class, create:() => <HelpContentModel>[]),
    'GetApplianceComponentHelp': TypeInfo(TypeOf.Class, create:() => GetApplianceComponentHelp()),
});

Dart 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"}}}