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 .csv suffix or ?format=csv

HTTP + CSV

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: text/csv
Content-Type: text/csv
Content-Length: length

{"UserProfileId":"00000000-0000-0000-0000-000000000000"}

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"UserProfileId":"00000000-0000-0000-0000-000000000000","ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}