GET CMDashboard/Common/GetHelpDocument?module={module}&isBase64={isBase64}

Request Information

URI Parameters

Name	Description	Type	Additional information
module		string	Required
isBase64		boolean	Default value is True

Body Parameters

None.

Response Information

Resource Description

ServiceResponseOfCommonDocModel

Name	Type	Additional information
IsSuccess	boolean	None.
Message	string	None.
StatusCode	integer	None.
Data	CommonDocModel	None.
Exception	string	None.

Response Formats

application/json, text/json

Sample:

{
  "IsSuccess": true,
  "Message": "sample string 2",
  "StatusCode": 3,
  "Data": {
    "Url": "sample string 1",
    "BlankDocUrl": "sample string 2"
  },
  "Exception": "sample string 4"
}

application/xml, text/xml

Sample:

<ServiceResponseOfCommonDocModel_PB6k3_PAF xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CMOWebApi.Services.ServiceHelper">
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/CMOWebApi.Models.CommonModel">
    <d2p1:BlankDocUrl>sample string 2</d2p1:BlankDocUrl>
    <d2p1:Url>sample string 1</d2p1:Url>
  </Data>
  <Exception>sample string 4</Exception>
  <IsSuccess>true</IsSuccess>
  <Message>sample string 2</Message>
  <StatusCode>3</StatusCode>
</ServiceResponseOfCommonDocModel_PB6k3_PAF>

multipart/form-data

Sample:

--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="IsSuccess"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Message"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="StatusCode"

3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data.Url"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data.BlankDocUrl"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Exception"

sample string 4
--MultipartDataMediaFormatterBoundary1q2w3e--