Needio.Services

<back to all web services

GetChatListRequest

Requires Authentication
The following routes are available for this service:
All Verbs/Chat/GetChatList/
GetChatListRequest Parameters:
NameParameterData TypeRequiredDescription
includeSaleChatsqueryboolNo
includeP2PChatsqueryboolNo
SelectedSessionIdquerystringNo
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
startformDateTimeNo
GetChatListResponse Parameters:
NameParameterData TypeRequiredDescription
ChatsformList<ChatSession>No
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformboolNo
ResMessageformstringNo
ErrorformErrorNo
Error Parameters:
NameParameterData TypeRequiredDescription
ErrorYnformboolNo
ErrorCodeformstringNo
ErrorDescriptionformstringNo
ChatSession Parameters:
NameParameterData TypeRequiredDescription
IdformObjectIdNo
StoreIdformint?No
StoreMediaIdformint?No
MediaFileNameformstringNo
SalerIdformint?No
BuyerIdformint?No
SalerDescformstringNo
BuyerDescformstringNo
StartDateformDateTimeNo
LastMessageDateformDateTimeNo
LastSeqIdformintNo
CpSeqIdformintNo
MessageCountformintNo
StatusformChatStatusesNo
ChatTypeformChatTypesNo
UsersformList<ChatUser>No
LastMessageformstringNo
BGColorformstringNo
BasketIdformintNo
ChatStatuses Enum:
NameValue
Active1
WaitForSalerAction2
WaitForBuyerAction3
WaitForAdminAction4
WaitForRateAction5
WaitForShipAction6
Completed10
Archived11
Deleted99
ChatTypes Enum:
NameValue
Sale1
P2P2
ChatUser Parameters:
NameParameterData TypeRequiredDescription
UserIdformintNo
UserNameformstringNo
AvatarformstringNo
LastReadSeqIdformintNo
ActiveYnformintNo
GetChatListResponse Parameters:
NameParameterData TypeRequiredDescription
ChatsformList<ChatSession>No

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /Chat/GetChatList/ HTTP/1.1 
Host: baseservices2.needion.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	includeSaleChats: False,
	includeP2PChats: False,
	SelectedSessionId: String,
	start: 2020-07-09T08:40:35.3281768+03:00
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Chats: 
	[
		{
			Id: 000000000000000000000000,
			StoreId: 0,
			StoreMediaId: 0,
			MediaFileName: String,
			SalerId: 0,
			BuyerId: 0,
			SalerDesc: String,
			BuyerDesc: String,
			StartDate: 0001-01-01,
			LastMessageDate: 0001-01-01,
			LastSeqId: 0,
			CpSeqId: 0,
			MessageCount: 0,
			Status: 1,
			ChatType: 1,
			Users: 
			[
				{
					UserId: 0,
					UserName: String,
					Avatar: String,
					LastReadSeqId: 0,
					ActiveYn: 0
				}
			],
			LastMessage: String,
			BGColor: String,
			BasketId: 0
		}
	],
	Result: False,
	ResMessage: String,
	Error: 
	{
		ErrorYn: False,
		ErrorCode: String,
		ErrorDescription: String
	}
}