| All Verbs | /api/component/{ApplianceComponentId}/help/ |
|---|
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Eros.Subtle.Canvara.WebAPIModel.ServiceModel
Imports Eros.Subtle.Canvara.WebAPIModel.Models
Namespace Global
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 Overridable Property Name As String
'''<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 Overridable Property URL As String
'''<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 Overridable Property IsSnippet As Boolean
'''<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 Overridable Property IsUserFacing As Boolean
'''<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 Overridable Property Index As Integer
'''<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 Overridable Property StatusId As Guid
End Class
End Namespace
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 Overridable Property ApplianceComponentId As Guid
End Class
<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 Overridable Property HelpContent As List(Of HelpContentModel)
'''<Summary>
'''Response Status
'''</Summary>
<ApiMember(Description:="Response Status", ParameterType:="query")>
Public Overridable Property ResponseStatus As ResponseStatus
End Class
End Namespace
End Namespace
VB.NET GetApplianceComponentHelp DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
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: text/jsonl
Content-Type: text/jsonl
Content-Length: length
{"ApplianceComponentId":"00000000-0000-0000-0000-000000000000"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
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"}}}