PortfolioLinkApi

<back to all web services

AddUser

Requires Authentication
The following routes are available for this service:
All Verbs/user/management/create
AddUser Parameters:
NameParameterData TypeRequiredDescription
EmailquerystringNo
PhoneNumberquerystringNo
BlockedqueryboolNo
EmailVerifiedqueryboolNo
PhoneVerifiedqueryboolNo
GivenNamequerystringNo
FamilyNamequerystringNo
UserIdquerystringNo
ConnectionquerystringNo
PasswordquerystringNo
VerifyEmailqueryboolNo
UsernamequerystringNo
AddUserResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
SuccessformboolNo

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

<AddUser xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PortfolioLinkApi.ServiceModel">
  <Blocked>false</Blocked>
  <Connection>String</Connection>
  <Email>String</Email>
  <EmailVerified>false</EmailVerified>
  <FamilyName>String</FamilyName>
  <GivenName>String</GivenName>
  <Password>String</Password>
  <PhoneNumber>String</PhoneNumber>
  <PhoneVerified>false</PhoneVerified>
  <UserId>String</UserId>
  <Username>String</Username>
  <VerifyEmail>false</VerifyEmail>
</AddUser>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AddUserResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PortfolioLinkApi.ServiceModel">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Success>false</Success>
</AddUserResponse>