GET api/Home/GetTopCategory

Module : Home ; BE JIRA: NAXXXX ; FE JIRA: NAXXXX; Description: Gets the Top Category for Home screen.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

TopCategoryBusinessEntity

Name	Type	Additional information
CategoryEntity	Collection of BaseCategoryBusinessEntity	None.
Message	string	None.
WebApiIsSuccess	boolean	None.
WebApiResponseMessage	string	None.
WebApiErrorCode	string	None.
error_description	string	None.
CookieData	Collection of AppCookie	None.

Response Formats

application/json, text/json

Sample:

{
  "CategoryEntity": [
    {
      "Id": "sample string 1",
      "Title": "sample string 2",
      "Description": "sample string 3",
      "ImageUrl": "sample string 4",
      "DisplayOrder": 5,
      "UrlSegment": "sample string 6",
      "Action": "sample string 7",
      "Step": 8
    },
    {
      "Id": "sample string 1",
      "Title": "sample string 2",
      "Description": "sample string 3",
      "ImageUrl": "sample string 4",
      "DisplayOrder": 5,
      "UrlSegment": "sample string 6",
      "Action": "sample string 7",
      "Step": 8
    }
  ],
  "Message": "sample string 1",
  "WebApiIsSuccess": true,
  "WebApiResponseMessage": "sample string 3",
  "WebApiErrorCode": "sample string 4",
  "error_description": "sample string 5",
  "CookieData": [
    {
      "Name": "sample string 1",
      "Value": "sample string 2",
      "NameValue": "sample string 3",
      "ExpiryDateTime": "sample string 4"
    },
    {
      "Name": "sample string 1",
      "Value": "sample string 2",
      "NameValue": "sample string 3",
      "ExpiryDateTime": "sample string 4"
    }
  ]
}

application/xml, text/xml

Sample:

<TopCategoryBusinessEntity xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Adi.BusinessEntities">
  <CookieData>
    <AppCookie>
      <ExpiryDateTime>sample string 4</ExpiryDateTime>
      <Name>sample string 1</Name>
      <NameValue>sample string 3</NameValue>
      <Value>sample string 2</Value>
    </AppCookie>
    <AppCookie>
      <ExpiryDateTime>sample string 4</ExpiryDateTime>
      <Name>sample string 1</Name>
      <NameValue>sample string 3</NameValue>
      <Value>sample string 2</Value>
    </AppCookie>
  </CookieData>
  <Message>sample string 1</Message>
  <WebApiErrorCode>sample string 4</WebApiErrorCode>
  <WebApiIsSuccess>true</WebApiIsSuccess>
  <WebApiResponseMessage>sample string 3</WebApiResponseMessage>
  <error_description>sample string 5</error_description>
  <CategoryEntity>
    <BaseCategoryBusinessEntity>
      <Action>sample string 7</Action>
      <Description>sample string 3</Description>
      <DisplayOrder>5</DisplayOrder>
      <Id>sample string 1</Id>
      <ImageUrl>sample string 4</ImageUrl>
      <Step>8</Step>
      <Title>sample string 2</Title>
      <UrlSegment>sample string 6</UrlSegment>
    </BaseCategoryBusinessEntity>
    <BaseCategoryBusinessEntity>
      <Action>sample string 7</Action>
      <Description>sample string 3</Description>
      <DisplayOrder>5</DisplayOrder>
      <Id>sample string 1</Id>
      <ImageUrl>sample string 4</ImageUrl>
      <Step>8</Step>
      <Title>sample string 2</Title>
      <UrlSegment>sample string 6</UrlSegment>
    </BaseCategoryBusinessEntity>
  </CategoryEntity>
</TopCategoryBusinessEntity>