| All Verbs | /api/component/{ApplianceComponentId}/help/ |
|---|
namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel
open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<AllowNullLiteral>]
type 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")>]
member val Name:String = null with 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")>]
member val URL:String = null with 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")>]
member val IsSnippet:Boolean = new Boolean() with 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")>]
member val IsUserFacing:Boolean = new Boolean() with 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")>]
member val Index:Int32 = new Int32() with 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")>]
member val StatusId:Guid = new Guid() with get,set
[<ApiResponse(Description="A list of help content")>]
[<AllowNullLiteral>]
type GetApplianceComponentHelpResponse() =
///<summary>
///List of help content.
///</summary>
[<ApiMember(Description="List of help content.", ParameterType="query")>]
member val HelpContent:ResizeArray<HelpContentModel> = null with get,set
///<summary>
///Response Status
///</summary>
[<ApiMember(Description="Response Status", ParameterType="query")>]
member val ResponseStatus:ResponseStatus = null with get,set
///<summary>
///Get all help content for the specified UI Appliance Component
///</summary>
[<Api(Description="Get all help content for the specified UI Appliance Component")>]
[<AllowNullLiteral>]
type GetApplianceComponentHelp() =
///<summary>
///Appliance Component Id to retrieve help for.
///</summary>
[<ApiMember(Description="Appliance Component Id to retrieve help for.", ParameterType="path")>]
member val ApplianceComponentId:Guid = new Guid() with get,set
F# GetApplianceComponentHelp DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
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/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>