GrowthZone REST API API Reference

undefined

API Endpoint

https://app.memberzone.org

Request Content-Types: application/json

Response Content-Types: application/json

Schemes: https

Version: v1.0

Paths

Help

GET /api/help/{screenkey}

screenkey: string

in path

(no description)

200 OK

HelpTopic

Response Example (200 OK)

{
  "Self": "string",
  "Id": "string",
  "ScreenKey": "string",
  "Title": "string",
  "SummaryHtml": "string",
  "DetailHtml": "string",
  "FieldHelpText": "string",
  "RelatedTopics": "string",
  "RelatedLinks": "string",
  "Comments": "string",
  "Edits": "string"
}

Help

POST /api/help/{screenkey}

ScreenTopicAddEditModel

undefined

screenkey: string

in path

(no description)

Request Example

{
  "Self": "string",
  "ScreenKey": "string",
  "Title": "string",
  "SummaryHtml": "string",
  "DetailHtml": "string",
  "FieldHelpText": "string",
  "RelatedTopics": "string",
  "RelatedLinks": "string"
}

200 OK

ScreenTopicCollectionModel

Response Example (200 OK)

{
  "ScreenKey": "string",
  "HasHelpTopic": "boolean",
  "HelpTopicEditDateTime": "string"
}

Help

GET /api/help/all

200 OK

ScreenTopicCollectionModel

type

ScreenTopicCollectionModel

Response Example (200 OK)

[
  {
    "ScreenKey": "string",
    "HasHelpTopic": "boolean",
    "HelpTopicEditDateTime": "string"
  }
]

Help

GET /api/help/items/{screenkey}

screenkey: string

in path

(no description)

200 OK

ScreenTopicAddEditModel

Response Example (200 OK)

{
  "Self": "string",
  "ScreenKey": "string",
  "Title": "string",
  "SummaryHtml": "string",
  "DetailHtml": "string",
  "FieldHelpText": "string",
  "RelatedTopics": "string",
  "RelatedLinks": "string"
}

Schema Definitions

ScreenTopicCollectionModel: object

ScreenKey: string
HasHelpTopic: boolean
HelpTopicEditDateTime: string

Example

{
  "ScreenKey": "string",
  "HasHelpTopic": "boolean",
  "HelpTopicEditDateTime": "string"
}

ScreenTopicAddEditModel: object

Self: string
ScreenKey: string
Title: string
SummaryHtml: string
DetailHtml: string
FieldHelpText: string: For each field have some seperate HTML text
RelatedTopics: string: Link to other documents - string is what to display, Guid is the document ID
RelatedLinks: string: Link to externals URLs, e.g. videos, pages, etc.

Example

{
  "Self": "string",
  "ScreenKey": "string",
  "Title": "string",
  "SummaryHtml": "string",
  "DetailHtml": "string",
  "FieldHelpText": "string",
  "RelatedTopics": "string",
  "RelatedLinks": "string"
}

HelpTopic: object

Self: string
Id: string
ScreenKey: string: If this topic is tied to a specific screen - most will be at first
Title: string: Title of screen
SummaryHtml: string: The summary help text we want to display about this topic - what the screen is for or what the topic is about
DetailHtml: string: The detailed content for the topic. If this is a screen there won't be anything here most likely - it will be in the FieldHelpText and Summary.
FieldHelpText: string: For each field have some seperate HTML text
RelatedTopics: string: Link to other documents - string is what to display, Guid is the document ID
RelatedLinks: string: Link to externals URLs, e.g. videos, pages, etc.
Comments: string: List of comments
Edits: string: List of edits

Example

{
  "Self": "string",
  "Id": "string",
  "ScreenKey": "string",
  "Title": "string",
  "SummaryHtml": "string",
  "DetailHtml": "string",
  "FieldHelpText": "string",
  "RelatedTopics": "string",
  "RelatedLinks": "string",
  "Comments": "string",
  "Edits": "string"
}

Documentation by Spectacle