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 'package:servicestack/servicestack.dart';

/**
* Removes a Users Profile'
*/
// @Api(Description="Removes a Users Profile'")
class RemoveUserProfile implements IConvertible
{
    String? UserProfileId;

    RemoveUserProfile({this.UserProfileId});
    RemoveUserProfile.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        UserProfileId = json['UserProfileId'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'UserProfileId': UserProfileId
    };

    getTypeName() => "RemoveUserProfile";
    TypeContext? context = _ctx;
}

class RemoveUserProfileResponse implements IConvertible
{
    List<ResponseError>? Errors;
    /**
    * 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")
    String? UserProfileId;

    /**
    * Service Stack Response Status.
    */
    // @ApiMember(DataType="ResponseStatus", Description="Service Stack Response Status.", Name="ResponseStatus", ParameterType="query")
    ResponseStatus? ResponseStatus;

    RemoveUserProfileResponse({this.Errors,this.UserProfileId,this.ResponseStatus});
    RemoveUserProfileResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Errors = JsonConverters.fromJson(json['Errors'],'List<ResponseError>',context!);
        UserProfileId = json['UserProfileId'];
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Errors': JsonConverters.toJson(Errors,'List<ResponseError>',context!),
        'UserProfileId': UserProfileId,
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
    };

    getTypeName() => "RemoveUserProfileResponse";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'pfapi.pstpf.com.au', types: <String, TypeInfo> {
    'RemoveUserProfile': TypeInfo(TypeOf.Class, create:() => RemoveUserProfile()),
    'RemoveUserProfileResponse': TypeInfo(TypeOf.Class, create:() => RemoveUserProfileResponse()),
});

Dart RemoveUserProfile DTOs

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

HTTP + JSV

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

{
	
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Errors: 
	[
		{
			ErrorCode: String,
			FieldName: String,
			Message: String,
			Meta: 
			{
				String: String
			}
		}
	],
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}