GET api/V1/Home?customerId={customerId}&langCode={langCode}&branchId={branchId}&shippingId={shippingId}

Request Information

URI Parameters

Name	Type	Additional information
customerId	integer	Required
langCode	string	Required
branchId	integer	Required
shippingId	integer	Required

Body Parameters

None.

Response Information

Resource Description

HomeVM

Name	Type	Additional information
IsUserWallet	boolean	None.
isShow	boolean	None.
slider	Collection of string	None.
categories	Collection of CategoryVM	None.
ProductOffers	Collection of ProductVM	None.

Response Formats

application/json, text/json

Sample:

{
  "IsUserWallet": true,
  "isShow": true,
  "slider": [
    "sample string 1",
    "sample string 2"
  ],
  "categories": [
    {
      "id": 1,
      "Name": "sample string 2",
      "Image": "sample string 3",
      "ParentId": 1,
      "isCodeRelated": true,
      "isActive": true,
      "ProductCount": 6,
      "TalPageNumber": 7
    },
    {
      "id": 1,
      "Name": "sample string 2",
      "Image": "sample string 3",
      "ParentId": 1,
      "isCodeRelated": true,
      "isActive": true,
      "ProductCount": 6,
      "TalPageNumber": 7
    }
  ],
  "ProductOffers": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "Description": "sample string 3",
      "Image": "sample string 4",
      "Price": 5.0,
      "Discount": 6,
      "IsFavorite": true,
      "Note": "sample string 8",
      "TalPageNumber": 9,
      "Options": [
        {
          "Id": 1,
          "GroupId": 2,
          "GroupName": "sample string 3",
          "Name": "sample string 4",
          "Price": 5.0,
          "Quantity": 6,
          "Total": 7.0
        },
        {
          "Id": 1,
          "GroupId": 2,
          "GroupName": "sample string 3",
          "Name": "sample string 4",
          "Price": 5.0,
          "Quantity": 6,
          "Total": 7.0
        }
      ],
      "Additions": [
        {
          "Id": 1,
          "Name": "sample string 2",
          "Price": 3.0
        },
        {
          "Id": 1,
          "Name": "sample string 2",
          "Price": 3.0
        }
      ]
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "Description": "sample string 3",
      "Image": "sample string 4",
      "Price": 5.0,
      "Discount": 6,
      "IsFavorite": true,
      "Note": "sample string 8",
      "TalPageNumber": 9,
      "Options": [
        {
          "Id": 1,
          "GroupId": 2,
          "GroupName": "sample string 3",
          "Name": "sample string 4",
          "Price": 5.0,
          "Quantity": 6,
          "Total": 7.0
        },
        {
          "Id": 1,
          "GroupId": 2,
          "GroupName": "sample string 3",
          "Name": "sample string 4",
          "Price": 5.0,
          "Quantity": 6,
          "Total": 7.0
        }
      ],
      "Additions": [
        {
          "Id": 1,
          "Name": "sample string 2",
          "Price": 3.0
        },
        {
          "Id": 1,
          "Name": "sample string 2",
          "Price": 3.0
        }
      ]
    }
  ]
}

multipart/form-data

Sample:

{"IsUserWallet":true,"isShow":true,"slider":["sample string 1","sample string 2"],"categories":[{"id":1,"Name":"sample string 2","Image":"sample string 3","ParentId":1,"isCodeRelated":true,"isActive":true,"ProductCount":6,"TalPageNumber":7},{"id":1,"Name":"sample string 2","Image":"sample string 3","ParentId":1,"isCodeRelated":true,"isActive":true,"ProductCount":6,"TalPageNumber":7}],"ProductOffers":[{"Id":1,"Name":"sample string 2","Description":"sample string 3","Image":"sample string 4","Price":5.0,"Discount":6,"IsFavorite":true,"Note":"sample string 8","TalPageNumber":9,"Options":[{"Id":1,"GroupId":2,"GroupName":"sample string 3","Name":"sample string 4","Price":5.0,"Quantity":6,"Total":7.0},{"Id":1,"GroupId":2,"GroupName":"sample string 3","Name":"sample string 4","Price":5.0,"Quantity":6,"Total":7.0}],"Additions":[{"Id":1,"Name":"sample string 2","Price":3.0},{"Id":1,"Name":"sample string 2","Price":3.0}]},{"Id":1,"Name":"sample string 2","Description":"sample string 3","Image":"sample string 4","Price":5.0,"Discount":6,"IsFavorite":true,"Note":"sample string 8","TalPageNumber":9,"Options":[{"Id":1,"GroupId":2,"GroupName":"sample string 3","Name":"sample string 4","Price":5.0,"Quantity":6,"Total":7.0},{"Id":1,"GroupId":2,"GroupName":"sample string 3","Name":"sample string 4","Price":5.0,"Quantity":6,"Total":7.0}],"Additions":[{"Id":1,"Name":"sample string 2","Price":3.0},{"Id":1,"Name":"sample string 2","Price":3.0}]}]}

application/xml, text/xml

Sample:

<HomeVM xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebAPI.ViewModel">
  <IsUserWallet>true</IsUserWallet>
  <ProductOffers>
    <ProductVM>
      <Additions>
        <AdditionVM>
          <Id>1</Id>
          <Name>sample string 2</Name>
          <Price>3</Price>
        </AdditionVM>
        <AdditionVM>
          <Id>1</Id>
          <Name>sample string 2</Name>
          <Price>3</Price>
        </AdditionVM>
      </Additions>
      <Description>sample string 3</Description>
      <Discount>6</Discount>
      <Id>1</Id>
      <Image>sample string 4</Image>
      <IsFavorite>true</IsFavorite>
      <Name>sample string 2</Name>
      <Note>sample string 8</Note>
      <Options>
        <OptionVM>
          <GroupId>2</GroupId>
          <GroupName>sample string 3</GroupName>
          <Id>1</Id>
          <Name>sample string 4</Name>
          <Price>5</Price>
          <Quantity>6</Quantity>
          <Total>7</Total>
        </OptionVM>
        <OptionVM>
          <GroupId>2</GroupId>
          <GroupName>sample string 3</GroupName>
          <Id>1</Id>
          <Name>sample string 4</Name>
          <Price>5</Price>
          <Quantity>6</Quantity>
          <Total>7</Total>
        </OptionVM>
      </Options>
      <Price>5</Price>
      <TalPageNumber>9</TalPageNumber>
    </ProductVM>
    <ProductVM>
      <Additions>
        <AdditionVM>
          <Id>1</Id>
          <Name>sample string 2</Name>
          <Price>3</Price>
        </AdditionVM>
        <AdditionVM>
          <Id>1</Id>
          <Name>sample string 2</Name>
          <Price>3</Price>
        </AdditionVM>
      </Additions>
      <Description>sample string 3</Description>
      <Discount>6</Discount>
      <Id>1</Id>
      <Image>sample string 4</Image>
      <IsFavorite>true</IsFavorite>
      <Name>sample string 2</Name>
      <Note>sample string 8</Note>
      <Options>
        <OptionVM>
          <GroupId>2</GroupId>
          <GroupName>sample string 3</GroupName>
          <Id>1</Id>
          <Name>sample string 4</Name>
          <Price>5</Price>
          <Quantity>6</Quantity>
          <Total>7</Total>
        </OptionVM>
        <OptionVM>
          <GroupId>2</GroupId>
          <GroupName>sample string 3</GroupName>
          <Id>1</Id>
          <Name>sample string 4</Name>
          <Price>5</Price>
          <Quantity>6</Quantity>
          <Total>7</Total>
        </OptionVM>
      </Options>
      <Price>5</Price>
      <TalPageNumber>9</TalPageNumber>
    </ProductVM>
  </ProductOffers>
  <categories>
    <CategoryVM>
      <Image>sample string 3</Image>
      <Name>sample string 2</Name>
      <ParentId>1</ParentId>
      <ProductCount>6</ProductCount>
      <TalPageNumber>7</TalPageNumber>
      <id>1</id>
      <isActive>true</isActive>
      <isCodeRelated>true</isCodeRelated>
    </CategoryVM>
    <CategoryVM>
      <Image>sample string 3</Image>
      <Name>sample string 2</Name>
      <ParentId>1</ParentId>
      <ProductCount>6</ProductCount>
      <TalPageNumber>7</TalPageNumber>
      <id>1</id>
      <isActive>true</isActive>
      <isCodeRelated>true</isCodeRelated>
    </CategoryVM>
  </categories>
  <isShow>true</isShow>
  <slider xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </slider>
</HomeVM>