FxHubPartnersApi

<back to all web services

CompleteQueryChat

Requires Authentication
The following routes are available for this service:
PUT/query/chat_complete
CompleteQueryChat Parameters:
NameParameterData TypeRequiredDescription
QuerybodyQueryNo
Query Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
UserIdformintNo
UserNameformstringNo
AdminIdformintNo
AdminNameformstringNo
PartnerNameformstringNo
PartnerIdformintNo
QueryCategoryformstringNo
QuerySentTimeformDateTime?No
InitialSendTimeformstringNo
MostRecentUpdatedTimeformstringNo
HasBeenAnsweredformbool?No
QueryStatusformstringNo
QueryMessagesformList<QueryMessage>No
QueryMessage Parameters:
NameParameterData TypeRequiredDescription
MessageformstringNo
SentByformstringNo
UpdatedAtformstringNo
CompleteQueryChatResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformboolNo
MessageformstringNo

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.

PUT /query/chat_complete HTTP/1.1 
Host: api.fxhub.co.za 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	query: 
	{
		id: 0,
		userId: 0,
		userName: String,
		adminId: 0,
		adminName: String,
		partnerName: String,
		partnerId: 0,
		queryCategory: String,
		querySentTime: 0001-01-01,
		initialSendTime: String,
		mostRecentUpdatedTime: String,
		hasBeenAnswered: False,
		queryStatus: String,
		queryMessages: 
		[
			{
				message: String,
				sentBy: String,
				updatedAt: String
			}
		]
	}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	result: False,
	message: String
}