| All Verbs | /api/component/{ApplianceComponentId}/help/ |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ApplianceComponentId | path | Guid | No | Appliance Component Id to retrieve help for. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| HelpContent | query | List<HelpContentModel> | No | List of help content. |
| ResponseStatus | query | ResponseStatus | No | Response Status |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Name | query | string | No | Content Name - Can be used as a heading/title. |
| URL | query | string | No | URL containing the help notes. This will either be a web page or a html blob file containing the information. |
| IsSnippet | query | bool | No | 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. |
| IsUserFacing | query | bool | No | If true, this content is for external client/users. False means it is a developer note. |
| Index | query | int | No | If you have multiple snippets, this is an order you should display them in. |
| StatusId | query | Guid | No | This is the document status of the help content. It will be either draft or final. |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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/jsv
Content-Type: text/jsv
Content-Length: length
{
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
HelpContent:
[
{
Name: String,
URL: String,
IsSnippet: False,
IsUserFacing: False,
Index: 0
}
],
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}