GET api/Home/DealersToolBox

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

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

DealerToolBoxBaseEntity

Name	Type	Additional information
title	string	None.
pageHeading	string	None.
pageDescription	string	None.
imageurl	string	None.
ToolBoxItems	Collection of DealerToolBoxEntity	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:

{
  "title": "sample string 1",
  "pageHeading": "sample string 2",
  "pageDescription": "sample string 3",
  "imageurl": "sample string 4",
  "ToolBoxItems": [
    {
      "title": "sample string 1",
      "type": "sample string 2",
      "displayOrder": 3,
      "imageURL": "sample string 4",
      "name": "sample string 5",
      "pdfPath": "sample string 6",
      "data": {}
    },
    {
      "title": "sample string 1",
      "type": "sample string 2",
      "displayOrder": 3,
      "imageURL": "sample string 4",
      "name": "sample string 5",
      "pdfPath": "sample string 6",
      "data": {}
    }
  ],
  "Message": "sample string 5",
  "WebApiIsSuccess": true,
  "WebApiResponseMessage": "sample string 7",
  "WebApiErrorCode": "sample string 8",
  "error_description": "sample string 9",
  "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:

<DealerToolBoxBaseEntity 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 5</Message>
  <WebApiErrorCode>sample string 8</WebApiErrorCode>
  <WebApiIsSuccess>true</WebApiIsSuccess>
  <WebApiResponseMessage>sample string 7</WebApiResponseMessage>
  <error_description>sample string 9</error_description>
  <ToolBoxItems>
    <DealerToolBoxEntity>
      <data />
      <displayOrder>3</displayOrder>
      <imageURL>sample string 4</imageURL>
      <name>sample string 5</name>
      <pdfPath>sample string 6</pdfPath>
      <title>sample string 1</title>
      <type>sample string 2</type>
    </DealerToolBoxEntity>
    <DealerToolBoxEntity>
      <data />
      <displayOrder>3</displayOrder>
      <imageURL>sample string 4</imageURL>
      <name>sample string 5</name>
      <pdfPath>sample string 6</pdfPath>
      <title>sample string 1</title>
      <type>sample string 2</type>
    </DealerToolBoxEntity>
  </ToolBoxItems>
  <imageurl>sample string 4</imageurl>
  <pageDescription>sample string 3</pageDescription>
  <pageHeading>sample string 2</pageHeading>
  <title>sample string 1</title>
</DealerToolBoxBaseEntity>