GET api/v1/content/locations/{locationId}/dealerMessages
Retrieve the top 5 dealer messages
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
locationId |
Location ID |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
DealerMessageResult
DealerMessageResultName | Description | Type | Additional information |
---|---|---|---|
DealerMessageList | Collection of DealerMessageInfo |
None. |
|
ResultCode | integer |
None. |
|
ResultData | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "DealerMessageList": [ { "DisplayTypeID": 1, "AccountID": 2, "LocationID": 3, "Priority": 4, "MessageID": 5, "MessageType": 6, "Title": "sample string 7", "MessageData": "sample string 8", "ReceivedTime": "sample string 9", "ReadState": 10 }, { "DisplayTypeID": 1, "AccountID": 2, "LocationID": 3, "Priority": 4, "MessageID": 5, "MessageType": 6, "Title": "sample string 7", "MessageData": "sample string 8", "ReceivedTime": "sample string 9", "ReadState": 10 } ], "ResultCode": 1, "ResultData": "sample string 2" }
application/xml, text/xml
Sample:
<DealerMessageResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TC2API.Resource.Models.Models"> <ResultCode xmlns="http://schemas.datacontract.org/2004/07/TC2Utilities.RestApi">1</ResultCode> <ResultData xmlns="http://schemas.datacontract.org/2004/07/TC2Utilities.RestApi">sample string 2</ResultData> <DealerMessageList xmlns:d2p1="http://schemas.datacontract.org/2004/07/TC2Domain.Content"> <d2p1:DealerMessageInfo> <d2p1:AccountID>2</d2p1:AccountID> <d2p1:DisplayTypeID>1</d2p1:DisplayTypeID> <d2p1:LocationID>3</d2p1:LocationID> <d2p1:MessageData>sample string 8</d2p1:MessageData> <d2p1:MessageID>5</d2p1:MessageID> <d2p1:MessageType>6</d2p1:MessageType> <d2p1:Priority>4</d2p1:Priority> <d2p1:ReadState>10</d2p1:ReadState> <d2p1:ReceivedTime>sample string 9</d2p1:ReceivedTime> <d2p1:Title>sample string 7</d2p1:Title> </d2p1:DealerMessageInfo> <d2p1:DealerMessageInfo> <d2p1:AccountID>2</d2p1:AccountID> <d2p1:DisplayTypeID>1</d2p1:DisplayTypeID> <d2p1:LocationID>3</d2p1:LocationID> <d2p1:MessageData>sample string 8</d2p1:MessageData> <d2p1:MessageID>5</d2p1:MessageID> <d2p1:MessageType>6</d2p1:MessageType> <d2p1:Priority>4</d2p1:Priority> <d2p1:ReadState>10</d2p1:ReadState> <d2p1:ReceivedTime>sample string 9</d2p1:ReceivedTime> <d2p1:Title>sample string 7</d2p1:Title> </d2p1:DealerMessageInfo> </DealerMessageList> </DealerMessageResult>