POST v1/HelpDocs/GetArticleByCategoryId

Request Information

URI Parameters

None.

Body Parameters

GetArticleByCategoryIdRQ
NameDescriptionTypeAdditional information
CategoryId

string

None.

Vuserid

string

None.

PccCode

string

None.

UserId

integer

None.

AccountID

string

None.

UserName

string

None.

ApplicationDomain

ApplicationDomain

None.

guid

string

None.

Request Formats

application/json, text/json

Sample:
{
  "CategoryId": "sample string 1",
  "Vuserid": "sample string 2",
  "PccCode": "sample string 3",
  "UserId": 4,
  "AccountID": "sample string 5",
  "UserName": "sample string 6",
  "ApplicationDomain": 0,
  "guid": "sample string 7"
}

application/xml, text/xml

Sample:
<GetArticleByCategoryIdRQ xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GT.AzrTravelApi.Model.HelpDocs">
  <AccountID xmlns="http://schemas.datacontract.org/2004/07/GT.AzrTravelApi.Model">sample string 5</AccountID>
  <ApplicationDomain xmlns="http://schemas.datacontract.org/2004/07/GT.AzrTravelApi.Model">GTL</ApplicationDomain>
  <PccCode xmlns="http://schemas.datacontract.org/2004/07/GT.AzrTravelApi.Model">sample string 3</PccCode>
  <UserId xmlns="http://schemas.datacontract.org/2004/07/GT.AzrTravelApi.Model">4</UserId>
  <UserName xmlns="http://schemas.datacontract.org/2004/07/GT.AzrTravelApi.Model">sample string 6</UserName>
  <Vuserid xmlns="http://schemas.datacontract.org/2004/07/GT.AzrTravelApi.Model">sample string 2</Vuserid>
  <guid xmlns="http://schemas.datacontract.org/2004/07/GT.AzrTravelApi.Model">sample string 7</guid>
  <CategoryId>sample string 1</CategoryId>
</GetArticleByCategoryIdRQ>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ArticleResponse
NameDescriptionTypeAdditional information
articles

Collection of Article

None.

IsSuccess

boolean

None.

Message

string

None.

guid

string

None.

PNR

string

None.

Response Formats

application/json, text/json

Sample:
{
  "articles": [
    {
      "article_id": "sample string 1",
      "account_id": "sample string 2",
      "user_id": "sample string 3",
      "category_id": "sample string 4",
      "author": {
        "name": "sample string 1",
        "email": "sample string 2",
        "profile_image": "sample string 3"
      },
      "title": "sample string 5",
      "description": "sample string 6",
      "short_version": "sample string 7",
      "body": "sample string 8",
      "slug": "sample string 9",
      "icon": "sample string 10",
      "tags": [
        {},
        {}
      ],
      "show_toc": true,
      "is_private": true,
      "is_published": true,
      "is_featured": true,
      "is_current_version": true,
      "version_number": 16,
      "source": "sample string 17",
      "editor_type": "sample string 18",
      "stale_status": {
        "is_stale": true,
        "reason": "sample string 2",
        "source": "sample string 3",
        "triggered_at": "sample string 4",
        "expires_at": "sample string 5"
      },
      "created_at": "sample string 19",
      "updated_at": "sample string 20",
      "permission_groups": {},
      "multilingual": [
        {
          "language_code": "sample string 1",
          "title": "sample string 2",
          "description": "sample string 3",
          "short_version": "sample string 4",
          "body": "sample string 5",
          "slug": "sample string 6",
          "tags": {},
          "user_id": "sample string 8",
          "url": "sample string 9",
          "relative_url": "sample string 10",
          "is_live": true,
          "is_current_version": true,
          "version_number": 13,
          "editor_type": "sample string 14",
          "created_at": "sample string 15"
        },
        {
          "language_code": "sample string 1",
          "title": "sample string 2",
          "description": "sample string 3",
          "short_version": "sample string 4",
          "body": "sample string 5",
          "slug": "sample string 6",
          "tags": {},
          "user_id": "sample string 8",
          "url": "sample string 9",
          "relative_url": "sample string 10",
          "is_live": true,
          "is_current_version": true,
          "version_number": 13,
          "editor_type": "sample string 14",
          "created_at": "sample string 15"
        }
      ],
      "url": "sample string 22",
      "relative_url": "sample string 23",
      "description_was_autogenerated": true,
      "short_version_was_autogenerated": true
    },
    {
      "article_id": "sample string 1",
      "account_id": "sample string 2",
      "user_id": "sample string 3",
      "category_id": "sample string 4",
      "author": {
        "name": "sample string 1",
        "email": "sample string 2",
        "profile_image": "sample string 3"
      },
      "title": "sample string 5",
      "description": "sample string 6",
      "short_version": "sample string 7",
      "body": "sample string 8",
      "slug": "sample string 9",
      "icon": "sample string 10",
      "tags": [
        {},
        {}
      ],
      "show_toc": true,
      "is_private": true,
      "is_published": true,
      "is_featured": true,
      "is_current_version": true,
      "version_number": 16,
      "source": "sample string 17",
      "editor_type": "sample string 18",
      "stale_status": {
        "is_stale": true,
        "reason": "sample string 2",
        "source": "sample string 3",
        "triggered_at": "sample string 4",
        "expires_at": "sample string 5"
      },
      "created_at": "sample string 19",
      "updated_at": "sample string 20",
      "permission_groups": {},
      "multilingual": [
        {
          "language_code": "sample string 1",
          "title": "sample string 2",
          "description": "sample string 3",
          "short_version": "sample string 4",
          "body": "sample string 5",
          "slug": "sample string 6",
          "tags": {},
          "user_id": "sample string 8",
          "url": "sample string 9",
          "relative_url": "sample string 10",
          "is_live": true,
          "is_current_version": true,
          "version_number": 13,
          "editor_type": "sample string 14",
          "created_at": "sample string 15"
        },
        {
          "language_code": "sample string 1",
          "title": "sample string 2",
          "description": "sample string 3",
          "short_version": "sample string 4",
          "body": "sample string 5",
          "slug": "sample string 6",
          "tags": {},
          "user_id": "sample string 8",
          "url": "sample string 9",
          "relative_url": "sample string 10",
          "is_live": true,
          "is_current_version": true,
          "version_number": 13,
          "editor_type": "sample string 14",
          "created_at": "sample string 15"
        }
      ],
      "url": "sample string 22",
      "relative_url": "sample string 23",
      "description_was_autogenerated": true,
      "short_version_was_autogenerated": true
    }
  ],
  "IsSuccess": true,
  "Message": "sample string 2",
  "guid": "sample string 3",
  "PNR": "sample string 4"
}

application/xml, text/xml

Sample:
<ArticleResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GT.AzrTravelApi.Model.HelpDocs">
  <IsSuccess xmlns="http://schemas.datacontract.org/2004/07/GT.AzrTravelApi.Model">true</IsSuccess>
  <Message xmlns="http://schemas.datacontract.org/2004/07/GT.AzrTravelApi.Model">sample string 2</Message>
  <PNR xmlns="http://schemas.datacontract.org/2004/07/GT.AzrTravelApi.Model">sample string 4</PNR>
  <guid xmlns="http://schemas.datacontract.org/2004/07/GT.AzrTravelApi.Model">sample string 3</guid>
  <articles>
    <Article>
      <account_id>sample string 2</account_id>
      <article_id>sample string 1</article_id>
      <author>
        <email>sample string 2</email>
        <name>sample string 1</name>
        <profile_image>sample string 3</profile_image>
      </author>
      <body>sample string 8</body>
      <category_id>sample string 4</category_id>
      <created_at>sample string 19</created_at>
      <description>sample string 6</description>
      <description_was_autogenerated>true</description_was_autogenerated>
      <editor_type>sample string 18</editor_type>
      <icon>sample string 10</icon>
      <is_current_version>true</is_current_version>
      <is_featured>true</is_featured>
      <is_private>true</is_private>
      <is_published>true</is_published>
      <multilingual>
        <Multilingual>
          <body>sample string 5</body>
          <created_at>sample string 15</created_at>
          <description>sample string 3</description>
          <editor_type>sample string 14</editor_type>
          <is_current_version>true</is_current_version>
          <is_live>true</is_live>
          <language_code>sample string 1</language_code>
          <relative_url>sample string 10</relative_url>
          <short_version>sample string 4</short_version>
          <slug>sample string 6</slug>
          <tags />
          <title>sample string 2</title>
          <url>sample string 9</url>
          <user_id>sample string 8</user_id>
          <version_number>13</version_number>
        </Multilingual>
        <Multilingual>
          <body>sample string 5</body>
          <created_at>sample string 15</created_at>
          <description>sample string 3</description>
          <editor_type>sample string 14</editor_type>
          <is_current_version>true</is_current_version>
          <is_live>true</is_live>
          <language_code>sample string 1</language_code>
          <relative_url>sample string 10</relative_url>
          <short_version>sample string 4</short_version>
          <slug>sample string 6</slug>
          <tags />
          <title>sample string 2</title>
          <url>sample string 9</url>
          <user_id>sample string 8</user_id>
          <version_number>13</version_number>
        </Multilingual>
      </multilingual>
      <permission_groups />
      <relative_url>sample string 23</relative_url>
      <short_version>sample string 7</short_version>
      <short_version_was_autogenerated>true</short_version_was_autogenerated>
      <show_toc>true</show_toc>
      <slug>sample string 9</slug>
      <source>sample string 17</source>
      <stale_status>
        <expires_at>sample string 5</expires_at>
        <is_stale>true</is_stale>
        <reason>sample string 2</reason>
        <source>sample string 3</source>
        <triggered_at>sample string 4</triggered_at>
      </stale_status>
      <tags xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:anyType />
        <d4p1:anyType />
      </tags>
      <title>sample string 5</title>
      <updated_at>sample string 20</updated_at>
      <url>sample string 22</url>
      <user_id>sample string 3</user_id>
      <version_number>16</version_number>
    </Article>
    <Article>
      <account_id>sample string 2</account_id>
      <article_id>sample string 1</article_id>
      <author>
        <email>sample string 2</email>
        <name>sample string 1</name>
        <profile_image>sample string 3</profile_image>
      </author>
      <body>sample string 8</body>
      <category_id>sample string 4</category_id>
      <created_at>sample string 19</created_at>
      <description>sample string 6</description>
      <description_was_autogenerated>true</description_was_autogenerated>
      <editor_type>sample string 18</editor_type>
      <icon>sample string 10</icon>
      <is_current_version>true</is_current_version>
      <is_featured>true</is_featured>
      <is_private>true</is_private>
      <is_published>true</is_published>
      <multilingual>
        <Multilingual>
          <body>sample string 5</body>
          <created_at>sample string 15</created_at>
          <description>sample string 3</description>
          <editor_type>sample string 14</editor_type>
          <is_current_version>true</is_current_version>
          <is_live>true</is_live>
          <language_code>sample string 1</language_code>
          <relative_url>sample string 10</relative_url>
          <short_version>sample string 4</short_version>
          <slug>sample string 6</slug>
          <tags />
          <title>sample string 2</title>
          <url>sample string 9</url>
          <user_id>sample string 8</user_id>
          <version_number>13</version_number>
        </Multilingual>
        <Multilingual>
          <body>sample string 5</body>
          <created_at>sample string 15</created_at>
          <description>sample string 3</description>
          <editor_type>sample string 14</editor_type>
          <is_current_version>true</is_current_version>
          <is_live>true</is_live>
          <language_code>sample string 1</language_code>
          <relative_url>sample string 10</relative_url>
          <short_version>sample string 4</short_version>
          <slug>sample string 6</slug>
          <tags />
          <title>sample string 2</title>
          <url>sample string 9</url>
          <user_id>sample string 8</user_id>
          <version_number>13</version_number>
        </Multilingual>
      </multilingual>
      <permission_groups />
      <relative_url>sample string 23</relative_url>
      <short_version>sample string 7</short_version>
      <short_version_was_autogenerated>true</short_version_was_autogenerated>
      <show_toc>true</show_toc>
      <slug>sample string 9</slug>
      <source>sample string 17</source>
      <stale_status>
        <expires_at>sample string 5</expires_at>
        <is_stale>true</is_stale>
        <reason>sample string 2</reason>
        <source>sample string 3</source>
        <triggered_at>sample string 4</triggered_at>
      </stale_status>
      <tags xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:anyType />
        <d4p1:anyType />
      </tags>
      <title>sample string 5</title>
      <updated_at>sample string 20</updated_at>
      <url>sample string 22</url>
      <user_id>sample string 3</user_id>
      <version_number>16</version_number>
    </Article>
  </articles>
</ArticleResponse>