GET api/Platform/{affiliateId}/Help?appSettingGroup={appSettingGroup}

Returns current Help articles collection of an affiliate by appSettingGropu

Request Information

URI Parameters

Name	Description	Type	Additional information
affiliateId	Affiliate Id	integer	Required
appSettingGroup	App settings group	string	Required
v	The requested API version	string	Required Default value is 1

Name

Description

Type

Additional information

affiliateId

Affiliate Id

integer

Required

appSettingGroup

App settings group

string

Required

The requested API version

string

Required

Default value is 1

Body Parameters

None.

Response Information

Resource Description

Returns current Help articles collection of an affiliate by appSettingGropu

Collection of FilmFlex.Platform.Common.API.Contracts.V1.HelpArticleDTO

Name	Description	Type	Additional information
Title	Article title	string	None.
Description	Article description	string	None.
ChildArticles	Collection of Articles that the article is a parent of	Collection of FilmFlex.Platform.Common.API.Contracts.V1.HelpArticleDTO	None.

Response Formats

application/json

Sample:

An exception has occurred while using the formatter 'System.Net.Http.Formatting.JsonMediaTypeFormatter' to generate sample for media type 'application/json'. Exception message: Self referencing loop detected with type 'FilmFlex.Platform.Common.API.Contracts.V1.HelpArticleDTO'. Path '[0].ChildArticles'.

text/json

Sample:

An exception has occurred while using the formatter 'System.Net.Http.Formatting.JsonMediaTypeFormatter' to generate sample for media type 'text/json'. Exception message: Self referencing loop detected with type 'FilmFlex.Platform.Common.API.Contracts.V1.HelpArticleDTO'. Path '[0].ChildArticles'.