Platform API

<back to all web services

RemoveUserProfile

Removes a Users Profile'

Requires Authentication
The following routes are available for this service:
PUT/api/profiles/remove/{UserProfileId}
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Eros.Subtle.Canvara.WebAPIModel.ServiceModel

Namespace Global

    Namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel

        '''<Summary>
        '''Removes a Users Profile'
        '''</Summary>
        <Api(Description:="Removes a Users Profile'")>
        Public Partial Class RemoveUserProfile
            Public Overridable Property UserProfileId As Guid
        End Class

        Public Partial Class RemoveUserProfileResponse
            Public Overridable Property Errors As List(Of ResponseError)
            '''<Summary>
            '''Guid representing the object that is the User Profile Id in Eros.
            '''</Summary>
            <ApiMember(DataType:="Guid", Description:="Guid representing the object that is the User Profile Id in Eros.", Name:="UserProfileId", ParameterType:="query")>
            Public Overridable Property UserProfileId As Guid

            '''<Summary>
            '''Service Stack Response Status.
            '''</Summary>
            <ApiMember(DataType:="ResponseStatus", Description:="Service Stack Response Status.", Name:="ResponseStatus", ParameterType:="query")>
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class
    End Namespace
End Namespace

VB.NET RemoveUserProfile DTOs

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.

PUT /api/profiles/remove/{UserProfileId} HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<RemoveUserProfile xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
  <UserProfileId>00000000-0000-0000-0000-000000000000</UserProfileId>
</RemoveUserProfile>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<RemoveUserProfileResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
  <Errors xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ResponseError>
      <d2p1:ErrorCode>String</d2p1:ErrorCode>
      <d2p1:FieldName>String</d2p1:FieldName>
      <d2p1:Message>String</d2p1:Message>
      <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:ResponseError>
  </Errors>
  <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>
  <UserProfileId>00000000-0000-0000-0000-000000000000</UserProfileId>
</RemoveUserProfileResponse>