FxHubPartnersApi

<back to all web services

CreatePartner

Requires Authentication
The following routes are available for this service:
POST/partners
CreatePartner 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
CreatePartnerResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformboolNo
MessageformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /partners HTTP/1.1 
Host: api.fxlink.co.za 
Accept: application/json
Content-Type: application/json
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: application/json
Content-Length: length

{"result":false,"message":"String"}