PortfolioLinkApi

<back to all web services

GetUserApiKeys

Requires Authentication
The following routes are available for this service:
All Verbs/secret/userapikeys
GetUserApiKeysResponse Parameters:
NameParameterData TypeRequiredDescription
ResultsformList<ApiKey>No
ApiKey Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
UserAuthIdformstringNo
EnvironmentformstringNo
KeyTypeformstringNo
CreatedDateformDateTimeNo
ExpiryDateformDateTime?No
CancelledDateformDateTime?No
NotesformstringNo
RefIdformint?No
RefIdStrformstringNo
MetaformDictionary<string, string>No

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 /secret/userapikeys HTTP/1.1 
Host: api.portfoliolink.co.za 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetUserApiKeys 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

<GetUserApiKeysResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PortfolioLinkApi.ServiceModel">
  <Results xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ApiKey>
      <d2p1:CancelledDate>0001-01-01T00:00:00</d2p1:CancelledDate>
      <d2p1:CreatedDate>0001-01-01T00:00:00</d2p1:CreatedDate>
      <d2p1:Environment>String</d2p1:Environment>
      <d2p1:ExpiryDate>0001-01-01T00:00:00</d2p1:ExpiryDate>
      <d2p1:Id>String</d2p1:Id>
      <d2p1:KeyType>String</d2p1:KeyType>
      <d2p1:Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </d2p1:Meta>
      <d2p1:Notes>String</d2p1:Notes>
      <d2p1:RefId>0</d2p1:RefId>
      <d2p1:RefIdStr>String</d2p1:RefIdStr>
      <d2p1:UserAuthId>String</d2p1:UserAuthId>
    </d2p1:ApiKey>
  </Results>
</GetUserApiKeysResponse>