PortfolioLinkApi

GetClientDocuments

The following routes are available for this service:
All Verbs	/clients/documents

**GetClientDocuments** Parameters:
Name	Parameter	Data Type	Required	Description
ClientId	query	int	No

**GetClientDocumentsResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Result	form	List<ClientDocument>	No

**ClientDocument** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
ClientId	form	int	No
ClientGoalResultsId	form	int?	No
Title	form	string	No
Subject	form	string	No
Message	form	string	No
Files	form	List<FileContainer>	No
Signatures	form	List<Signature>	No
CcEmailAddresses	form	List<string>	No
BatchId	form	int	No
Status	form	string	No
CreatedAsAt	form	DateTime	No
UpdatedAsAt	form	DateTime	No
Birthday	form	DateTime	No
ExternalSignatureRequestId	form	string	No
ExternalSignatureType	form	string	No

**FileContainer** Parameters:
Name	Parameter	Data Type	Required	Description
Filename	form	string	No
Path	form	string	No

**Signature** Parameters:
Name	Parameter	Data Type	Required	Description
Name	form	string	No
Email	form	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 /clients/documents HTTP/1.1 
Host: api.portfoliolink.co.za 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetClientDocuments xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PortfolioLinkApi.ServiceModel">
  <ClientId>0</ClientId>
</GetClientDocuments>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetClientDocumentsResponse 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:ClientDocument>
      <d2p1:BatchId>0</d2p1:BatchId>
      <d2p1:Birthday>0001-01-01T00:00:00</d2p1:Birthday>
      <d2p1:CcEmailAddresses xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </d2p1:CcEmailAddresses>
      <d2p1:ClientGoalResultsId>0</d2p1:ClientGoalResultsId>
      <d2p1:ClientId>0</d2p1:ClientId>
      <d2p1:CreatedAsAt>0001-01-01T00:00:00</d2p1:CreatedAsAt>
      <d2p1:ExternalSignatureRequestId>String</d2p1:ExternalSignatureRequestId>
      <d2p1:ExternalSignatureType>String</d2p1:ExternalSignatureType>
      <d2p1:Files>
        <d2p1:FileContainer>
          <d2p1:Filename>String</d2p1:Filename>
          <d2p1:Path>String</d2p1:Path>
        </d2p1:FileContainer>
      </d2p1:Files>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:Message>String</d2p1:Message>
      <d2p1:Signatures>
        <d2p1:Signature>
          <d2p1:Email>String</d2p1:Email>
          <d2p1:Name>String</d2p1:Name>
        </d2p1:Signature>
      </d2p1:Signatures>
      <d2p1:Status>String</d2p1:Status>
      <d2p1:Subject>String</d2p1:Subject>
      <d2p1:Title>String</d2p1:Title>
      <d2p1:UpdatedAsAt>0001-01-01T00:00:00</d2p1:UpdatedAsAt>
    </d2p1:ClientDocument>
  </Result>
</GetClientDocumentsResponse>