GET Homepage/gethomepage?CompanyID={CompanyID}&CounterUpdate={CounterUpdate}

Request Information

URI Parameters

Name	Description	Type	Additional information
CompanyID		integer	Required
CounterUpdate		string	Required

Body Parameters

None.

Response Information

Resource Description

HomePage

Name	Type	Additional information
ID	decimal number	None.
CompanyID	decimal number	None.
HeaderText	string	None.
FooterText	string	None.
BGColor	string	None.
ImageData	string	None.
FooterBGColor	string	None.
ImageBGColor	string	None.
HeaderBackImage	string	None.
hitCounter	decimal number	None.
hitMessage	string	None.
hitBackColor	string	None.
hitForColor	string	None.
hitFontSize	string	None.
HitFontName	string	None.
MenuBackImage	string	None.
BulletinHeaderImage	string	None.
BulletinHeaderFontColor	string	None.
BulletinBodyImage	string	None.
BulletinBodyBackColor	string	None.
FooterImage	string	None.
PageBackImage	string	None.
stretchHeader	string	None.
stretchBulletinBody	string	None.
stretchBody	string	None.
mMenu_Sep_Image	string	None.
sMenu_Sep_Image	string	None.
LoginHeaderBackImage	string	None.
LoginHeaderBackColor	string	None.
LoginBackImage	string	None.
LoginBackColor	string	None.
bmMenu_Sep_Image	string	None.
bsMenu_Sep_Image	string	None.
fabicon	string	None.
BodyBackGroundColor	string	None.
BodyBackGroundImage	string	None.
Is_locationenable	integer	None.
Is_applicable_App	integer	None.
Is_hitcountervisible	integer	None.
Is_gst_enable	integer	None.
TimeSheetHeaderText	string	None.
merchantkey	string	None.
Is_blog_enable	integer	None.
is_Chat_enable	integer	None.
ClientID	string	None.
clientsecret	string	None.
FClientID	string	None.
FClientSecret	string	None.
OAuth	integer	None.
isdefaultchatenable	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "ID": 1.0,
  "CompanyID": 2.0,
  "HeaderText": "sample string 3",
  "FooterText": "sample string 4",
  "BGColor": "sample string 5",
  "ImageData": "sample string 6",
  "FooterBGColor": "sample string 7",
  "ImageBGColor": "sample string 8",
  "HeaderBackImage": "sample string 9",
  "hitCounter": 10.0,
  "hitMessage": "sample string 11",
  "hitBackColor": "sample string 12",
  "hitForColor": "sample string 13",
  "hitFontSize": "sample string 14",
  "HitFontName": "sample string 15",
  "MenuBackImage": "sample string 16",
  "BulletinHeaderImage": "sample string 17",
  "BulletinHeaderFontColor": "sample string 18",
  "BulletinBodyImage": "sample string 19",
  "BulletinBodyBackColor": "sample string 20",
  "FooterImage": "sample string 21",
  "PageBackImage": "sample string 22",
  "stretchHeader": "sample string 23",
  "stretchBulletinBody": "sample string 24",
  "stretchBody": "sample string 25",
  "mMenu_Sep_Image": "sample string 26",
  "sMenu_Sep_Image": "sample string 27",
  "LoginHeaderBackImage": "sample string 28",
  "LoginHeaderBackColor": "sample string 29",
  "LoginBackImage": "sample string 30",
  "LoginBackColor": "sample string 31",
  "bmMenu_Sep_Image": "sample string 32",
  "bsMenu_Sep_Image": "sample string 33",
  "fabicon": "sample string 34",
  "BodyBackGroundColor": "sample string 35",
  "BodyBackGroundImage": "sample string 36",
  "Is_locationenable": 37,
  "Is_applicable_App": 38,
  "Is_hitcountervisible": 39,
  "Is_gst_enable": 40,
  "TimeSheetHeaderText": "sample string 41",
  "merchantkey": "sample string 42",
  "Is_blog_enable": 43,
  "is_Chat_enable": 44,
  "ClientID": "sample string 45",
  "clientsecret": "sample string 46",
  "FClientID": "sample string 47",
  "FClientSecret": "sample string 48",
  "OAuth": 49,
  "isdefaultchatenable": 50
}

application/xml, text/xml

Sample:

<HomePage xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/virtualofficeapi.Models">
  <BGColor>sample string 5</BGColor>
  <BodyBackGroundColor>sample string 35</BodyBackGroundColor>
  <BodyBackGroundImage>sample string 36</BodyBackGroundImage>
  <BulletinBodyBackColor>sample string 20</BulletinBodyBackColor>
  <BulletinBodyImage>sample string 19</BulletinBodyImage>
  <BulletinHeaderFontColor>sample string 18</BulletinHeaderFontColor>
  <BulletinHeaderImage>sample string 17</BulletinHeaderImage>
  <ClientID>sample string 45</ClientID>
  <CompanyID>2</CompanyID>
  <FClientID>sample string 47</FClientID>
  <FClientSecret>sample string 48</FClientSecret>
  <FooterBGColor>sample string 7</FooterBGColor>
  <FooterImage>sample string 21</FooterImage>
  <FooterText>sample string 4</FooterText>
  <HeaderBackImage>sample string 9</HeaderBackImage>
  <HeaderText>sample string 3</HeaderText>
  <HitFontName>sample string 15</HitFontName>
  <ID>1</ID>
  <ImageBGColor>sample string 8</ImageBGColor>
  <ImageData>sample string 6</ImageData>
  <Is_applicable_App>38</Is_applicable_App>
  <Is_blog_enable>43</Is_blog_enable>
  <Is_gst_enable>40</Is_gst_enable>
  <Is_hitcountervisible>39</Is_hitcountervisible>
  <Is_locationenable>37</Is_locationenable>
  <LoginBackColor>sample string 31</LoginBackColor>
  <LoginBackImage>sample string 30</LoginBackImage>
  <LoginHeaderBackColor>sample string 29</LoginHeaderBackColor>
  <LoginHeaderBackImage>sample string 28</LoginHeaderBackImage>
  <MenuBackImage>sample string 16</MenuBackImage>
  <OAuth>49</OAuth>
  <PageBackImage>sample string 22</PageBackImage>
  <TimeSheetHeaderText>sample string 41</TimeSheetHeaderText>
  <bmMenu_Sep_Image>sample string 32</bmMenu_Sep_Image>
  <bsMenu_Sep_Image>sample string 33</bsMenu_Sep_Image>
  <clientsecret>sample string 46</clientsecret>
  <fabicon>sample string 34</fabicon>
  <hitBackColor>sample string 12</hitBackColor>
  <hitCounter>10</hitCounter>
  <hitFontSize>sample string 14</hitFontSize>
  <hitForColor>sample string 13</hitForColor>
  <hitMessage>sample string 11</hitMessage>
  <is_Chat_enable>44</is_Chat_enable>
  <isdefaultchatenable>50</isdefaultchatenable>
  <mMenu_Sep_Image>sample string 26</mMenu_Sep_Image>
  <merchantkey>sample string 42</merchantkey>
  <sMenu_Sep_Image>sample string 27</sMenu_Sep_Image>
  <stretchBody>sample string 25</stretchBody>
  <stretchBulletinBody>sample string 24</stretchBulletinBody>
  <stretchHeader>sample string 23</stretchHeader>
</HomePage>