FxHubPartnersApi

<back to all web services

CreateQuery

Requires Authentication
The following routes are available for this service:
POST/query/create
CreateQuery Parameters:
NameParameterData TypeRequiredDescription
QuerybodyQueryNo
PartnersbodyPartnersNo
QueryMessagesbodyQueryMessageNo
CurrentDateTimebodystringNo
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
Partners Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
PartnerNameformstringNo
RegNoformstringNo
FspNoformstringNo
LandobyteNameformstringNo
ShortNameformstringNo
IsSubAdvisorformstringNo
ParentPartnerformstringNo
AddressformstringNo
SuburbformstringNo
CityformstringNo
ProvinceformstringNo
PostalCodeformstringNo
PartnerContactNumberformstringNo
WebsiteUrlformstringNo
MainContactformstringNo
ContactEmailformstringNo
ContactMobileformstringNo
PartnerLogoUrlformstringNo
CreateQueryResponse 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.

POST /query/create HTTP/1.1 
Host: api.fxlink.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
			}
		]
	},
	partners: 
	{
		id: 0,
		partnerName: String,
		regNo: String,
		fspNo: String,
		landobyteName: String,
		shortName: String,
		isSubAdvisor: String,
		parentPartner: String,
		address: String,
		suburb: String,
		city: String,
		province: String,
		postalCode: String,
		partnerContactNumber: String,
		websiteUrl: String,
		mainContact: String,
		contactEmail: String,
		contactMobile: String,
		partnerLogoUrl: String
	},
	queryMessages: 
	{
		message: String,
		sentBy: String,
		updatedAt: String
	},
	currentDateTime: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	result: False,
	message: String
}