Needio.Services

<back to all web services

SendSocketMessageRequest

Requires Authentication
Required role:Approved
The following routes are available for this service:
All Verbs/Chat/SendSocketMessage/
SendSocketMessageRequest Parameters:
NameParameterData TypeRequiredDescription
chatMessagequeryChatMessageNo
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
startformDateTimeNo
DeviceUUIDformstringNo
APIKeyformstringNo
isAdminformboolNo
CmdformstringNo
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformboolNo
ResMessageformstringNo
ErrorformErrorNo
PageInfoformBasePageInfoNo
Error Parameters:
NameParameterData TypeRequiredDescription
ErrorYnformboolNo
ExYnformboolNo
ErrorCodeformstringNo
ErrorDescriptionformstringNo
BasePageInfo Parameters:
NameParameterData TypeRequiredDescription
TotalRecordCountformintNo
TotalPageCountformintNo
CurrentPageformintNo
ChatMessage Parameters:
NameParameterData TypeRequiredDescription
IdformObjectIdNo
ChatIdformObjectIdNo
SeqIdformintNo
SenderIdformintNo
StoreIdformint?No
BuyerIdformint?No
BuyerNameformstringNo
ReceiverIdformint?No
DateformDateTimeNo
TypeformMessageTypesNo
TextformstringNo
MediaformChatMediaNo
LocationformGeoLocationNo
Location2formGeoLocationNo
RefNoformstringNo
MessageTypes Enum:
NameValue
Text1
Media2
Location3
Basket4
PaymentRequest11
Payment12
Approve21
Review22
Auto101
Cargo102
ChatMedia Parameters:
NameParameterData TypeRequiredDescription
IdformObjectIdNo
MediaTypeformMediaTypesNo
FileNameformstringNo
SourceformstringNo
MediaMimeformstringNo
UrlformstringNo
MediaTypes Enum:
NameValue
icon0
Image1
Video2
Youtube3
Pdf8
File9
ThreeD10
Custom99
GeoLocation Parameters:
NameParameterData TypeRequiredDescription
LonformstringNo
LatformstringNo
GeoAddressformstringNo
IsDeletedformboolNo

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/SendSocketMessage/ HTTP/1.1 
Host: baseservices.needion.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	chatMessage: 
	{
		Id: 000000000000000000000000,
		ChatId: 000000000000000000000000,
		SeqId: 0,
		SenderId: 0,
		StoreId: 0,
		BuyerId: 0,
		BuyerName: String,
		ReceiverId: 0,
		Date: 0001-01-01,
		Type: 1,
		Text: String,
		Media: 
		{
			Id: 000000000000000000000000,
			MediaType: 0,
			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
	},
	start: 0001-01-01,
	DeviceUUID: String,
	APIKey: String,
	isAdmin: False,
	Cmd: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Result: False,
	ResMessage: String,
	Error: 
	{
		ErrorYn: False,
		ExYn: False,
		ErrorCode: String,
		ErrorDescription: String
	},
	PageInfo: 
	{
		TotalRecordCount: 0,
		TotalPageCount: 0,
		CurrentPage: 0
	}
}