GET api/Home/DealersToolBox?version={version}
Module : Home ; BE JIRA: NAXXXX ; FE JIRA: NAXXXX; Description: Gets the DealerToolBox for Home screen.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
version | boolean |
Required |
Body Parameters
None.
Response Information
Resource Description
DealerToolBoxEntityNewName | Description | Type | Additional information |
---|---|---|---|
title | string |
None. |
|
pageHeading | string |
None. |
|
ToolBoxItems | Collection of ToolBoxItems |
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", "ToolBoxItems": [ { "title": "sample string 1", "type": "sample string 2", "data": {} }, { "title": "sample string 1", "type": "sample string 2", "data": {} } ], "Message": "sample string 3", "WebApiIsSuccess": true, "WebApiResponseMessage": "sample string 5", "WebApiErrorCode": "sample string 6", "error_description": "sample string 7", "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:
<DealerToolBoxEntityNew 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 3</Message> <WebApiErrorCode>sample string 6</WebApiErrorCode> <WebApiIsSuccess>true</WebApiIsSuccess> <WebApiResponseMessage>sample string 5</WebApiResponseMessage> <error_description>sample string 7</error_description> <ToolBoxItems> <ToolBoxItems> <data /> <title>sample string 1</title> <type>sample string 2</type> </ToolBoxItems> <ToolBoxItems> <data /> <title>sample string 1</title> <type>sample string 2</type> </ToolBoxItems> </ToolBoxItems> <pageHeading>sample string 2</pageHeading> <title>sample string 1</title> </DealerToolBoxEntityNew>