Platform API

<back to all web services

GetApplianceComponentHelp

Get all help content for the specified UI Appliance Component

import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    /**
    * Get all help content for the specified UI Appliance Component
    */
    @Api(Description="Get all help content for the specified UI Appliance Component")
    public static class GetApplianceComponentHelp
    {
        /**
        * Appliance Component Id to retrieve help for.
        */
        @ApiMember(Description="Appliance Component Id to retrieve help for.", ParameterType="path")
        public UUID ApplianceComponentId = null;
        
        public UUID getApplianceComponentId() { return ApplianceComponentId; }
        public GetApplianceComponentHelp setApplianceComponentId(UUID value) { this.ApplianceComponentId = value; return this; }
    }

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

        /**
        * Response Status
        */
        @ApiMember(Description="Response Status", ParameterType="query")
        public ResponseStatus ResponseStatus = null;
        
        public ArrayList<HelpContentModel> getHelpContent() { return HelpContent; }
        public GetApplianceComponentHelpResponse setHelpContent(ArrayList<HelpContentModel> value) { this.HelpContent = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public GetApplianceComponentHelpResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

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

        /**
        * 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 String URL = null;

        /**
        * 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 Boolean IsSnippet = null;

        /**
        * 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 Boolean IsUserFacing = null;

        /**
        * 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 Integer Index = null;

        /**
        * 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 UUID StatusId = null;
        
        public String getName() { return Name; }
        public HelpContentModel setName(String value) { this.Name = value; return this; }
        public String getUrl() { return URL; }
        public HelpContentModel setUrl(String value) { this.URL = value; return this; }
        public Boolean getIsSnippet() { return IsSnippet; }
        public HelpContentModel setIsSnippet(Boolean value) { this.IsSnippet = value; return this; }
        public Boolean getIsUserFacing() { return IsUserFacing; }
        public HelpContentModel setIsUserFacing(Boolean value) { this.IsUserFacing = value; return this; }
        public Integer getIndex() { return Index; }
        public HelpContentModel setIndex(Integer value) { this.Index = value; return this; }
        public UUID getStatusId() { return StatusId; }
        public HelpContentModel setStatusId(UUID value) { this.StatusId = value; return this; }
    }

}

Java 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>