POST api/ZendeskHelpCenerAPISearch

Request Information

URI Parameters

None.

Body Parameters

Collection of Object

None.

Request Formats

application/json, text/json, application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

SearchResult

Name	Type	Additional information
count	integer	None.
next_page	Object	None.
page	integer	None.
page_count	integer	None.
per_page	integer	None.
previous_page	Object	None.
results	Collection of Result	None.
Articles	Collection of Article	None.

Response Formats

application/json, text/json

Sample:

{
  "count": 2,
  "next_page": {},
  "page": 4,
  "page_count": 5,
  "per_page": 6,
  "previous_page": {},
  "results": [
    {
      "id": 1,
      "url": "sample string 2",
      "html_url": "sample string 3",
      "author_id": 4,
      "comments_disabled": true,
      "draft": true,
      "promoted": true,
      "position": 8,
      "vote_sum": 9,
      "vote_count": 10,
      "section_id": 11,
      "created_at": "2025-01-10T22:51:12.3028008-05:00",
      "updated_at": "2025-01-10T22:51:12.3028008-05:00",
      "name": "sample string 14",
      "title": "sample string 15",
      "source_locale": "sample string 16",
      "locale": "sample string 17",
      "outdated": true,
      "outdated_locales": [
        {},
        {}
      ],
      "edited_at": "2025-01-10T22:51:12.3028008-05:00",
      "user_segment_id": {},
      "permission_group_id": 21,
      "label_names": [
        "sample string 1",
        "sample string 2"
      ],
      "body": "sample string 22",
      "snippet": "sample string 23",
      "result_type": "sample string 24"
    },
    {
      "id": 1,
      "url": "sample string 2",
      "html_url": "sample string 3",
      "author_id": 4,
      "comments_disabled": true,
      "draft": true,
      "promoted": true,
      "position": 8,
      "vote_sum": 9,
      "vote_count": 10,
      "section_id": 11,
      "created_at": "2025-01-10T22:51:12.3028008-05:00",
      "updated_at": "2025-01-10T22:51:12.3028008-05:00",
      "name": "sample string 14",
      "title": "sample string 15",
      "source_locale": "sample string 16",
      "locale": "sample string 17",
      "outdated": true,
      "outdated_locales": [
        {},
        {}
      ],
      "edited_at": "2025-01-10T22:51:12.3028008-05:00",
      "user_segment_id": {},
      "permission_group_id": 21,
      "label_names": [
        "sample string 1",
        "sample string 2"
      ],
      "body": "sample string 22",
      "snippet": "sample string 23",
      "result_type": "sample string 24"
    }
  ],
  "Articles": [
    {
      "id": 1,
      "url": "sample string 2",
      "html_url": "sample string 3",
      "author_id": 4,
      "comments_disabled": true,
      "draft": true,
      "promoted": true,
      "position": 8,
      "vote_sum": 9,
      "vote_count": 10,
      "section_id": 11,
      "created_at": "2025-01-10T22:51:12.3028008-05:00",
      "updated_at": "2025-01-10T22:51:12.3028008-05:00",
      "name": "sample string 14",
      "title": "sample string 15",
      "source_locale": "sample string 16",
      "locale": "sample string 17",
      "outdated": true,
      "outdated_locales": [
        {},
        {}
      ],
      "edited_at": "2025-01-10T22:51:12.3028008-05:00",
      "user_segment_id": {},
      "permission_group_id": 21,
      "label_names": [
        "sample string 1",
        "sample string 2"
      ],
      "body": "sample string 22",
      "snippet": "sample string 23",
      "result_type": "sample string 24"
    },
    {
      "id": 1,
      "url": "sample string 2",
      "html_url": "sample string 3",
      "author_id": 4,
      "comments_disabled": true,
      "draft": true,
      "promoted": true,
      "position": 8,
      "vote_sum": 9,
      "vote_count": 10,
      "section_id": 11,
      "created_at": "2025-01-10T22:51:12.3028008-05:00",
      "updated_at": "2025-01-10T22:51:12.3028008-05:00",
      "name": "sample string 14",
      "title": "sample string 15",
      "source_locale": "sample string 16",
      "locale": "sample string 17",
      "outdated": true,
      "outdated_locales": [
        {},
        {}
      ],
      "edited_at": "2025-01-10T22:51:12.3028008-05:00",
      "user_segment_id": {},
      "permission_group_id": 21,
      "label_names": [
        "sample string 1",
        "sample string 2"
      ],
      "body": "sample string 22",
      "snippet": "sample string 23",
      "result_type": "sample string 24"
    }
  ]
}

application/xml, text/xml

Sample:

<HelpCenterAPI.Search.SearchResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ConnectGSLib.ZendeskAPI">
  <Articles>
    <HelpCenterAPI.Search.Article>
      <author_id>4</author_id>
      <body>sample string 22</body>
      <comments_disabled>true</comments_disabled>
      <created_at>2025-01-10T22:51:12.3028008-05:00</created_at>
      <draft>true</draft>
      <edited_at>2025-01-10T22:51:12.3028008-05:00</edited_at>
      <html_url>sample string 3</html_url>
      <id>1</id>
      <label_names xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </label_names>
      <locale>sample string 17</locale>
      <name>sample string 14</name>
      <outdated>true</outdated>
      <outdated_locales xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:anyType />
        <d4p1:anyType />
      </outdated_locales>
      <permission_group_id>21</permission_group_id>
      <position>8</position>
      <promoted>true</promoted>
      <result_type>sample string 24</result_type>
      <section_id>11</section_id>
      <snippet>sample string 23</snippet>
      <source_locale>sample string 16</source_locale>
      <title>sample string 15</title>
      <updated_at>2025-01-10T22:51:12.3028008-05:00</updated_at>
      <url>sample string 2</url>
      <user_segment_id />
      <vote_count>10</vote_count>
      <vote_sum>9</vote_sum>
    </HelpCenterAPI.Search.Article>
    <HelpCenterAPI.Search.Article>
      <author_id>4</author_id>
      <body>sample string 22</body>
      <comments_disabled>true</comments_disabled>
      <created_at>2025-01-10T22:51:12.3028008-05:00</created_at>
      <draft>true</draft>
      <edited_at>2025-01-10T22:51:12.3028008-05:00</edited_at>
      <html_url>sample string 3</html_url>
      <id>1</id>
      <label_names xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </label_names>
      <locale>sample string 17</locale>
      <name>sample string 14</name>
      <outdated>true</outdated>
      <outdated_locales xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:anyType />
        <d4p1:anyType />
      </outdated_locales>
      <permission_group_id>21</permission_group_id>
      <position>8</position>
      <promoted>true</promoted>
      <result_type>sample string 24</result_type>
      <section_id>11</section_id>
      <snippet>sample string 23</snippet>
      <source_locale>sample string 16</source_locale>
      <title>sample string 15</title>
      <updated_at>2025-01-10T22:51:12.3028008-05:00</updated_at>
      <url>sample string 2</url>
      <user_segment_id />
      <vote_count>10</vote_count>
      <vote_sum>9</vote_sum>
    </HelpCenterAPI.Search.Article>
  </Articles>
  <ErrorMessage>sample string 1</ErrorMessage>
  <count>2</count>
  <next_page />
  <page>4</page>
  <page_count>5</page_count>
  <per_page>6</per_page>
  <previous_page />
  <results>
    <HelpCenterAPI.Search.Result>
      <author_id>4</author_id>
      <body>sample string 22</body>
      <comments_disabled>true</comments_disabled>
      <created_at>2025-01-10T22:51:12.3028008-05:00</created_at>
      <draft>true</draft>
      <edited_at>2025-01-10T22:51:12.3028008-05:00</edited_at>
      <html_url>sample string 3</html_url>
      <id>1</id>
      <label_names xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </label_names>
      <locale>sample string 17</locale>
      <name>sample string 14</name>
      <outdated>true</outdated>
      <outdated_locales xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:anyType />
        <d4p1:anyType />
      </outdated_locales>
      <permission_group_id>21</permission_group_id>
      <position>8</position>
      <promoted>true</promoted>
      <result_type>sample string 24</result_type>
      <section_id>11</section_id>
      <snippet>sample string 23</snippet>
      <source_locale>sample string 16</source_locale>
      <title>sample string 15</title>
      <updated_at>2025-01-10T22:51:12.3028008-05:00</updated_at>
      <url>sample string 2</url>
      <user_segment_id />
      <vote_count>10</vote_count>
      <vote_sum>9</vote_sum>
    </HelpCenterAPI.Search.Result>
    <HelpCenterAPI.Search.Result>
      <author_id>4</author_id>
      <body>sample string 22</body>
      <comments_disabled>true</comments_disabled>
      <created_at>2025-01-10T22:51:12.3028008-05:00</created_at>
      <draft>true</draft>
      <edited_at>2025-01-10T22:51:12.3028008-05:00</edited_at>
      <html_url>sample string 3</html_url>
      <id>1</id>
      <label_names xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </label_names>
      <locale>sample string 17</locale>
      <name>sample string 14</name>
      <outdated>true</outdated>
      <outdated_locales xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:anyType />
        <d4p1:anyType />
      </outdated_locales>
      <permission_group_id>21</permission_group_id>
      <position>8</position>
      <promoted>true</promoted>
      <result_type>sample string 24</result_type>
      <section_id>11</section_id>
      <snippet>sample string 23</snippet>
      <source_locale>sample string 16</source_locale>
      <title>sample string 15</title>
      <updated_at>2025-01-10T22:51:12.3028008-05:00</updated_at>
      <url>sample string 2</url>
      <user_segment_id />
      <vote_count>10</vote_count>
      <vote_sum>9</vote_sum>
    </HelpCenterAPI.Search.Result>
  </results>
</HelpCenterAPI.Search.SearchResult>