FxHubPartnersApi

<back to all web services

EditPartner

Requires Authentication
The following routes are available for this service:
PUT/partners/edit
EditPartner Parameters:
NameParameterData TypeRequiredDescription
PartnersbodyPartnersNo
Partners Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
PartnerNameformstringNo
RegNoformstringNo
FspNoformstringNo
LandobyteNameformstringNo
ShortNameformstringNo
IsSubAdvisorformstringNo
ParentPartnerformstringNo
AddressformstringNo
SuburbformstringNo
CityformstringNo
ProvinceformstringNo
PostalCodeformstringNo
PartnerContactNumberformstringNo
WebsiteUrlformstringNo
MainContactformstringNo
ContactEmailformstringNo
ContactMobileformstringNo
PartnerLogoUrlformstringNo
EditPartnerResponse 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 /partners/edit HTTP/1.1 
Host: api.fxlink.co.za 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	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
	}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	result: False,
	message: String
}