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}
import Foundation
import ServiceStack

/**
* Removes a Users Profile'
*/
// @Api(Description="Removes a Users Profile'")
public class RemoveUserProfile : Codable
{
    public var userProfileId:String

    required public init(){}
}

public class RemoveUserProfileResponse : Codable
{
    public var errors:[ResponseError]
    /**
    * Guid representing the object that is the User Profile Id in Eros.
    */
    // @ApiMember(DataType="Guid", Description="Guid representing the object that is the User Profile Id in Eros.", Name="UserProfileId", ParameterType="query")
    public var userProfileId:String

    /**
    * Service Stack Response Status.
    */
    // @ApiMember(DataType="ResponseStatus", Description="Service Stack Response Status.", Name="ResponseStatus", ParameterType="query")
    public var responseStatus:ResponseStatus

    required public init(){}
}


Swift 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"}}}