PortfolioLinkApi

<back to all web services

DeleteUser

Requires Authentication
Required permission:manageUsers
The following routes are available for this service:
POST/users/delete
DeleteUser Parameters:
NameParameterData TypeRequiredDescription
EmailbodystringNo
DeleteUserResponse Parameters:
NameParameterData TypeRequiredDescription
SuccessformboolNo
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.

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

<DeleteUser xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PortfolioLinkApi.ServiceModel">
  <Email>String</Email>
</DeleteUser>

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

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