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}
namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    ///<summary>
    ///Removes a Users Profile'
    ///</summary>
    [<Api(Description="Removes a Users Profile'")>]
    [<AllowNullLiteral>]
    type RemoveUserProfile() = 
        member val UserProfileId:Guid = new Guid() with get,set

    [<AllowNullLiteral>]
    type RemoveUserProfileResponse() = 
        member val Errors:ResizeArray<ResponseError> = null with get,set
        ///<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")>]
        member val UserProfileId:Guid = new Guid() with get,set

        ///<summary>
        ///Service Stack Response Status.
        ///</summary>
        [<ApiMember(DataType="ResponseStatus", Description="Service Stack Response Status.", Name="ResponseStatus", ParameterType="query")>]
        member val ResponseStatus:ResponseStatus = null with get,set

F# RemoveUserProfile DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
Content-Type: application/json
Content-Length: length

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

HTTP/1.1 200 OK
Content-Type: application/json
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"}}}