Required role: | Approved |
All Verbs | /Ext/GetStoreChatMessages/ |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
StoreId | query | int | No | |
StartDate | query | DateTime | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
start | form | DateTime | No | |
DeviceUUID | form | string | No | |
APIKey | form | string | No | |
isAdmin | form | bool | No | |
Cmd | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Messages | form | List<ExternalOutMessage> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Result | form | bool | No | |
ResMessage | form | string | No | |
Error | form | Error | No | |
PageInfo | form | BasePageInfo | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ErrorYn | form | bool | No | |
ExYn | form | bool | No | |
ErrorCode | form | string | No | |
ErrorDescription | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
TotalRecordCount | form | int | No | |
TotalPageCount | form | int | No | |
CurrentPage | form | int | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
StoreId | form | int | No | |
SenderId | form | int | No | |
SenderName | form | string | No | |
Date | form | DateTime | No | |
MessageId | form | string | No | |
SeqId | form | int | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ChatId | form | string | No | |
Type | form | MessageTypes | No | |
Text | form | string | No | |
Media | form | ChatMedia | No | |
Location | form | GeoLocation | No | |
Location2 | form | GeoLocation | No | |
RefNo | form | string | No |
Name | Value |
---|---|
Text | 1 |
Media | 2 |
Location | 3 |
Basket | 4 |
PaymentRequest | 11 |
Payment | 12 |
Approve | 21 |
Review | 22 |
Auto | 101 |
Cargo | 102 |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | ObjectId | No | |
MediaType | form | MediaTypes | No | |
FileName | form | string | No | |
Source | form | string | No | |
MediaMime | form | string | No | |
Url | form | string | No |
Name | Value |
---|---|
icon | 0 |
Image | 1 |
Video | 2 |
Youtube | 3 |
8 | |
File | 9 |
ThreeD | 10 |
Custom | 99 |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Lon | form | string | No | |
Lat | form | string | No | |
GeoAddress | form | string | No | |
IsDeleted | form | bool | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Messages | form | List<ExternalOutMessage> | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /Ext/GetStoreChatMessages/ HTTP/1.1
Host: apiservices.needion.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
StoreId: 0,
StartDate: 0001-01-01,
start: 0001-01-01,
DeviceUUID: String,
APIKey: String,
isAdmin: False,
Cmd: String
}
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { Messages: [ { StoreId: 0, SenderId: 0, SenderName: String, Date: 0001-01-01, MessageId: String, SeqId: 0, ChatId: String, Type: Text, Text: String, Media: { Id: 000000000000000000000000, MediaType: icon, FileName: String, Source: String, MediaMime: String, Url: String }, Location: { Lon: String, Lat: String, GeoAddress: String, IsDeleted: False }, Location2: { Lon: String, Lat: String, GeoAddress: String, IsDeleted: False }, RefNo: String } ], Result: False, ResMessage: String, Error: { ErrorYn: False, ExYn: False, ErrorCode: String, ErrorDescription: String }, PageInfo: { TotalRecordCount: 0, TotalPageCount: 0, CurrentPage: 0 } }