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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<EditPartner xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FxHubPartnersApi.ServiceModel">
  <Partners xmlns:d2p1="http://schemas.datacontract.org/2004/07/FxHubPartnersApi.ServiceModel.Types">
    <d2p1:Address>String</d2p1:Address>
    <d2p1:City>String</d2p1:City>
    <d2p1:ContactEmail>String</d2p1:ContactEmail>
    <d2p1:ContactMobile>String</d2p1:ContactMobile>
    <d2p1:FspNo>String</d2p1:FspNo>
    <d2p1:Id>0</d2p1:Id>
    <d2p1:IsSubAdvisor>String</d2p1:IsSubAdvisor>
    <d2p1:LandobyteName>String</d2p1:LandobyteName>
    <d2p1:MainContact>String</d2p1:MainContact>
    <d2p1:ParentPartner>String</d2p1:ParentPartner>
    <d2p1:PartnerContactNumber>String</d2p1:PartnerContactNumber>
    <d2p1:PartnerLogoUrl>String</d2p1:PartnerLogoUrl>
    <d2p1:PartnerName>String</d2p1:PartnerName>
    <d2p1:PostalCode>String</d2p1:PostalCode>
    <d2p1:Province>String</d2p1:Province>
    <d2p1:RegNo>String</d2p1:RegNo>
    <d2p1:ShortName>String</d2p1:ShortName>
    <d2p1:Suburb>String</d2p1:Suburb>
    <d2p1:WebsiteUrl>String</d2p1:WebsiteUrl>
  </Partners>
</EditPartner>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<EditPartnerResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FxHubPartnersApi.ServiceModel">
  <Message>String</Message>
  <Result>false</Result>
</EditPartnerResponse>