FxHubPartnersApi

<back to all web services

GetPartners

Requires Authentication
The following routes are available for this service:
GET/partners
GetPartnersResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformList<Partners>No
MessageformstringNo
Partners Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
PartnerNameformstringNo
RegNoformstringNo
FspNoformstringNo
LandobyteNameformstringNo
ShortNameformstringNo
IsSubAdvisorformstringNo
ParentPartnerformstringNo
AddressformstringNo
SuburbformstringNo
CityformstringNo
ProvinceformstringNo
PostalCodeformstringNo
PartnerContactNumberformstringNo
WebsiteUrlformstringNo
MainContactformstringNo
ContactEmailformstringNo
ContactMobileformstringNo
PartnerLogoUrlformstringNo

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 /partners 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,
			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
		}
	],
	message: String
}