PortfolioLinkApi

<back to all web services

GetPartnersM

Requires Authentication
Required role:Admin
The following routes are available for this service:
All Verbs/management/partners
GetPartnersResponseM Parameters:
NameParameterData TypeRequiredDescription
ResultformList<Partner>No
Partner Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
NameformstringNo
LogoUrlformstringNo
DescriptionformstringNo
InternalDescriptionformstringNo

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.

POST /management/partners HTTP/1.1 
Host: api.portfoliolink.co.za 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetPartnersM xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PortfolioLinkApi.ServiceModel" />
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetPartnersResponseM xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PortfolioLinkApi.ServiceModel">
  <Result xmlns:d2p1="http://schemas.datacontract.org/2004/07/SharedTypes">
    <d2p1:Partner>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:InternalDescription>String</d2p1:InternalDescription>
      <d2p1:LogoUrl>String</d2p1:LogoUrl>
      <d2p1:Name>String</d2p1:Name>
    </d2p1:Partner>
  </Result>
</GetPartnersResponseM>