FxHubPartnersApi

<back to all web services

GetAllQueries

Requires Authentication
The following routes are available for this service:
GET/query/all
GetAllQueriesResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformList<Query>No
MessageformstringNo
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

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.

GET /query/all HTTP/1.1 
Host: api.fxlink.co.za 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	result: 
	[
		{
			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
				}
			]
		}
	],
	message: String
}