POST api/Helps/GetList

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Id	integer	None.
CategoryIds	Collection of integer	None.
Keyword	string	None.
HelpCode	string	None.
HelpCodes	Collection of string	None.
CategoryCode	string	None.
CategoryCodes	Collection of string	None.
PageIndex	integer	None.
PageSize	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "Id": 1,
  "CategoryIds": [
    1,
    2
  ],
  "Keyword": "sample string 1",
  "HelpCode": "sample string 2",
  "HelpCodes": [
    "sample string 1",
    "sample string 2"
  ],
  "CategoryCode": "sample string 3",
  "CategoryCodes": [
    "sample string 1",
    "sample string 2"
  ],
  "PageIndex": 4,
  "PageSize": 5
}

application/xml, text/xml

Sample:

<HelpInfoSearchDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MS.Document.Dto.Helps">
  <PageIndex xmlns="http://schemas.datacontract.org/2004/07/MS.Document.Dto">4</PageIndex>
  <PageSize xmlns="http://schemas.datacontract.org/2004/07/MS.Document.Dto">5</PageSize>
  <CategoryCode>sample string 3</CategoryCode>
  <CategoryCodes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </CategoryCodes>
  <CategoryIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </CategoryIds>
  <HelpCode>sample string 2</HelpCode>
  <HelpCodes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </HelpCodes>
  <Id>1</Id>
  <Keyword>sample string 1</Keyword>
</HelpInfoSearchDto>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ResponseResultOfListOfHelpInfoDto

Name	Type	Additional information
Status	boolean	None.
ErrorCode	string	None.
ErrorMessage	string	None.
Data	Collection of HelpInfoDto	None.

Response Formats

application/json, text/json

Sample:

{
  "Status": true,
  "ErrorCode": "sample string 2",
  "ErrorMessage": "sample string 3",
  "Data": [
    {
      "Id": 1,
      "CategoryId": 1,
      "Title": "sample string 1",
      "Content": "sample string 2",
      "ImageUrl": [
        "https://erp-doc.cnfth.com/Files/Images/sample string 1\\sample string 1",
        "https://erp-doc.cnfth.com/Files/Images/sample string 2\\sample string 2"
      ],
      "HelpfulQuantity": 1,
      "UselessQuantity": 1,
      "ViewQuantity": 1,
      "HelpCode": "sample string 4",
      "CategoryName": "sample string 5",
      "ParenPaths": [
        1,
        2
      ],
      "HelpSchemeList": [
        {
          "SchemeName": "sample string 1",
          "SerialNumber": 1,
          "HelpSchemeDetails": [
            {
              "SerialNumber": 1,
              "Content": "sample string 1",
              "ImageUrl": [
                "https://erp-doc.cnfth.com/Files/Images/sample string 1\\sample string 1",
                "https://erp-doc.cnfth.com/Files/Images/sample string 2\\sample string 2"
              ]
            },
            {
              "SerialNumber": 1,
              "Content": "sample string 1",
              "ImageUrl": [
                "https://erp-doc.cnfth.com/Files/Images/sample string 1\\sample string 1",
                "https://erp-doc.cnfth.com/Files/Images/sample string 2\\sample string 2"
              ]
            }
          ]
        },
        {
          "SchemeName": "sample string 1",
          "SerialNumber": 1,
          "HelpSchemeDetails": [
            {
              "SerialNumber": 1,
              "Content": "sample string 1",
              "ImageUrl": [
                "https://erp-doc.cnfth.com/Files/Images/sample string 1\\sample string 1",
                "https://erp-doc.cnfth.com/Files/Images/sample string 2\\sample string 2"
              ]
            },
            {
              "SerialNumber": 1,
              "Content": "sample string 1",
              "ImageUrl": [
                "https://erp-doc.cnfth.com/Files/Images/sample string 1\\sample string 1",
                "https://erp-doc.cnfth.com/Files/Images/sample string 2\\sample string 2"
              ]
            }
          ]
        }
      ]
    },
    {
      "Id": 1,
      "CategoryId": 1,
      "Title": "sample string 1",
      "Content": "sample string 2",
      "ImageUrl": [
        "https://erp-doc.cnfth.com/Files/Images/sample string 1\\sample string 1",
        "https://erp-doc.cnfth.com/Files/Images/sample string 2\\sample string 2"
      ],
      "HelpfulQuantity": 1,
      "UselessQuantity": 1,
      "ViewQuantity": 1,
      "HelpCode": "sample string 4",
      "CategoryName": "sample string 5",
      "ParenPaths": [
        1,
        2
      ],
      "HelpSchemeList": [
        {
          "SchemeName": "sample string 1",
          "SerialNumber": 1,
          "HelpSchemeDetails": [
            {
              "SerialNumber": 1,
              "Content": "sample string 1",
              "ImageUrl": [
                "https://erp-doc.cnfth.com/Files/Images/sample string 1\\sample string 1",
                "https://erp-doc.cnfth.com/Files/Images/sample string 2\\sample string 2"
              ]
            },
            {
              "SerialNumber": 1,
              "Content": "sample string 1",
              "ImageUrl": [
                "https://erp-doc.cnfth.com/Files/Images/sample string 1\\sample string 1",
                "https://erp-doc.cnfth.com/Files/Images/sample string 2\\sample string 2"
              ]
            }
          ]
        },
        {
          "SchemeName": "sample string 1",
          "SerialNumber": 1,
          "HelpSchemeDetails": [
            {
              "SerialNumber": 1,
              "Content": "sample string 1",
              "ImageUrl": [
                "https://erp-doc.cnfth.com/Files/Images/sample string 1\\sample string 1",
                "https://erp-doc.cnfth.com/Files/Images/sample string 2\\sample string 2"
              ]
            },
            {
              "SerialNumber": 1,
              "Content": "sample string 1",
              "ImageUrl": [
                "https://erp-doc.cnfth.com/Files/Images/sample string 1\\sample string 1",
                "https://erp-doc.cnfth.com/Files/Images/sample string 2\\sample string 2"
              ]
            }
          ]
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample:

<ResponseResultOfArrayOfHelpInfoDtoMCQwtXbq xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Willv.Common">
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/MS.Document.Dto.Helps">
    <d2p1:HelpInfoDto>
      <d2p1:CategoryId>1</d2p1:CategoryId>
      <d2p1:CategoryName>sample string 5</d2p1:CategoryName>
      <d2p1:Content>sample string 2</d2p1:Content>
      <d2p1:CreateTime>2026-08-11T21:22:31.1847487+08:00</d2p1:CreateTime>
      <d2p1:HelpCode>sample string 4</d2p1:HelpCode>
      <d2p1:HelpSchemeList>
        <d2p1:HelpSchemesDto>
          <d2p1:HelpId>1</d2p1:HelpId>
          <d2p1:HelpSchemeDetails>
            <d2p1:HelpSchemeDetailDto>
              <d2p1:Content>sample string 1</d2p1:Content>
              <d2p1:HelpSchemeId>1</d2p1:HelpSchemeId>
              <d2p1:Id>1</d2p1:Id>
              <d2p1:ImageUrl xmlns:d8p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                <d8p1:string>https://erp-doc.cnfth.com/Files/Images/sample string 1\sample string 1</d8p1:string>
                <d8p1:string>https://erp-doc.cnfth.com/Files/Images/sample string 2\sample string 2</d8p1:string>
              </d2p1:ImageUrl>
              <d2p1:Images>["sample string 1","sample string 2"]</d2p1:Images>
              <d2p1:SerialNumber>1</d2p1:SerialNumber>
            </d2p1:HelpSchemeDetailDto>
            <d2p1:HelpSchemeDetailDto>
              <d2p1:Content>sample string 1</d2p1:Content>
              <d2p1:HelpSchemeId>1</d2p1:HelpSchemeId>
              <d2p1:Id>1</d2p1:Id>
              <d2p1:ImageUrl xmlns:d8p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                <d8p1:string>https://erp-doc.cnfth.com/Files/Images/sample string 1\sample string 1</d8p1:string>
                <d8p1:string>https://erp-doc.cnfth.com/Files/Images/sample string 2\sample string 2</d8p1:string>
              </d2p1:ImageUrl>
              <d2p1:Images>["sample string 1","sample string 2"]</d2p1:Images>
              <d2p1:SerialNumber>1</d2p1:SerialNumber>
            </d2p1:HelpSchemeDetailDto>
          </d2p1:HelpSchemeDetails>
          <d2p1:Id>1</d2p1:Id>
          <d2p1:SchemeName>sample string 1</d2p1:SchemeName>
          <d2p1:SerialNumber>1</d2p1:SerialNumber>
        </d2p1:HelpSchemesDto>
        <d2p1:HelpSchemesDto>
          <d2p1:HelpId>1</d2p1:HelpId>
          <d2p1:HelpSchemeDetails>
            <d2p1:HelpSchemeDetailDto>
              <d2p1:Content>sample string 1</d2p1:Content>
              <d2p1:HelpSchemeId>1</d2p1:HelpSchemeId>
              <d2p1:Id>1</d2p1:Id>
              <d2p1:ImageUrl xmlns:d8p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                <d8p1:string>https://erp-doc.cnfth.com/Files/Images/sample string 1\sample string 1</d8p1:string>
                <d8p1:string>https://erp-doc.cnfth.com/Files/Images/sample string 2\sample string 2</d8p1:string>
              </d2p1:ImageUrl>
              <d2p1:Images>["sample string 1","sample string 2"]</d2p1:Images>
              <d2p1:SerialNumber>1</d2p1:SerialNumber>
            </d2p1:HelpSchemeDetailDto>
            <d2p1:HelpSchemeDetailDto>
              <d2p1:Content>sample string 1</d2p1:Content>
              <d2p1:HelpSchemeId>1</d2p1:HelpSchemeId>
              <d2p1:Id>1</d2p1:Id>
              <d2p1:ImageUrl xmlns:d8p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                <d8p1:string>https://erp-doc.cnfth.com/Files/Images/sample string 1\sample string 1</d8p1:string>
                <d8p1:string>https://erp-doc.cnfth.com/Files/Images/sample string 2\sample string 2</d8p1:string>
              </d2p1:ImageUrl>
              <d2p1:Images>["sample string 1","sample string 2"]</d2p1:Images>
              <d2p1:SerialNumber>1</d2p1:SerialNumber>
            </d2p1:HelpSchemeDetailDto>
          </d2p1:HelpSchemeDetails>
          <d2p1:Id>1</d2p1:Id>
          <d2p1:SchemeName>sample string 1</d2p1:SchemeName>
          <d2p1:SerialNumber>1</d2p1:SerialNumber>
        </d2p1:HelpSchemesDto>
      </d2p1:HelpSchemeList>
      <d2p1:HelpfulQuantity>1</d2p1:HelpfulQuantity>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:ImageUrl xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>https://erp-doc.cnfth.com/Files/Images/sample string 1\sample string 1</d4p1:string>
        <d4p1:string>https://erp-doc.cnfth.com/Files/Images/sample string 2\sample string 2</d4p1:string>
      </d2p1:ImageUrl>
      <d2p1:Images>["sample string 1","sample string 2"]</d2p1:Images>
      <d2p1:LastUpdateTime>2026-08-11T21:22:31.1847487+08:00</d2p1:LastUpdateTime>
      <d2p1:ParenPaths xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>2</d4p1:int>
      </d2p1:ParenPaths>
      <d2p1:Title>sample string 1</d2p1:Title>
      <d2p1:UselessQuantity>1</d2p1:UselessQuantity>
      <d2p1:ViewQuantity>1</d2p1:ViewQuantity>
    </d2p1:HelpInfoDto>
    <d2p1:HelpInfoDto>
      <d2p1:CategoryId>1</d2p1:CategoryId>
      <d2p1:CategoryName>sample string 5</d2p1:CategoryName>
      <d2p1:Content>sample string 2</d2p1:Content>
      <d2p1:CreateTime>2026-08-11T21:22:31.1847487+08:00</d2p1:CreateTime>
      <d2p1:HelpCode>sample string 4</d2p1:HelpCode>
      <d2p1:HelpSchemeList>
        <d2p1:HelpSchemesDto>
          <d2p1:HelpId>1</d2p1:HelpId>
          <d2p1:HelpSchemeDetails>
            <d2p1:HelpSchemeDetailDto>
              <d2p1:Content>sample string 1</d2p1:Content>
              <d2p1:HelpSchemeId>1</d2p1:HelpSchemeId>
              <d2p1:Id>1</d2p1:Id>
              <d2p1:ImageUrl xmlns:d8p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                <d8p1:string>https://erp-doc.cnfth.com/Files/Images/sample string 1\sample string 1</d8p1:string>
                <d8p1:string>https://erp-doc.cnfth.com/Files/Images/sample string 2\sample string 2</d8p1:string>
              </d2p1:ImageUrl>
              <d2p1:Images>["sample string 1","sample string 2"]</d2p1:Images>
              <d2p1:SerialNumber>1</d2p1:SerialNumber>
            </d2p1:HelpSchemeDetailDto>
            <d2p1:HelpSchemeDetailDto>
              <d2p1:Content>sample string 1</d2p1:Content>
              <d2p1:HelpSchemeId>1</d2p1:HelpSchemeId>
              <d2p1:Id>1</d2p1:Id>
              <d2p1:ImageUrl xmlns:d8p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                <d8p1:string>https://erp-doc.cnfth.com/Files/Images/sample string 1\sample string 1</d8p1:string>
                <d8p1:string>https://erp-doc.cnfth.com/Files/Images/sample string 2\sample string 2</d8p1:string>
              </d2p1:ImageUrl>
              <d2p1:Images>["sample string 1","sample string 2"]</d2p1:Images>
              <d2p1:SerialNumber>1</d2p1:SerialNumber>
            </d2p1:HelpSchemeDetailDto>
          </d2p1:HelpSchemeDetails>
          <d2p1:Id>1</d2p1:Id>
          <d2p1:SchemeName>sample string 1</d2p1:SchemeName>
          <d2p1:SerialNumber>1</d2p1:SerialNumber>
        </d2p1:HelpSchemesDto>
        <d2p1:HelpSchemesDto>
          <d2p1:HelpId>1</d2p1:HelpId>
          <d2p1:HelpSchemeDetails>
            <d2p1:HelpSchemeDetailDto>
              <d2p1:Content>sample string 1</d2p1:Content>
              <d2p1:HelpSchemeId>1</d2p1:HelpSchemeId>
              <d2p1:Id>1</d2p1:Id>
              <d2p1:ImageUrl xmlns:d8p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                <d8p1:string>https://erp-doc.cnfth.com/Files/Images/sample string 1\sample string 1</d8p1:string>
                <d8p1:string>https://erp-doc.cnfth.com/Files/Images/sample string 2\sample string 2</d8p1:string>
              </d2p1:ImageUrl>
              <d2p1:Images>["sample string 1","sample string 2"]</d2p1:Images>
              <d2p1:SerialNumber>1</d2p1:SerialNumber>
            </d2p1:HelpSchemeDetailDto>
            <d2p1:HelpSchemeDetailDto>
              <d2p1:Content>sample string 1</d2p1:Content>
              <d2p1:HelpSchemeId>1</d2p1:HelpSchemeId>
              <d2p1:Id>1</d2p1:Id>
              <d2p1:ImageUrl xmlns:d8p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                <d8p1:string>https://erp-doc.cnfth.com/Files/Images/sample string 1\sample string 1</d8p1:string>
                <d8p1:string>https://erp-doc.cnfth.com/Files/Images/sample string 2\sample string 2</d8p1:string>
              </d2p1:ImageUrl>
              <d2p1:Images>["sample string 1","sample string 2"]</d2p1:Images>
              <d2p1:SerialNumber>1</d2p1:SerialNumber>
            </d2p1:HelpSchemeDetailDto>
          </d2p1:HelpSchemeDetails>
          <d2p1:Id>1</d2p1:Id>
          <d2p1:SchemeName>sample string 1</d2p1:SchemeName>
          <d2p1:SerialNumber>1</d2p1:SerialNumber>
        </d2p1:HelpSchemesDto>
      </d2p1:HelpSchemeList>
      <d2p1:HelpfulQuantity>1</d2p1:HelpfulQuantity>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:ImageUrl xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>https://erp-doc.cnfth.com/Files/Images/sample string 1\sample string 1</d4p1:string>
        <d4p1:string>https://erp-doc.cnfth.com/Files/Images/sample string 2\sample string 2</d4p1:string>
      </d2p1:ImageUrl>
      <d2p1:Images>["sample string 1","sample string 2"]</d2p1:Images>
      <d2p1:LastUpdateTime>2026-08-11T21:22:31.1847487+08:00</d2p1:LastUpdateTime>
      <d2p1:ParenPaths xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>2</d4p1:int>
      </d2p1:ParenPaths>
      <d2p1:Title>sample string 1</d2p1:Title>
      <d2p1:UselessQuantity>1</d2p1:UselessQuantity>
      <d2p1:ViewQuantity>1</d2p1:ViewQuantity>
    </d2p1:HelpInfoDto>
  </Data>
  <ErrorCode>sample string 2</ErrorCode>
  <ErrorMessage>sample string 3</ErrorMessage>
  <Status>true</Status>
</ResponseResultOfArrayOfHelpInfoDtoMCQwtXbq>