Platform API

<back to all web services

GetApplianceComponentHelp

Get all help content for the specified UI Appliance Component

export class HelpContentModel
{
    /** @description Content Name - Can be used as a heading/title. */
    // @ApiMember(Description="Content Name - Can be used as a heading/title.", ParameterType="query")
    public Name: string;

    /** @description 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")
    public URL: string;

    /** @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. */
    // @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 IsSnippet: boolean;

    /** @description 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")
    public IsUserFacing: boolean;

    /** @description 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")
    public Index: number;

    /** @description 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")
    public StatusId: string;

    public constructor(init?: Partial<HelpContentModel>) { (Object as any).assign(this, init); }
}

// @ApiResponse(Description="A list of help content")
export class GetApplianceComponentHelpResponse
{
    /** @description List of help content. */
    // @ApiMember(Description="List of help content.", ParameterType="query")
    public HelpContent: HelpContentModel[];

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

    public constructor(init?: Partial<GetApplianceComponentHelpResponse>) { (Object as any).assign(this, init); }
}

/** @description Get all help content for the specified UI Appliance Component */
// @Api(Description="Get all help content for the specified UI Appliance Component")
export class GetApplianceComponentHelp
{
    /** @description Appliance Component Id to retrieve help for. */
    // @ApiMember(Description="Appliance Component Id to retrieve help for.", ParameterType="path")
    public ApplianceComponentId: string;

    public constructor(init?: Partial<GetApplianceComponentHelp>) { (Object as any).assign(this, init); }
}

TypeScript GetApplianceComponentHelp DTOs

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>