Platform API

<back to all web services

DeleteContactRoleGroup

Deletes a Role Group record.

Requires Authentication
The following routes are available for this service:
PUT/api/contactrolegroup/{ContactRoleGroupId}/delete
import 'package:servicestack/servicestack.dart';

/**
* Deletes a Role Group record.
*/
// @Api(Description="Deletes a Role Group record.")
class DeleteContactRoleGroup implements IConvertible
{
    /**
    * Guid of the Contact Role Group record to be Deleted.
    */
    // @ApiMember(DataType="Guid", Description="Guid of the Contact Role Group record to be Deleted.", IsRequired=true, Name="ContactRoleGroupId", ParameterType="query")
    String? ContactRoleGroupId;

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

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

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

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

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

Dart DeleteContactRoleGroup 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/contactrolegroup/{ContactRoleGroupId}/delete HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"ContactRoleGroupId":"00000000-0000-0000-0000-000000000000"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

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